Skip to content

Commit 68f0b38

Browse files
authored
docs: clarify namespace configuration for custom namespaces (#536)
* docs: clarify namespace configuration in helm chart README Add a note to the Usage section explaining that `namespace.name` must be set in values.yaml when deploying to a custom namespace. The Helm `--namespace` flag alone does not control where chart resources are created, since all templates use `{{ .Values.namespace.name }}` instead of `{{ .Release.Namespace }}`. This addresses a recurring source of confusion for customers deploying to namespaces other than the default `fiftyone-teams`. * docs: add auto-generated README.md from gotmpl template Pre-commit helm-docs hook output for the namespace configuration note.
1 parent 2fe69c4 commit 68f0b38

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

helm/fiftyone-teams-app/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,21 @@ helm repo update voxel51
316316

317317
Finally, edit your `values.yaml` file and install FiftyOne Enterprise:
318318

319+
> **NOTE**: This chart uses `namespace.name` from your `values.yaml` to set the
320+
> namespace for all chart resources. The Helm `--namespace` flag alone does
321+
> **not** control where resources are created. You **must** set `namespace.name`
322+
> in your `values.yaml` to match your target namespace. If deploying to a
323+
> namespace other than the default `fiftyone-teams`, add the following to your
324+
> `values.yaml`:
325+
>
326+
> ```yaml
327+
> namespace:
328+
> # Set to true to have the chart create the namespace, or false if it
329+
> # already exists
330+
> create: false
331+
> name: your-namespace-here
332+
> ```
333+
319334
```shell
320335
helm install fiftyone-teams-app voxel51/fiftyone-teams-app \
321336
--namespace your-namespace-here \

helm/fiftyone-teams-app/README.md.gotmpl

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,21 @@ helm repo update voxel51
316316

317317
Finally, edit your `values.yaml` file and install FiftyOne Enterprise:
318318

319+
> **NOTE**: This chart uses `namespace.name` from your `values.yaml` to set the
320+
> namespace for all chart resources. The Helm `--namespace` flag alone does
321+
> **not** control where resources are created. You **must** set `namespace.name`
322+
> in your `values.yaml` to match your target namespace. If deploying to a
323+
> namespace other than the default `fiftyone-teams`, add the following to your
324+
> `values.yaml`:
325+
>
326+
> ```yaml
327+
> namespace:
328+
> # Set to true to have the chart create the namespace, or false if it
329+
> # already exists
330+
> create: false
331+
> name: your-namespace-here
332+
> ```
333+
319334
```shell
320335
helm install fiftyone-teams-app voxel51/fiftyone-teams-app \
321336
--namespace your-namespace-here \

0 commit comments

Comments
 (0)