Skip to content

docs: the chart documented a values block it now rejects - #213

Merged
stxkxs merged 1 commit into
mainfrom
slo-docs
Aug 8, 2026
Merged

docs: the chart documented a values block it now rejects#213
stxkxs merged 1 commit into
mainfrom
slo-docs

Conversation

@stxkxs

@stxkxs stxkxs commented Aug 8, 2026

Copy link
Copy Markdown
Member

The claim

charts/operator/README.md carried a full ### operator SLO (slo.*) section — slo.operatorNamespace, slo.alerting.enabled, the six Secrets its receivers need, and advice to "enable per-env in production once provisioned." Chart.yaml's description said the same thing three lines above the entry recording that 0.6.0 removed the PrometheusRule, the AlertmanagerConfig and the namespace that held them.

Why it got worse, not better

Until 0.6.4 this was merely false in the way Helm makes cheap: an unknown value is absorbed in silence, so a reader who followed the README got no alerting and no error either.

0.6.4 shipped values.schema.json, which closes the top level. Following this README now fails outright:

$ helm template op charts/operator --set slo.enabled=true
Error: values don't meet the specifications of the schema(s)
operator:
- at '': additional properties 'slo' not allowed

Documentation instructing a user to do something the artifact rejects.

The fix

Both spellings corrected. The README now says where the operator's alert rules actually live — eks-gitops, as Grafana-managed rules evaluated against AMP, not a prometheus-operator in-cluster — and distinguishes the reconcilers.slo key that does exist and toggles the SLOPolicy reconciler in the binary.

The version bump, and who caught it

0.6.4 → 0.6.5, because README.md is packaged content and the published 0.6.4 would otherwise be overwritten with different bytes under the same tag.

I did not notice that. check-chart-version-bump.py did, on its first real change since it landed this morning — and it discriminated correctly:

FAIL  1 chart(s) changed without a version bump:
  operator — version is still 0.6.4
      content differs: README.md

Only README.md. Chart.yaml's edit is comment-only and helm package drops comments, which is exactly the case the gate's self-test holds green.

No template, CRD, default or appVersion changed.

Related

This is half of what keeps regenerating eks-gitops#33. The other half — whether severity: page rules have any contact point behind them — can't be answered from source and is commented there separately.

charts/operator/README.md carried a `### operator SLO (slo.*)` section
describing `slo.operatorNamespace` and `slo.alerting.enabled`, complete with the
six Secrets the receivers need and advice to enable it per-environment in
production. Chart.yaml's description said the same, three lines above the entry
recording that 0.6.0 removed the PrometheusRule, the AlertmanagerConfig and the
namespace that held them.

Until 0.6.4 that was merely false, in the way Helm makes cheap: an unknown value
is absorbed in silence, so a reader who followed the README got no alerting and
no error either. 0.6.4 shipped values.schema.json, which closes the top level.
Following this README now fails outright:

    helm template ... --set slo.enabled=true
    Error: values don't meet the specifications of the schema(s)
    - at '': additional properties 'slo' not allowed

So the documentation instructed a user to do something the artifact rejects.
Both spellings are corrected, and the README now states where the operator's
alert rules actually live — eks-gitops, as Grafana-managed rules evaluated
against AMP — and distinguishes the `reconcilers.slo` key that does exist and
toggles the SLOPolicy reconciler in the binary.

The version moves to 0.6.5 because README.md is packaged content and the
published 0.6.4 would otherwise be overwritten with different bytes under the
same tag. This was caught by check-chart-version-bump.py rather than by me, on
its first real change since it landed, and it discriminated correctly:
Chart.yaml's edit is comment-only and helm drops comments on package, so only
README.md was reported as differing.

No template, CRD, default or appVersion changed.
@stxkxs
stxkxs merged commit 3ecc8d4 into main Aug 8, 2026
41 checks passed
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