Apply suggestions from code review

Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: Alan Smith <209585+mo-getter@users.noreply.github.com>

Author: mo-getter

docker/README.md

@@ -663,7 +663,6 @@ FiftyOne Enterprise bundles a telemetry sidecar and Redis backend by
 default in every compose file.
 The Settings → Metrics page in teams-app exposes live per-service
 metrics (CPU, memory, FDs, thread counts) and tailed logs.
-No opt-in flags are required.
 
 Please refer to the
 [telemetry configuration documentation](./docs/configuring-telemetry.md)

docker/internal-auth/compose.delegated-operators.gpu.yaml

@@ -56,7 +56,7 @@ services:
     profiles: ["gpu"]
     user: "1000:1000"
     cap_add:
-      - SYS_PTRACE  # allows for additional profiling metrics (sampled stacks via py-spy)
+      - SYS_PTRACE  # required for profiling metrics (sampled stacks via py-spy)
     deploy:
       resources:
         limits:
@@ -91,7 +91,7 @@ services:
         condition: service_started
     restart: always
 
-# Tmpfs-backed named volume with uid/gid set at mount time so the
+# tmpfs-backed named volume with uid/gid set at mount time so the
 # non-root sidecar can bind agent.sock.
 volumes:
   plugins-vol:

docker/internal-auth/compose.delegated-operators.yaml

@@ -1,38 +1,5 @@
 ---
-# Layered on top of a base compose file (e.g. compose.yaml). The base
-# compose file is expected to provide the `telemetry-redis` service.
-#
-# Each delegated-operator worker shares its PID namespace with a paired
-# telemetry sidecar (compose's `pid: "service:<name>"` only joins one
-# replica). To observe more than one worker at a time we declare a
-# fixed set of slots; slot 1 is always on and slots 2-3 are opt-in via
-# cumulative Compose profiles:
-#
-#   slot 1  teams-do      + teams-do-telemetry       (always on)
-#   slot 2  teams-do-2    + teams-do-2-telemetry     (do-2, do-3)
-#   slot 3  teams-do-3    + teams-do-3-telemetry     (do-3)
-#
-# Default (no profile) runs one worker. Selecting `do-N` for N>1 adds
-# slots up to N; profiles are nested so `do-3` includes slot 2.
-# Activate via `COMPOSE_PROFILES` in `.env`, e.g.
-#
-#   COMPOSE_PROFILES=do-3
-#   docker compose -f compose.yaml -f compose.delegated-operators.yaml up -d
-#
-# or equivalently with explicit flags:
-#
-#   docker compose --profile do-3 \
-#     -f compose.yaml -f compose.delegated-operators.yaml up -d
-#
-# This replaces the pre-telemetry `FIFTYONE_DELEGATED_OPERATOR_WORKER_REPLICAS`
-# knob, which scaled `teams-do` to N replicas but left N-1 of them
-# invisible to the telemetry sidecar. The cap of 3 is a deliberate
-# trade-off — for higher worker counts prefer the helm chart. If
-# docker compose is required, the slot-2/3 blocks below are templates:
-# duplicate them as `teams-do-4` / `teams-do-4-telemetry` etc.,
-# bumping the service name, `pid`, `POD_NAME`, `-n teams-do-N`, and
-# `telemetry-socket-N` volume on each copy. See
-# docker/docs/configuring-telemetry.md for details.
+# See docker/docs/configuring-telemetry.md for details on telemetry settings.
 #
 # For Proxy Server instructions please see
 #  https://github.com/voxel51/fiftyone-teams-app-deploy/tree/main/docker#environment-proxies
@@ -91,7 +58,7 @@ services:
     cap_drop:
       - ALL
     cap_add:
-      - SYS_PTRACE  # allows for additional profiling metrics (sampled stacks via py-spy)
+      - SYS_PTRACE  # required for profiling metrics (sampled stacks via py-spy)
     security_opt:
       - no-new-privileges:true
     environment:
@@ -155,7 +122,7 @@ services:
     cap_drop:
       - ALL
     cap_add:
-      - SYS_PTRACE  # allows for additional profiling metrics (sampled stacks via py-spy)
+      - SYS_PTRACE  # required for profiling metrics (sampled stacks via py-spy)
     security_opt:
       - no-new-privileges:true
     environment:
@@ -186,7 +153,7 @@ services:
         condition: service_started
     restart: always
 
-# Tmpfs-backed named volumes with uid/gid set at mount time so the
+# tmpfs-backed named volumes with uid/gid set at mount time so the
 # non-root sidecar can bind agent.sock without any init container.
 # Add new slots with `telemetry-socket-N: *telemetry-socket-spec`.
 volumes:

docker/internal-auth/compose.yaml

@@ -1,11 +1,6 @@
 ---
 # For Proxy Server instructions please see
 #  https://github.com/voxel51/fiftyone-teams-app-deploy/tree/main/docker#environment-proxies
-#
-# Telemetry (`telemetry-redis` + per-service sidecars) is enabled by
-# default. To opt out, scale the telemetry services to 0 in a
-# `compose.override.yaml`, or unset `FIFTYONE_TELEMETRY_REDIS_URL` and
-# remove the sidecar services. See docker/docs/configuring-telemetry.md.
 services:
   fiftyone-app:
     extends:

docker/internal-auth/env.template

@@ -100,25 +100,22 @@ FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true
 # 2 and/or 3, each paired with its own telemetry sidecar (static cap
 # of 3). `do-N` includes every lower slot, so `do-3` runs three workers.
 #
-# This replaces the pre-telemetry `FIFTYONE_DELEGATED_OPERATOR_WORKER_REPLICAS`
-# env var. To match its previous default of 3 workers, set
-# COMPOSE_PROFILES=do-3 below. See docker/docs/configuring-telemetry.md
+# See docker/docs/configuring-telemetry.md
 # and docker/docs/configuring-delegated-operators.md for details. The
 # value must not exceed the max concurrent delegated operators set in
-# your license file. For more than 3 workers, use the helm chart.
-# COMPOSE_PROFILES=do-3
+# your license file.
 
 # ─── Telemetry (bundled by default; overrides below are optional) ──────
 # Telemetry (`telemetry-redis` + per-service sidecars) is included in
 # every compose file by default. The variables below only need to be set
-# when overriding the bundled defaults. See
+# when overriding the defaults. See
 # docker/docs/configuring-telemetry.md to opt out or swap in an external
 # Redis.
 
 # Redis URL used by the telemetry sidecars and the main fiftyone-app /
 # teams-api / teams-app / teams-plugins / teams-do containers. Leave
 # blank to use the bundled in-stack Redis (redis://telemetry-redis:6379).
-# Override to point at a managed Redis (e.g. ElastiCache, MemoryStore).
+# Override to point at a managed Redis.
 # FIFTYONE_TELEMETRY_REDIS_URL=
 
 # Redis image and max memory for the bundled telemetry backend. The
@@ -134,4 +131,4 @@ FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true
 # FIFTYONE_APP_TARGET_NAME=hypercorn
 # TEAMS_API_TARGET_NAME=fiftyone-teams-api
 # TEAMS_PLUGINS_TARGET_NAME=hypercorn
-# TEAMS_DO_TARGET_NAME=fiftyone delegated
+# TEAMS_DO_TARGET_NAME="fiftyone delegated"

docker/legacy-auth/compose.delegated-operators.gpu.yaml

@@ -56,7 +56,7 @@ services:
     profiles: ["gpu"]
     user: "1000:1000"
     cap_add:
-      - SYS_PTRACE  # allows for additional profiling metrics (sampled stacks via py-spy)
+      - SYS_PTRACE  # required for profiling metrics (sampled stacks via py-spy)
     deploy:
       resources:
         limits:

docker/legacy-auth/compose.delegated-operators.yaml

@@ -1,38 +1,5 @@
 ---
