|
15 | 15 | # fiftyone-teams-app |
16 | 16 |
|
17 | 17 | <!-- markdownlint-disable line-length --> |
18 | | -   |
| 18 | +   |
19 | 19 |
|
20 | 20 | FiftyOne Enterprise is the enterprise version of the open source [FiftyOne](https://github.com/voxel51/fiftyone) project. |
21 | 21 | 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 |
51 | 51 | `teams-api` deployment to create, update, and remove batch jobs and pods for |
52 | 52 | kubernetes-based |
53 | 53 | [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. |
56 | 56 |
|
57 | 57 | The |
58 | 58 | [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`): |
691 | 691 |
|
692 | 692 | 1. **Get detailed pod information**: |
693 | 693 |
|
694 | | - ```shell |
695 | | - kubectl describe pod <pod-name> |
696 | | - ``` |
| 694 | + ```shell |
| 695 | + kubectl describe pod <pod-name> |
| 696 | + ``` |
697 | 697 |
|
698 | 698 | 1. **Check application logs**: |
699 | 699 |
|
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 | + ``` |
705 | 705 |
|
706 | 706 | 1. **Check events for issues**: |
707 | 707 |
|
708 | | - ```shell |
709 | | - kubectl get events --sort-by='.lastTimestamp' |
710 | | - ``` |
| 708 | + ```shell |
| 709 | + kubectl get events --sort-by='.lastTimestamp' |
| 710 | + ``` |
711 | 711 |
|
712 | 712 | ## Values |
713 | 713 |
|
| 714 | +<!-- markdownlint-disable MD060 --> |
714 | 715 | | Key | Type | Default | Description | |
715 | 716 | |-----|------|---------|-------------| |
716 | 717 | | 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`): |
1038 | 1039 | | 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. | |
1039 | 1040 | | teamsAppSettings.env.FIFTYONE_APP_ALLOW_MEDIA_EXPORT | bool | `true` | When `false`, disables media export options | |
1040 | 1041 | | 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`). | |
1042 | 1043 | | 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). | |
1043 | 1044 | | teamsAppSettings.env.RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED | bool | `false` | Disable duplicate atom/selector key checking that generated false-positive errors. [Reference][recoil-env]. | |
1044 | 1045 | | 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`): |
1082 | 1083 | | teamsAppSettings.updateStrategy | object | `{"type":"RollingUpdate"}` | Control how `teams-app` pods are redeployed during an upgrade. [Reference][upgrade-strategies] | |
1083 | 1084 | | teamsAppSettings.volumeMounts | list | `[]` | Volume mounts for `teams-app` pods. [Reference][volumes]. | |
1084 | 1085 | | teamsAppSettings.volumes | list | `[]` | Volumes for `teams-app` pods. [Reference][volumes]. | |
| 1086 | +<!-- markdownlint-enable MD060 --> |
1085 | 1087 |
|
1086 | 1088 | <!-- Reference Links --> |
1087 | 1089 | [affinity]: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ |
|
0 commit comments