Skip to content

docs: k8s no-clone OCI parity + consistent one---set-per-axis#28

Merged
elronbandel merged 2 commits into
mainfrom
elron/readme-oci-chart-parity
Jun 3, 2026
Merged

docs: k8s no-clone OCI parity + consistent one---set-per-axis#28
elronbandel merged 2 commits into
mainfrom
elron/readme-oci-chart-parity

Conversation

@elronbandel

@elronbandel elronbandel commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Why

Two doc consistency fixes around the k8s/job surface:

  1. No-clone parity. The README sells "deploy on any cloud, no clone" — compose pulls from oci://quay.io/eval-containers/evaluate, but the k8s section still showed only helm template benchmarks/_chart …, a local path requiring a clone. Making the chart self-contained (refactor(chart): bundle benchmark presets in the chart (self-contained, OCI-ready) #26) is what lets it be pulled from a registry; the docs never got that parity.
  2. One --set per axis. Several examples used --set agent=claude-code,task=0. helm's --set a=x,y=z splits on commas, so any value containing a comma breaks — which is exactly why the CLI deliberately emits one --set per axis. One example even claimed to show the CLI's output in the comma-joined form the CLI never produces.

What

  • README Kubernetes section leads with the published-chart form helm template aime oci://quay.io/eval-containers/charts/eval --version 0.1.0 --set benchmark=aime … (no-clone, under the existing Pre-release caveat); local ./benchmarks/_chart kept as the clone/CLI path — accurate, since the CLI's --mode job still renders the local chart.
  • All comma-joined --set → separate --set per axis, across README, docs/guides/deploy-on-kubernetes.md, docs/concepts/the-helm-chart.md, and the deploy/openshift-service-account.yaml comment.

Docs-only.

Follow-ups this surfaced

  • Chart publishing (helm package/push to oci://…/charts) — makes the oci:// form resolve.
  • CLI run --mode job is still repo-local (run_job hardcodes ./benchmarks/_chart; run_compose already defaults to oci://). Tracked separately.

The compose mode is presented as pull-from-oci (no clone); the k8s section
still showed only the local `benchmarks/_chart` path — even though making the
chart self-contained (it bundles each benchmark's preset) is exactly what lets
it be pulled from a registry. Lead the k8s section with the published
`oci://.../charts/eval` form (no clone), and keep the local-chart render as the
clone/CLI path. Accurate to current behavior: the CLI's job mode still renders
the local chart (unlike compose, which already defaults to oci).
helm's `--set a=x,y=z` splits on commas, so a value containing a comma breaks;
the CLI deliberately emits one `--set` per axis for that reason. Make the docs
match — including the example that purported to show the CLI's own output.
@elronbandel elronbandel changed the title docs(readme): give k8s the same no-clone OCI story as compose docs: k8s no-clone OCI parity + consistent one---set-per-axis Jun 3, 2026
@elronbandel elronbandel merged commit c66c6dd into main Jun 3, 2026
1 check failed
elronbandel added a commit that referenced this pull request Jun 15, 2026
docs: k8s no-clone OCI parity + consistent one-`--set`-per-axis
elronbandel added a commit that referenced this pull request Jun 15, 2026
docs: k8s no-clone OCI parity + consistent one-`--set`-per-axis
elronbandel added a commit that referenced this pull request Jun 15, 2026
docs: k8s no-clone OCI parity + consistent one-`--set`-per-axis
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant