chore(teams-do): AS-467 change image default versions (#281)

voxel51 · Jan 23, 2025 · d368c8e · d368c8e
1 parent 5d4a73e
commit d368c8e
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 11 deletions.
diff --git a/docker/README.md b/docker/README.md
@@ -41,6 +41,13 @@ Please refer to the
 [upgrade documentation](./docs/upgrading.md#from-fiftyone-teams-version-213)
 for steps on how to upgrade your delegated operators.
 
+### Version 2.5+ Delegated Operator Changes
+
+FiftyOne Teams v2.5 introduces some changes to delegated operators.
+Please refer to the
+[upgrade documentation](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/docker/docs/upgrading.md#fiftyone-teams-v25-delegated-operator-changes)
+for steps on how to upgrade your delegated operators.
+
 ## Table of Contents
 
 <!-- toc -->

diff --git a/docker/common-services.yaml b/docker/common-services.yaml
@@ -155,7 +155,7 @@ services:
     restart: always
 
   teams-do-common:
-    image: voxel51/fiftyone-app:v2.5.0
+    image: voxel51/fiftyone-teams-cv-full:v2.5.0
     deploy:
       replicas: ${FIFTYONE_DELEGATED_OPERATOR_WORKER_REPLICAS:-3}
     command: >

diff --git a/docker/docs/upgrading.md b/docker/docs/upgrading.md
@@ -4,6 +4,7 @@
 
 - [Upgrading From Previous Versions](#upgrading-from-previous-versions)
   - [From FiftyOne Teams Version 2.0.0 and Later](#from-fiftyone-teams-version-200-and-later)
+    - [FiftyOne Teams v2.5+ Delegated Operator Changes](#fiftyone-teams-v25-delegated-operator-changes)
     - [FiftyOne Teams v2.2+ Delegated Operator Changes](#fiftyone-teams-v22-delegated-operator-changes)
     - [Delegated Operation Capacity](#delegated-operation-capacity)
     - [Existing Orchestrators](#existing-orchestrators)
@@ -42,6 +43,27 @@ and update your deployment accordingly.
    fiftyone migrate --info
    ```
 
+#### FiftyOne Teams v2.5+ Delegated Operator Changes
+
+FiftyOne Teams v2.5.0 changes the base image of the built-in delegated
+operators (`teams-do`) from `voxel51/fiftyone-app` to `voxel51/fiftyone-teams-cv-full`.
+The `voxel51/fiftyone-teams-cv-full` image includes all of the dependencies
+required to run complex workflows out of the box.
+
+If you built your own image with custom dependencies,
+you will likely want to remake those images based off
+of this new `voxel51/fiftyone-teams-cv-full` image.
+
+Please note: this image is approximately 2GB larger than its predecessor
+and, as such, might take longer to pull and start.
+
+To utilize the prior image, update your `common-services.yaml` similar to the below:
+
+```yaml
+  teams-do-common:
+    image: voxel51/fiftyone-app:v2.5.0
+```
+
 #### FiftyOne Teams v2.2+ Delegated Operator Changes
 
 FiftyOne Teams v2.2 introduces some changes to delegated operators, detailed

diff --git a/helm/docs/upgrading.md b/helm/docs/upgrading.md
@@ -4,6 +4,7 @@
 
 - [Upgrading From Previous Versions](#upgrading-from-previous-versions)
   - [From FiftyOne Teams Version 2.0.0 or Higher](#from-fiftyone-teams-version-200-or-higher)
+    - [FiftyOne Teams v2.5+ Delegated Operator Changes](#fiftyone-teams-v25-delegated-operator-changes)
     - [FiftyOne Teams v2.2+ Delegated Operator Changes](#fiftyone-teams-v22-delegated-operator-changes)
       - [Delegated Operation Capacity](#delegated-operation-capacity)
       - [Existing Orchestrators](#existing-orchestrators)
@@ -81,6 +82,28 @@ A minimal example `values.yaml` may be found
    fiftyone migrate --info
    ```
 
+#### FiftyOne Teams v2.5+ Delegated Operator Changes
+
+FiftyOne Teams v2.5.0 changes the base image of the built-in delegated
+operators (`teams-do`) from `voxel51/fiftyone-app` to `voxel51/fiftyone-teams-cv-full`.
+The `voxel51/fiftyone-teams-cv-full` image includes all of the dependencies
+required to run complex workflows out of the box.
+
+If you built your own image with custom dependencies,
+you will likely want to remake those images based off
+of this new `voxel51/fiftyone-teams-cv-full` image.
+
+Please note: this image is approximately 2GB larger than its predecessor
+and, as such, might take longer to pull and start.
+
+To utilize the prior image, update your `values.yaml` similar to the below:
+
+```yaml
+delegatedOperatorExecutorSettings:
+  image:
+    repository: voxel51/fiftyone-app
+```
+
 #### FiftyOne Teams v2.2+ Delegated Operator Changes
 
 FiftyOne Teams v2.2 introduces some changes to delegated operators, detailed

diff --git a/helm/fiftyone-teams-app/README.md b/helm/fiftyone-teams-app/README.md
@@ -44,6 +44,13 @@ Please refer to the
 [upgrade documentation](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/helm/docs/upgrading.md#from-fiftyone-teams-version-213)
 for steps on how to upgrade your delegated operators.
 
+### Version 2.5+ Delegated Operator Changes
+
+FiftyOne Teams v2.5 introduces some changes to delegated operators.
+Please refer to the
+[upgrade documentation](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/helm/docs/upgrading.md#fiftyone-teams-v25-delegated-operator-changes)
+for steps on how to upgrade your delegated operators.
+
 ## Table of Contents
 
 <!-- toc -->
@@ -456,7 +463,7 @@ appSettings:
 | delegatedOperatorExecutorSettings.env.FIFTYONE_INTERNAL_SERVICE | bool | `true` | Whether the SDK is running in an internal service context. When running in FiftyOne Teams, set to `true`. |
 | delegatedOperatorExecutorSettings.env.FIFTYONE_MEDIA_CACHE_SIZE_BYTES | int | `-1` | Set the media cache size (in bytes) for the local FiftyOne Delegated Operator Executor processes. The default value is 32 GiB. `-1` is disabled. |
 | delegatedOperatorExecutorSettings.image.pullPolicy | string | `"Always"` | Instruct when the kubelet should pull (download) the specified image. One of `IfNotPresent`, `Always` or `Never`. [Reference][image-pull-policy]. |
-| delegatedOperatorExecutorSettings.image.repository | string | `"voxel51/fiftyone-app"` | Container image for delegated-operator-executor. |
+| delegatedOperatorExecutorSettings.image.repository | string | `"voxel51/fiftyone-teams-cv-full"` | Container image for delegated-operator-executor. |
 | delegatedOperatorExecutorSettings.image.tag | string | `""` | Image tag for delegated-operator-executor. Defaults to the chart version. |
 | delegatedOperatorExecutorSettings.labels | object | `{}` | Additional labels for the `delegated-operator-executor` deployment. [Reference][labels-and-selectors]. |
 | delegatedOperatorExecutorSettings.liveness.failureThreshold | int | `5` | Number of times to retry the liveness probe for the teams-do. [Reference][probes]. |

diff --git a/helm/fiftyone-teams-app/README.md.gotmpl b/helm/fiftyone-teams-app/README.md.gotmpl
@@ -44,6 +44,13 @@ Please refer to the
 [upgrade documentation](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/helm/docs/upgrading.md#from-fiftyone-teams-version-213)
 for steps on how to upgrade your delegated operators.
 
+### Version 2.5+ Delegated Operator Changes
+
+FiftyOne Teams v2.5 introduces some changes to delegated operators.
+Please refer to the
+[upgrade documentation](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/helm/docs/upgrading.md#fiftyone-teams-v25-delegated-operator-changes)
+for steps on how to upgrade your delegated operators.
+
 ## Table of Contents
 
 <!-- toc -->

diff --git a/helm/fiftyone-teams-app/values.yaml b/helm/fiftyone-teams-app/values.yaml
@@ -369,7 +369,7 @@ delegatedOperatorExecutorSettings:
     # One of `IfNotPresent`, `Always` or `Never`. [Reference][image-pull-policy].
     pullPolicy: Always
     # -- Container image for delegated-operator-executor.
-    repository: voxel51/fiftyone-app
+    repository: voxel51/fiftyone-teams-cv-full
     # -- Image tag for delegated-operator-executor. Defaults to the chart version.
     tag: ""
   # -- Additional labels for the `delegated-operator-executor` deployment. [Reference][labels-and-selectors].

diff --git a/tests/unit/compose/docker-compose-internal-auth_test.go b/tests/unit/compose/docker-compose-internal-auth_test.go
@@ -185,7 +185,7 @@ func (s *commonServicesInternalAuthDockerComposeTest) TestServiceImage() {
 			"teams-do",
 			[]string{internalAuthComposeDelegatedOperationsFile},
 			s.dotEnvFiles,
-			"voxel51/fiftyone-app:v2.5.0",
+			"voxel51/fiftyone-teams-cv-full:v2.5.0",
 		},
 	}
 

diff --git a/tests/unit/compose/docker-compose-legacy-auth_test.go b/tests/unit/compose/docker-compose-legacy-auth_test.go
@@ -185,7 +185,7 @@ func (s *commonServicesLegacyAuthDockerComposeTest) TestServiceImage() {
 			"teams-do",
 			[]string{legacyAuthComposeDelegatedOperationsFile},
 			s.dotEnvFiles,
-			"voxel51/fiftyone-app:v2.5.0",
+			"voxel51/fiftyone-teams-cv-full:v2.5.0",
 		},
 	}
 

diff --git a/tests/unit/helm/delegated-operator-executor-deployment_test.go b/tests/unit/helm/delegated-operator-executor-deployment_test.go
@@ -679,32 +679,32 @@ func (s *deploymentDelegatedOperatorExecutorTemplateTest) TestContainerImage() {
 			map[string]string{
 				"delegatedOperatorExecutorSettings.enabled": "true",
 			},
-			fmt.Sprintf("voxel51/fiftyone-app:%s", chartAppVersion),
+			fmt.Sprintf("voxel51/fiftyone-teams-cv-full:%s", chartAppVersion),
 		},
 		{
 			"overrideImageTag",
 			map[string]string{
 				"delegatedOperatorExecutorSettings.enabled":   "true",
 				"delegatedOperatorExecutorSettings.image.tag": "testTag",
 			},
-			"voxel51/fiftyone-app:testTag",
+			"voxel51/fiftyone-teams-cv-full:testTag",
 		},
 		{
 			"overrideImageRepository",
 			map[string]string{
 				"delegatedOperatorExecutorSettings.enabled":          "true",
-				"delegatedOperatorExecutorSettings.image.repository": "ghcr.io/fiftyone-app",
+				"delegatedOperatorExecutorSettings.image.repository": "ghcr.io/fiftyone-teams-cv-full",
 			},
-			fmt.Sprintf("ghcr.io/fiftyone-app:%s", chartAppVersion),
+			fmt.Sprintf("ghcr.io/fiftyone-teams-cv-full:%s", chartAppVersion),
 		},
 		{
 			"overrideImageVersionAndRepository",
 			map[string]string{
 				"delegatedOperatorExecutorSettings.enabled":          "true",
 				"delegatedOperatorExecutorSettings.image.tag":        "testTag",
-				"delegatedOperatorExecutorSettings.image.repository": "ghcr.io/fiftyone-app",
+				"delegatedOperatorExecutorSettings.image.repository": "ghcr.io/fiftyone-teams-cv-full",
 			},
-			"ghcr.io/fiftyone-app:testTag",
+			"ghcr.io/fiftyone-teams-cv-full:testTag",
 		},
 	}