Skip to content

Commit a24e86e

Browse files
committed
chore(release): Update README on helm.fiftyone.ai with contents from helm directory
1 parent 1db4d38 commit a24e86e

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# fiftyone-teams-app
1616

1717
<!-- markdownlint-disable line-length -->
18-
![Version: 2.16.4](https://img.shields.io/badge/Version-2.16.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.16.4](https://img.shields.io/badge/AppVersion-v2.16.4-informational?style=flat-square)
18+
![Version: 2.16.5](https://img.shields.io/badge/Version-2.16.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.16.5](https://img.shields.io/badge/AppVersion-v2.16.5-informational?style=flat-square)
1919

2020
FiftyOne Enterprise is the enterprise version of the open source [FiftyOne](https://github.com/voxel51/fiftyone) project.
2121
The FiftyOne Enterprise Helm chart is the recommended way to install and configure FiftyOne Enterprise on Kubernetes.
@@ -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 \
@@ -1023,7 +1038,7 @@ If pods show unhealthy states (e.g., `0/1`, `CrashLoopBackOff`, `Pending`):
10231038
| teamsAppSettings.env.APP_USE_HTTPS | bool | `true` | Controls the protocol of the `teams-app`. Configure your ingress to match. When `true`, uses the https protocol. When `false`, uses the http protocol. |
10241039
| teamsAppSettings.env.FIFTYONE_APP_ALLOW_MEDIA_EXPORT | bool | `true` | When `false`, disables media export options |
10251040
| teamsAppSettings.env.FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED | bool | `true` | Controls whether anonymous analytics are captured for the application. Set to false to opt-out of anonymous analytics. |
1026-
| teamsAppSettings.env.FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION | string | `"2.16.4"` | The recommended fiftyone SDK version that will be displayed in the install modal (i.e. `pip install ... fiftyone==0.11.0`). |
1041+
| teamsAppSettings.env.FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION | string | `"2.16.5"` | The recommended fiftyone SDK version that will be displayed in the install modal (i.e. `pip install ... fiftyone==0.11.0`). |
10271042
| teamsAppSettings.env.FIFTYONE_APP_THEME | string | `"dark"` | The default theme configuration. `dark`: Theme will be dark when user visits for the first time. `light`: Theme will be light theme when user visits for the first time. `always-dark`: Sets dark theme on each refresh (overrides user theme changes in the app). `always-light`: Sets light theme on each refresh (overrides user theme changes in the app). |
10281043
| teamsAppSettings.env.RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED | bool | `false` | Disable duplicate atom/selector key checking that generated false-positive errors. [Reference][recoil-env]. |
10291044
| teamsAppSettings.fiftyoneApiOverride | string | `""` | Overrides the `FIFTYONE_API_URI` environment variable. When set `FIFTYONE_API_URI` controls the value shown in the API Key Modal providing guidance for connecting to the FiftyOne Enterprise API. `FIFTYONE_API_URI` uses the value from apiSettings.dnsName if it is set, or uses the teamsAppSettings.dnsName |

0 commit comments

Comments
 (0)