Add descriptions and examples to calicoctl command help - #13302
Merged
marvin-tigera merged 2 commits intoJul 23, 2026
Merged
Conversation
The command only rewrites default-tier policy names, so the one-line summary now names the legacy "default." prefix specifically, matching the fuller description the subcommand already prints.
caseydavenport
added
docs-not-required
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates calicoctl’s datastore migrate-policy-names one-line help text to more precisely describe what the command actually rewrites (the legacy default. prefix), aligning the short summary with the existing detailed behavior/output.
Changes:
- Refine
migrate-policy-namesshort help text to explicitly reference the legacydefault.tier prefix.
The docopt to cobra migration dropped the per-command description text. This adds a short Long description to every command explaining what it does and when to use it, plus usage examples on the leaf commands.
caseydavenport
changed the title
coutinhop
approved these changes
Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docopt to cobra migration (#12624) dropped the descriptions calicoctl used to print for each command. This adds them back for cobra: every command's
--helpnow shows a short description of what it does and when you'd use it, and the leaf commands include usage examples. The descriptions are deliberately shorter than the old docopt text - purpose first, not a wall of prose.This is cobra-only, so it doesn't apply to release-v3.32 where calicoctl still uses docopt.
It also clarifies the
migrate-policy-namesone-line summary, which said it drops "the tier prefix" but only rewrites default-tier policy names. It now names the legacy "default." prefix specifically. That wording fix goes to release-v3.32 separately (#13303).Companion docs update: tigera/docs#2878.