Merge pull request #424 from voxel51/afoley/add-external-api-url

PR comments

Author: kaixi-wang

.github/workflows/release.yml

@@ -102,7 +102,7 @@ jobs:
           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
       - name: Download README artifact
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: helm-fiftyone-ai-readme
           path: helm-fiftyone-ai-readme

.pre-commit-config.yaml

@@ -81,13 +81,14 @@ repos:
           - helm/README.md
           - CONTRIBUTING.md
   - repo: https://github.com/gruntwork-io/pre-commit
-    rev: v0.1.29
+    rev: v0.1.30
     hooks:
       - id: helmlint
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.5.0
     hooks:
       - id: detect-secrets
+        exclude: '^helm/local-self-signed-example/cert-manger-crds/crd-.*.yaml'
         args:
           - --exclude-secrets
           - '(password|REPLACEME|fiftyone-teams-tls-secret|3-9XjJ-gUV?vp\^e\(WUk>LD&lAjh7yEji|btv8BiFCaPIayWU3IU3a_Lm_EMIIk-t6H_yN1ORV45o=|5b32118032bfd50b64b3cc7c0e0821f4e84f63ad517a9687ac2b6ce6ab261976|aGM4\?s&t-n;\!\*U96oA#bdo,\+JU\)ac1T7|test-*|/api/proxy/fiftyone-teams|/opt/plugins|fiftyone-license|LICENSE_KEY_FILE_PATHS)'
@@ -109,6 +110,8 @@ repos:
           - --diff
           - --write
           - --simplify
+          - --case-indent
+          - --indent=2
   - repo: https://github.com/compilerla/conventional-pre-commit
     rev: v4.2.0
     hooks:

.tool-versions

@@ -1,13 +1,13 @@
 cmctl 2.2.0
-golang 1.24.2
-helm 3.17.3
+golang 1.24.5
+helm 3.18.4
 helm-docs 1.14.2
-jq 1.7.1
-kubectl 1.33.0
-minikube 1.35.0
+jq 1.8.1
+kubectl 1.33.2
+minikube 1.36.0
 pre-commit 4.2.0
 python 3.11.12
 shellcheck 0.10.0
-shfmt 3.11.0
-skaffold 2.15.0
+shfmt 3.12.0
+skaffold 2.16.1
 yq 4.45.2

CONTRIBUTING.md

@@ -70,6 +70,18 @@
     make license-secret-internal
     ```
 
+1. Install or update the required helm repositories
+
+    ```shell
+    make helm-repos
+    ```
+
+    or
+
+    ```shell
+    make helm-repo-update
+    ```
+
 1. Run skaffold
 
     ```shell

Makefile

@@ -163,6 +163,10 @@ helm-repos:  ## add helm repos for the project
 	helm repo add bitnami https://charts.bitnami.com/bitnami
 	helm repo add jetstack https://charts.jetstack.io
 
+helm-repo-update:  ## updates the helm repos for the project
+	helm repo update bitnami
+	helm repo update jetstack
+
 clean: clean-unit-compose clean-unit-helm clean-integration-compose clean-integration-helm  ## delete all test output and reports
 
 clean-integration-compose:  ## delete docker compose integration test output and reports

docker/README.md

@@ -192,7 +192,7 @@ You can override the default image used by any service in
 ```yaml
 services:
   fiftyone-app:
-    image: voxel51/fiftyone-app-torch:v2.10.0
+    image: voxel51/fiftyone-app-torch:v2.10.2
 ```
 
 ## :rocket: Step 4: Initial Deployment

docker/common-services.yaml

@@ -1,9 +1,11 @@
 ---
 services:
   fiftyone-app-common:
-    image: voxel51/fiftyone-app:v2.10.0
+    image: voxel51/fiftyone-app:v2.10.2
     environment:
       API_URL: ${API_URL}
+      FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE: ${FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE}
+      FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE: ${FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE}
       FIFTYONE_AUTH_SECRET: ${FIFTYONE_AUTH_SECRET}
       FIFTYONE_DATABASE_ADMIN: false
       FIFTYONE_DATABASE_NAME: ${FIFTYONE_DATABASE_NAME}
@@ -30,7 +32,7 @@ services:
     restart: always
 
   teams-api-common:
