Skip to content

Commit c7e1682

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

1 file changed

Lines changed: 17 additions & 15 deletions

File tree

README.md

Lines changed: 17 additions & 15 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.17.1](https://img.shields.io/badge/Version-2.17.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.17.1](https://img.shields.io/badge/AppVersion-v2.17.1-informational?style=flat-square)
18+
![Version: 2.17.2](https://img.shields.io/badge/Version-2.17.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.17.2](https://img.shields.io/badge/AppVersion-v2.17.2-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.
@@ -51,8 +51,8 @@ FiftyOne Enterprise 2.14+ introduces custom roles and role bindings to allow the
5151
`teams-api` deployment to create, update, and remove batch jobs and pods for
5252
kubernetes-based
5353
[on-demand delegated operations](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/docs/configuring-on-demand-orchestrator.md).
54-
An additional service account is now created by the helm chart to utilize these roles
55-
and is attached to the `teams-api` deployment object.
54+
An additional service account is now created by the helm chart to utilize these
55+
roles and is attached to the `teams-api` deployment object.
5656

5757
The
5858
[on-demand delegated operations](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/docs/configuring-on-demand-orchestrator.md).
@@ -691,26 +691,27 @@ If pods show unhealthy states (e.g., `0/1`, `CrashLoopBackOff`, `Pending`):
691691

692692
1. **Get detailed pod information**:
693693

694-
```shell
695-
kubectl describe pod <pod-name>
696-
```
694+
```shell
695+
kubectl describe pod <pod-name>
696+
```
697697

698698
1. **Check application logs**:
699699

700-
```shell
701-
kubectl logs <pod-name>
702-
# For previous container instance logs
703-
kubectl logs <pod-name> --previous
704-
```
700+
```shell
701+
kubectl logs <pod-name>
702+
# For previous container instance logs
703+
kubectl logs <pod-name> --previous
704+
```
705705

706706
1. **Check events for issues**:
707707

708-
```shell
709-
kubectl get events --sort-by='.lastTimestamp'
710-
```
708+
```shell
709+
kubectl get events --sort-by='.lastTimestamp'
710+
```
711711

712712
## Values
713713

714+
<!-- markdownlint-disable MD060 -->
714715
| Key | Type | Default | Description |
715716
|-----|------|---------|-------------|
716717
| apiSettings.affinity | object | `{}` | Affinity and anti-affinity for `teams-api`. [Reference][affinity]. |
@@ -1038,7 +1039,7 @@ If pods show unhealthy states (e.g., `0/1`, `CrashLoopBackOff`, `Pending`):
10381039
| 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. |
10391040
| teamsAppSettings.env.FIFTYONE_APP_ALLOW_MEDIA_EXPORT | bool | `true` | When `false`, disables media export options |
10401041
| 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. |
1041-
| teamsAppSettings.env.FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION | string | `"2.17.1"` | The recommended fiftyone SDK version that will be displayed in the install modal (i.e. `pip install ... fiftyone==0.11.0`). |
1042+
| teamsAppSettings.env.FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION | string | `"2.17.2"` | The recommended fiftyone SDK version that will be displayed in the install modal (i.e. `pip install ... fiftyone==0.11.0`). |
10421043
| 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). |
10431044
| teamsAppSettings.env.RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED | bool | `false` | Disable duplicate atom/selector key checking that generated false-positive errors. [Reference][recoil-env]. |
10441045
| 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 |
@@ -1082,6 +1083,7 @@ If pods show unhealthy states (e.g., `0/1`, `CrashLoopBackOff`, `Pending`):
10821083
| teamsAppSettings.updateStrategy | object | `{"type":"RollingUpdate"}` | Control how `teams-app` pods are redeployed during an upgrade. [Reference][upgrade-strategies] |
10831084
| teamsAppSettings.volumeMounts | list | `[]` | Volume mounts for `teams-app` pods. [Reference][volumes]. |
10841085
| teamsAppSettings.volumes | list | `[]` | Volumes for `teams-app` pods. [Reference][volumes]. |
1086+
<!-- markdownlint-enable MD060 -->
10851087

10861088
<!-- Reference Links -->
10871089
[affinity]: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/

0 commit comments

Comments
 (0)