Skip to content

Commit

Permalink
chore: Init Container Docs (#266)
Browse files Browse the repository at this point in the history
  • Loading branch information
afoley587 authored Dec 18, 2024
1 parent 817784e commit abfaad5
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/pre-release-internal-env.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
branches-ignore:
- main
paths:
- 'helm/**'
- 'helm/fiftyone-teams-app/**'
- '.github/workflows/pre-release-internal-env.yml'

jobs:
Expand Down
30 changes: 30 additions & 0 deletions helm/docs/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [FiftyOne Teams v2.2+ Delegated Operator Changes](#fiftyone-teams-v22-delegated-operator-changes)
- [Delegated Operation Capacity](#delegated-operation-capacity)
- [Existing Orchestrators](#existing-orchestrators)
- [Version 2.2+ InitContainers Additions](#version-22-initcontainers-additions)
- [From FiftyOne Teams Version 2.0.0](#from-fiftyone-teams-version-200)
- [From FiftyOne Teams Versions 1.6.0 to 1.7.1](#from-fiftyone-teams-versions-160-to-171)
- [From FiftyOne Teams Versions After 1.1.0 and Before Version 1.6.0](#from-fiftyone-teams-versions-after-110-and-before-version-160)
Expand Down Expand Up @@ -113,6 +114,32 @@ Additionally,
> in `values.yaml` in order for the delegated operation system to function
> properly.
#### Version 2.2+ InitContainers Additions

Kubernetes [`initContainers`][init-containers]
were added in Version 2.2.0 to enforce the order of pod startup.
The image and tag are customizable.
Any image supporting `nslookup`, such as `docker.io/busybox`, are applicable
replacements.

For a full list of settings, please refer to the
[values list](https://helm.fiftyone.ai/#values).

> [!NOTE]
> It is recommended to add a `podSecurityContext` to avoid running
> init containers as root.
> An example policy is shown below:
```yaml
podSecurityContext:
runAsUser: 1000
```
> [!NOTE]
> Init containers can be disabled.
> Voxel51 does not recommend disabling init containers to enforce
> inter-pod dependencies are satisfied before proceeding.
### From FiftyOne Teams Version 2.0.0
1. [Upgrade to FiftyOne Teams version 2.2.0](#upgrading-from-previous-versions)
Expand Down Expand Up @@ -371,3 +398,6 @@ Please contact your Voxel51 Customer Success
team member to coordinate this upgrade.
You will need to either create a new Identity Provider (IdP)
or modify your existing configuration to migrate to a new Auth0 Tenant.

<!-- Reference Links -->
[init-containers]: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

0 comments on commit abfaad5

Please sign in to comment.