-    image: voxel51/fiftyone-teams-api:v2.10.0
+    image: voxel51/fiftyone-teams-api:v2.10.2
     environment:
       API_EXTERNAL_URL: ${FIFTYONE_API_URI}
       CAS_BASE_URL: ${CAS_BASE_URL:-http://teams-cas:3000/cas/api}
@@ -58,23 +60,21 @@ services:
     restart: always
 
   teams-app-common:
-    image: voxel51/fiftyone-teams-app:v2.10.0
+    image: voxel51/fiftyone-teams-app:v2.10.2
     environment:
       API_URL: ${API_URL}
       APP_USE_HTTPS: ${APP_USE_HTTPS:-true}
       FIFTYONE_API_URI:
         ${FIFTYONE_API_URI:-"Please contact your Admin for an API URI"}
       FIFTYONE_APP_ALLOW_MEDIA_EXPORT: ${FIFTYONE_APP_ALLOW_MEDIA_EXPORT:-true}
-      FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION: 2.10.0
+      FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION: 2.10.2
       FIFTYONE_AUTH_SECRET: ${FIFTYONE_AUTH_SECRET}
       FIFTYONE_SERVER_ADDRESS: ""
       FIFTYONE_SERVER_PATH_PREFIX: /api/proxy/fiftyone-teams
       FIFTYONE_TEAMS_PROXY_URL: ${FIFTYONE_TEAMS_PROXY_URL}
       NODE_ENV: production
       RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED: false
       FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED: ${FIFTYONE_APP_ANONYMOUS_ANALYTICS_ENABLED:-true}
-      FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE: ${FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE}
-      FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE: ${FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE}
       # If you are routing through a proxy server you will want to set
       #  HTTP_PROXY_URL, HTTPS_PROXY_URL, and NO_PROXY_LIST in your .env
       #  then add the following environment variables to your
@@ -94,7 +94,7 @@ services:
     restart: always
 
   teams-cas-common:
-    image: voxel51/fiftyone-teams-cas:v2.10.0
+    image: voxel51/fiftyone-teams-cas:v2.10.2
     environment:
       CAS_DATABASE_NAME: ${CAS_DATABASE_NAME:-cas}
       CAS_DEFAULT_USER_ROLE: ${CAS_DEFAULT_USER_ROLE:-GUEST}
@@ -129,7 +129,7 @@ services:
         read_only: true
 
   teams-plugins-common:
-    image: voxel51/fiftyone-app-torch:v2.10.0
+    image: voxel51/fiftyone-app-torch:v2.10.2
     environment:
       API_URL: ${API_URL}
       FIFTYONE_AUTH_SECRET: ${FIFTYONE_AUTH_SECRET}
@@ -156,7 +156,7 @@ services:
     restart: always
 
   teams-do-common:
-    image: voxel51/fiftyone-teams-cv-full:v2.10.0
+    image: voxel51/fiftyone-teams-cv-full:v2.10.2
     deploy:
       replicas: ${FIFTYONE_DELEGATED_OPERATOR_WORKER_REPLICAS:-3}
     command: >

docker/docs/configuring-gpu-workloads.md

@@ -65,7 +65,7 @@ services:
       service: teams-do-common
 
   teams-do-with-gpu:
-    image: voxel51/fiftyone-teams-cv-full:v2.10.0
+    image: voxel51/fiftyone-teams-cv-full:v2.10.2
     command: >
       /bin/sh -c "fiftyone delegated launch -t remote  -n 'teams-do-with-gpu'"
     environment:

docker/docs/upgrading.md

@@ -78,9 +78,9 @@ quickstart  0.21.2
 
 ### From FiftyOne Enterprise Version 2.0.0 and Later
 
-1. [Upgrade to FiftyOne Enterprise version 2.10.0](#upgrading-from-previous-versions)
+1. [Upgrade to FiftyOne Enterprise version 2.10.2](#upgrading-from-previous-versions)
 1. Voxel51 recommends upgrading all FiftyOne Enterprise SDK users to FiftyOne Enterprise
-   version 2.10.0
+   version 2.10.2
     1. Login to the FiftyOne Enterprise UI
     1. To obtain the CLI command to install the FiftyOne SDK associated with
       your FiftyOne Enterprise version, navigate to `Account > Install FiftyOne`
@@ -121,7 +121,7 @@ To utilize the prior image, update your `common-services.yaml` similar to the be
 
 ```yaml
 teams-do-common:
-  image: voxel51/fiftyone-app:v2.10.0
+  image: voxel51/fiftyone-app:v2.10.2
 ```
 
 #### FiftyOne Enterprise v2.2+ Delegated Operator Changes
@@ -156,7 +156,7 @@ Additionally,
 
 ### From FiftyOne Enterprise Versions 1.6.0 to 1.7.1
 
-> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.0 _requires_ a license file.
+> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.2 _requires_ a license file.
 > Please contact your Customer Success Team before upgrading to FiftyOne Enterprise
 > 2.0 or beyond.
 >
@@ -191,15 +191,15 @@ Additionally,
    mv license.key "${LOCAL_LICENSE_FILE_DIR}/license"
    ```
 
-1. [Upgrade to FiftyOne Enterprise version 2.10.0](#upgrading-from-previous-versions)
-1. Upgrade FiftyOne Enterprise SDK users to FiftyOne Enterprise version 2.10.0
+1. [Upgrade to FiftyOne Enterprise version 2.10.2](#upgrading-from-previous-versions)
+1. Upgrade FiftyOne Enterprise SDK users to FiftyOne Enterprise version 2.10.2
     1. Login to the FiftyOne Enterprise UI
     1. To obtain the CLI command to install the FiftyOne SDK associated with
       your FiftyOne Enterprise version, navigate to `Account > Install FiftyOne`
 1. Upgrade all the datasets
-    > **NOTE**: Any FiftyOne SDK less than 2.10.0
+    > **NOTE**: Any FiftyOne SDK less than 2.10.2
     > will lose connectivity at this point.
-    > Upgrading to `fiftyone==2.10.0` is required.
+    > Upgrading to `fiftyone==2.10.2` is required.
 
     ```shell
     FIFTYONE_DATABASE_ADMIN=true fiftyone migrate --all
@@ -213,7 +213,7 @@ Additionally,
 
 ### From FiftyOne Enterprise Version 1.1.0 and Before Version 1.6.0
 
-> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.0 _requires_
+> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.2 _requires_
 > your users to log in after the upgrade is complete.
 > This will interrupt active workflows in the FiftyOne Enterprise Hosted Web App.
 > You should coordinate this upgrade carefully with your end-users.
@@ -231,7 +231,7 @@ Additionally,
 
 ---
 
-> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.0 _requires_ a license file.
+> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.2 _requires_ a license file.
 > Please contact your Customer Success Team before upgrading to FiftyOne Enterprise
 > 2.0 or beyond.
 >
@@ -283,15 +283,15 @@ Additionally,
         unset FIFTYONE_DATABASE_ADMIN
         ```
 
-1. [Upgrade to FiftyOne Enterprise version 2.10.0](#upgrading-from-previous-versions)
-1. Upgrade FiftyOne Enterprise SDK users to FiftyOne Enterprise version 2.10.0
+1. [Upgrade to FiftyOne Enterprise version 2.10.2](#upgrading-from-previous-versions)
+1. Upgrade FiftyOne Enterprise SDK users to FiftyOne Enterprise version 2.10.2
     1. Login to the FiftyOne Enterprise UI
     1. To obtain the CLI command to install the FiftyOne SDK associated with
       your FiftyOne Enterprise version, navigate to `Account > Install FiftyOne`
 1. Upgrade all the datasets
-    > **NOTE**: Any FiftyOne SDK less than 2.10.0
+    > **NOTE**: Any FiftyOne SDK less than 2.10.2
     > will lose connectivity at this point.
-    > Upgrading to `fiftyone==2.10.0` is required.
+    > Upgrading to `fiftyone==2.10.2` is required.
 
     ```shell
     FIFTYONE_DATABASE_ADMIN=true fiftyone migrate --all
@@ -322,14 +322,14 @@ Additionally,
 
 ---
 
-> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.0 _requires_ your users to
+> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.2 _requires_ your users to
 > log in after the upgrade is complete.
 > This will interrupt active workflows in the FiftyOne Enterprise Hosted Web App.
 > You should coordinate this upgrade carefully with your end-users.
 
 ---
 
-> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.0 _requires_ a license file.
+> **NOTE**: Upgrading to FiftyOne Enterprise v2.10.2 _requires_ a license file.
 > Please contact your Customer Success Team before upgrading to FiftyOne Enterprise
 > 2.0 or beyond.
 >
@@ -360,13 +360,13 @@ Additionally,
 1. Update your web server routes to include routing
    `/cas/*` traffic to the `teams-cas` service.
    Please see our [example nginx configurations](../) for more information.
-1. [Upgrade to FiftyOne Enterprise v2.10.0](#upgrading-from-previous-versions)
+1. [Upgrade to FiftyOne Enterprise v2.10.2](#upgrading-from-previous-versions)
    with `FIFTYONE_DATABASE_ADMIN=true`
    (this is not the default for this release).
     > **NOTE**: FiftyOne SDK users will lose access to the FiftyOne
-    > Enterprise Database at this step until they upgrade to `fiftyone==2.10.0`
+    > Enterprise Database at this step until they upgrade to `fiftyone==2.10.2`
 
-1. Upgrade your FiftyOne SDKs to version 2.10.0
+1. Upgrade your FiftyOne SDKs to version 2.10.2
     1. Login to the FiftyOne Enterprise UI
     1. To obtain the CLI command to install the FiftyOne SDK associated
       with your FiftyOne Enterprise version, navigate to

docs/custom-plugins.md

@@ -46,7 +46,7 @@ With a Dockerfile like this, you could use the following commands to
 build, and publish, your image to your internal registry
 
 ```shell
-FIFTYONE_ENTERPRISE_VERSION=v2.10.0
+FIFTYONE_ENTERPRISE_VERSION=v2.10.2
 docker buildx build --push \
   --build-arg FIFTYONE_ENTERPRISE_IMAGE_NAME="voxel51/fiftyone-app:${FIFTYONE_ENTERPRISE_VERSION}" \
   -t your-internal-registry/fiftyone-app-internal:${FIFTYONE_ENTERPRISE_VERSION} .
@@ -63,7 +63,7 @@ After your custom plugins image is built, you can add it to your
 ```yaml
 services:
   teams-plugins:
-    image: your-internal-registry/fiftyone-app-internal:v2.10.0
+    image: your-internal-registry/fiftyone-app-internal:v2.10.2
 ```
 
 Please see