Skip to content

feat(cli): kates lists conformity under Deployment, and the deploy profile enables it - #435

Merged
bmscomp merged 2 commits into
mainfrom
feat/help-conformity-deployment
Oct 20, 2026
Merged

bmscomp merged 2 commits into
mainfrom
feat/help-conformity-deployment

Conversation

@bmscomp

@bmscomp bmscomp commented Oct 20, 2026 •

Copy link
Copy Markdown
Owner

kates with no arguments listed conformity under Health & Status. A conformity check holds a deployed cluster to the architecture it was meant to have, so this PR moves it to Deployment, right after deploy status:

Deployment:
  deploy         Deploy the Kates stack (Kafka, Kates, chaos, monitoring)
  deploy status  Health of the deployed components
  conformity     Check the cluster against a reference architecture
  detect         Deep cluster compatibility report for Kafka
  …

The deploy profile enables it too. Only topology enabled conformity, so a context limited to deploy would have hidden it from the section it now lives in. command_profiles.go now gives it {"deploy", "topology"}:

  • With KATES_PROFILES=deploy, the Deployment section lists conformity, and kates conformity lint runs.
  • With KATES_PROFILES=topology, it shows alone under Deployment.
  • A context with neither profile hides and refuses it, as before.

Docs

  • The CLI Reference's profile table lists conformity in both rows. The topology row had been missing it since the command shipped.
  • The Conformity Checks chapter names both profiles.

Checked locally: go vet ./cmd, go test ./cmd/ (including TestProfileHelp), scripts/check-book-style.sh, and the built CLI's help with no profiles, with topology only and with deploy only.

The root help listed `conformity` under Health & Status, next to the
commands that report on the cluster right now. A conformity check holds
a deployed cluster to the architecture it was meant to have, so it sits
in Deployment now, after `deploy status`. The profile filter works line
by line: a context with the topology profile still lists it, alone under
Deployment, and one without it hides it as before.
A context limited to the deploy profile hid `conformity`, now listed
under Deployment, because only topology enabled it. Checking a deployed
cluster against its reference is deploy work as much as topology work,
so both profiles enable it. The CLI Reference's profile table gains
`conformity` in both rows (topology had been missing it), and the
Conformity Checks chapter names both profiles.
@bmscomp bmscomp changed the title feat(cli): kates lists conformity under Deployment feat(cli): kates lists conformity under Deployment, and the deploy profile enables it Oct 20, 2026
@bmscomp
bmscomp merged commit 07c954d into main Oct 20, 2026
58 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