Skip to content

Commit e08cff5

Browse files
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>
1 parent ed9cd75 commit e08cff5

3 files changed

Lines changed: 12 additions & 13 deletions

File tree

docs/orchestrators/configuring-kubernetes-orchestrator.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -467,18 +467,17 @@ fom.register_orchestrator(
467467
> FiftyOne UI's log viewer for delegated-operator runs — it depends on
468468
> the sidecar to capture per-operation logs.
469469

470-
If your deployment runs telemetry (the helm chart and docker compose
471-
files include it by default), you can attach a per-Job telemetry
470+
If your deployment runs telemetry (the Helm chart includes
471+
it by default), you can attach a per-Job telemetry
472472
sidecar to on-demand Kubernetes orchestrators as well.
473473
This emits per-operation metrics back to the same Redis backend so the
474474
Settings → Metrics page sees individual delegated runs.
475475

476-
Use of a Kubernetes
476+
We use Kubernetes
477477
[native sidecar](https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/)
478-
(an `initContainer` with `restartPolicy: Always`, requires Kubernetes
479-
1.29+).
480-
A regular sidecar container would block Job completion — the Job stays
481-
in `Running` until every container exits.
478+
(an `initContainer` with `restartPolicy: Always`).
479+
A regular sidecar container would block Job completion where the Job stays
480+
in `Running` status until every container exits.
482481
Native sidecars are auto-terminated by the kubelet when all non-sidecar
483482
containers complete, so the Job finalizes cleanly.
484483

@@ -822,7 +821,7 @@ spec:
822821
```
823822

824823
The `telemetry-sidecar` init container above is optional.
825-
If you are not running telemetry, remove all of the following from the
824+
To opt out of running telemetry, remove all of the following from the
826825
template:
827826

828827
- the `telemetry-sidecar` init container

helm/docs/upgrading.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ FiftyOne Enterprise v2.19.0 adds observability features viewable by
150150
admins directly in the FiftyOne UI.
151151
These are powered by a `telemetry-sidecar` container injected into the
152152
`teams-api`, `fiftyone-app`, `teams-plugins`, and delegated-operator
153-
workloads (and as a native init-sidecar on on-demand delegated-operator
153+
workloads (and as a native sidecar on on-demand delegated-operator
154154
`Job` pods), plus an in-cluster Redis `Deployment` + `Service` that
155155
buffers the streamed metrics and logs.
156156
@@ -161,8 +161,8 @@ A default deploy adds four sidecars
161161
delegated-operator), so expect roughly **+400m CPU** and **+2 GiB
162162
memory** in additional resource usage, plus the bundled Redis (`250m`
163163
CPU / `512Mi` memory, request == limit) backed by an `emptyDir`.
164-
Tune via `telemetry.sidecar.resources` and `telemetry.redis.resources`;
165-
opt into a `PersistentVolumeClaim` with
164+
Tune via `telemetry.sidecar.resources` and `telemetry.redis.resources`.
165+
Opt into a `PersistentVolumeClaim` with
166166
`telemetry.redis.persistence.enabled: true`.
167167
168168
##### Cluster Requirements
@@ -205,7 +205,7 @@ telemetry:
205205
```
206206
207207
> [!IMPORTANT]
208-
> The sidecar powers the FiftyOne UI's delegated-operator log viewer.
208+
> The telemetry sidecars power the FiftyOne UI's delegated-operator log viewer.
209209
> Disabling telemetry (`telemetry.enabled: false`) will leave that log
210210
> viewer empty.
211211

helm/fiftyone-teams-app/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1621,7 +1621,7 @@ teamsAppSettings:
16211621
# -- Volumes for `teams-app` pods. [Reference][volumes].
16221622
volumes: []
16231623

1624-
# In-cluster telemetry. Renders a Redis Deployment + Service, a Role/RoleBinding
1624+
# In-cluster telemetry. Renders a Redis Deployment, Service, a Role/RoleBinding
16251625
# granting `pods/log` read access, and a `telemetry-sidecar` injected into the
16261626
# `teams-api`, `fiftyone-app`, `teams-plugins`, and delegated-operator workloads.
16271627
telemetry:

0 commit comments

Comments
 (0)