Skip to content

fix(governance): lock the sizing keys a chart carries and explain the sizing directory #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
catinspace-au merged 3 commits into from
Oct 2, 2026
Merged

fix(governance): lock the sizing keys a chart carries and explain the sizing directory #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecf0473
fix(governance): lock the six sizing fields and explain the sizing di…
catinspace-au Sep 14, 2026
8d632bf
Merge remote-tracking branch 'origin/main' into fix/sizing-locks
catinspace-au Oct 2, 2026
4e6e028
fix(governance): lock only the sizing keys a chart carries
catinspace-au Oct 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions governance/policies/sizing-locks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: sizing-locks
description: >-
The sizing fields dfe-infra's resolver refuses to move without --migrate (the locked: section of its sizing/sizing.yaml), held here as protected vars wherever a chart key carries one. Holders of helmvars:override can still make a deliberate exception.
protected:
# The partition count derives from these, and a keyed topic cannot be repartitioned without breaking hash(key) % partitions.
- "infravars:*:kafka.sizing.*"
# Combined to separate KRaft controllers re-forms the metadata quorum.
- "infravars:*:kafka.controllerPool.enabled"
# A deployment moved to another cloud is a new deployment.
- "infravars:*:cloud"
# storageModel is held by storage-layout.yaml, and the MSK broker type and AZ count are OpenTofu inputs with no chart key.
9 changes: 9 additions & 0 deletions sizing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# sizing/ -- the resolver's committed output for this deployment

`sizing/resolved.yaml` is written by dfe-infra's sizing resolver (`scripts/resolve_sizing.py`) and committed here. It records the tier, focus, cloud, region and ingest estimate the deployment was sized from, its compute cost bucket wherever cloud shapes were resolved, and a `locked:` section holding the current value of each field the resolver refuses to move without `--migrate`: partition count, storage model, MSK broker type, KRaft controller mode, cloud and AZ count.

It is committed on purpose. `dfe-ops upgrade plan --deploy <this repo> --dial deployment.yaml --live` re-resolves and diffs the result against this file, so a re-size is checked against what is already deployed rather than derived from scratch. Re-run the resolver and commit what it writes rather than hand-editing this file.

The same run writes `sizing/<tier>.values.yaml` and `sizing/<tier>.report.md`. The `kafka` and `clickhouse` blocks of the values file take effect once they are in `infra/kafka.yaml` and `infra/clickhouse-cluster.yaml`, and the report says what was sized, from which ratio, at which confidence and in which cost bucket. The OpenTofu inputs, `sizing.auto.tfvars.json`, belong beside the OpenTofu root module that reads them.

`governance/policies/sizing-locks.yaml` is the engine's side of the same locks: it refuses an API edit to the chart keys behind them unless the caller holds `helmvars:override`, and `storage-layout.yaml` does the same for the storage model. The MSK broker type and the AZ count are OpenTofu inputs with no chart key, so only the resolver guards those. Neither policy governs a direct git commit.
Loading