Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion cli/cmd/command_profiles.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ var commandProfiles = map[string][]string{
"clean": {"deploy"},
"cluster": {"topology", "chaos"},
"completion": nil,
"conformity": {"topology"},
"conformity": {"deploy", "topology"},
"cost": {"performance"},
"ctx": nil,
"dashboard": {"performance", "integrity"},
Expand Down
2 changes: 1 addition & 1 deletion cli/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,6 @@ Health & Status:
version CLI, API, and runtime version info
cluster Kafka cluster metadata and topic listing
diff Compare Kafka cluster state between two contexts
conformity Check the cluster against a reference architecture
test list List test runs with optional filters
test get Show details of a specific test run

Expand Down Expand Up @@ -444,6 +443,7 @@ Policy Engine (Kyverno):
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
auto Auto-detect cluster config and deploy Kafka
operators Strimzi operators on this cluster
Expand Down
4 changes: 2 additions & 2 deletions docs/book/10-cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@ A context can enable only the commands its user works with. Each profile enables
| `performance` | `advisor`, `badge`, `benchmark`, `cost`, `dashboard`, `explain`, `flow`, `gate`, `lab`, `profile`, `replay`, `report`, `scenario-diff`, `schedule`, `test`, `top`, `trend`, `tune`, `watch`, `webhook` |
| `integrity` | `dashboard`, `explain`, `kafka`, `migrate`, `replay`, `report`, `scenario-diff`, `schedule`, `test`, `top`, `watch`, `webhook` |
| `chaos` | `chaos`, `cluster`, `disruption`, `flow`, `report`, `resilience`, `test`, `watch` |
| `topology` | `cluster`, `diff`, `doctor`, `kafka`, `snapshot` |
| `topology` | `cluster`, `conformity`, `diff`, `doctor`, `kafka`, `snapshot` |
| `security` | `kyverno`, `security` |
| `deploy` | `auto`, `clean`, `deploy`, `detect`, `doctor`, `kyverno`, `migrate`, `operator`, `operators`, `versions` |
| `deploy` | `auto`, `clean`, `conformity`, `deploy`, `detect`, `doctor`, `kyverno`, `migrate`, `operator`, `operators`, `versions` |

Every profile also enables `audit`, `changelog`, `completion`, `ctx`, `docs`, `health`, `help`, `init`, `mcp`, `plugin`, `ports`, `status`, `theme`, `tldr`, `upgrade`, `version` and plugins. A context with no profiles enables every command, which is how every context starts.

Expand Down
2 changes: 1 addition & 1 deletion docs/book/conformity.md
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,7 @@ WARN brokers.antiAffinity
WAIVED monitoring.kafkaExporter
```

`kates conformity` belongs to the `topology` [command profile](10-cli-reference.md#command-profiles). A context whose profiles leave it out refuses all three subcommands, `lint` and `fmt` included, so a pipeline's context needs that profile or none. The [Conformity](10-cli-reference.md#conformity) entries in the CLI Reference list every flag, and [POST /api/conformity/check](11-api-reference.md#post-apiconformitycheck) documents the report's JSON for callers that skip the CLI.
`kates conformity` belongs to the `topology` and `deploy` [command profiles](10-cli-reference.md#command-profiles). A context whose profiles leave both out refuses all three subcommands, `lint` and `fmt` included, so a pipeline's context needs one of them or none. The [Conformity](10-cli-reference.md#conformity) entries in the CLI Reference list every flag, and [POST /api/conformity/check](11-api-reference.md#post-apiconformitycheck) documents the report's JSON for callers that skip the CLI.

## The Language at a Glance

Expand Down
Loading