-# Layered on top of a base compose file (e.g. compose.yaml). The base
-# compose file is expected to provide the `telemetry-redis` service.
-#
-# Each delegated-operator worker shares its PID namespace with a paired
-# telemetry sidecar (compose's `pid: "service:<name>"` only joins one
-# replica). To observe more than one worker at a time we declare a
-# fixed set of slots; slot 1 is always on and slots 2-3 are opt-in via
-# cumulative Compose profiles:
-#
-#   slot 1  teams-do      + teams-do-telemetry       (always on)
-#   slot 2  teams-do-2    + teams-do-2-telemetry     (do-2, do-3)
-#   slot 3  teams-do-3    + teams-do-3-telemetry     (do-3)
-#
-# Default (no profile) runs one worker. Selecting `do-N` for N>1 adds
-# slots up to N; profiles are nested so `do-3` includes slot 2.
-# Activate via `COMPOSE_PROFILES` in `.env`, e.g.
-#
-#   COMPOSE_PROFILES=do-3
-#   docker compose -f compose.yaml -f compose.delegated-operators.yaml up -d
-#
-# or equivalently with explicit flags:
-#
-#   docker compose --profile do-3 \
-#     -f compose.yaml -f compose.delegated-operators.yaml up -d
-#
-# This replaces the pre-telemetry `FIFTYONE_DELEGATED_OPERATOR_WORKER_REPLICAS`
-# knob, which scaled `teams-do` to N replicas but left N-1 of them
-# invisible to the telemetry sidecar. The cap of 3 is a deliberate
-# trade-off — for higher worker counts prefer the helm chart. If
-# docker compose is required, the slot-2/3 blocks below are templates:
-# duplicate them as `teams-do-4` / `teams-do-4-telemetry` etc.,
-# bumping the service name, `pid`, `POD_NAME`, `-n teams-do-N`, and
-# `telemetry-socket-N` volume on each copy. See
-# docker/docs/configuring-telemetry.md for details.
+# See docker/docs/configuring-telemetry.md for details on telemetry settings.
 #
 # For Proxy Server instructions please see
 #  https://github.com/voxel51/fiftyone-teams-app-deploy/tree/main/docker#environment-proxies
@@ -188,7 +155,7 @@ services:
         condition: service_started
     restart: always
 
-# Tmpfs-backed named volumes with uid/gid set at mount time so the
+# tmpfs-backed named volumes with uid/gid set at mount time so the
 # non-root sidecar can bind agent.sock without any init container.
 # Add new slots with `telemetry-socket-N: *telemetry-socket-spec`.
 volumes:

docker/legacy-auth/compose.yaml

@@ -2,10 +2,7 @@
 # For Proxy Server instructions please see
 #  https://github.com/voxel51/fiftyone-teams-app-deploy/tree/main/docker#environment-proxies
 #
-# Telemetry (`telemetry-redis` + per-service sidecars) is enabled by
-# default. To opt out, scale the telemetry services to 0 in a
-# `compose.override.yaml`, or unset `FIFTYONE_TELEMETRY_REDIS_URL` and
-# remove the sidecar services. See docker/docs/configuring-telemetry.md.
+# See docker/docs/configuring-telemetry.md for details on telemetry settings.
 services:
   fiftyone-app:
     extends:

docker/legacy-auth/env.template

@@ -105,7 +105,7 @@ FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true
 # 2 and/or 3, each paired with its own telemetry sidecar (static cap
 # of 3). `do-N` includes every lower slot, so `do-3` runs three workers.
 #
-# This replaces the pre-telemetry `FIFTYONE_DELEGATED_OPERATOR_WORKER_REPLICAS`
+# This replaces the deprecated `FIFTYONE_DELEGATED_OPERATOR_WORKER_REPLICAS`
 # env var. To match its previous default of 3 workers, set
 # COMPOSE_PROFILES=do-3 below. See docker/docs/configuring-telemetry.md
 # and docker/docs/configuring-delegated-operators.md for details. The
@@ -139,4 +139,4 @@ FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE=true
 # FIFTYONE_APP_TARGET_NAME=hypercorn
 # TEAMS_API_TARGET_NAME=fiftyone-teams-api
 # TEAMS_PLUGINS_TARGET_NAME=hypercorn
-# TEAMS_DO_TARGET_NAME=fiftyone delegated
+# TEAMS_DO_TARGET_NAME="fiftyone delegated"