Add reference docs for calicoctl datastore migrate-policy-names#2877
Add reference docs for calicoctl datastore migrate-policy-names#2877caseydavenport wants to merge 2 commits into
Conversation
Documents the new command for the Next and v3.32 docs. OSS only for now, since the command has not merged to Calico Enterprise yet.
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds Calico Open Source reference documentation for the new calicoctl datastore migrate-policy-names command, and wires it into both the “next” (unversioned) docs and the Calico v3.32 versioned docs navigation.
Changes:
- Add new reference pages for
calicoctl datastore migrate-policy-names(next + v3.32). - Update
calicoctl datastoreoverview pages to show the correct--helpheader and include the new subcommand/link. - Add the new doc to both unversioned and v3.32 sidebars.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars-calico.js | Adds the new reference doc to the unversioned Calico sidebar navigation. |
| calico/reference/calicoctl/datastore/overview.mdx | Fixes the help-text heading and lists the new migrate-policy-names subcommand + link. |
| calico/reference/calicoctl/datastore/migrate-policy-names.mdx | New reference page documenting purpose, help output, examples, and related links. |
| calico_versioned_sidebars/version-3.32-sidebars.json | Adds the new reference doc to the v3.32 versioned sidebar. |
| calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx | Same overview updates as unversioned docs for v3.32. |
| calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx | New v3.32 reference page (includes v3.32.2+ availability note). |
Matches the CLI wording clarification (calicoctl now says it drops the legacy "default." tier prefix).
nelljerram
left a comment
nelljerram
left a comment
There was a problem hiding this comment.
LGTM. But if the plan is to merge this when 3.32.2 is released, couldn't we also immediately populate Enterprise Next and Cloud Next at that time, and hence include those changes in this PR?
Obviously will need to get @ctauchen 's review also.
|
@nelljerram I left it out of those docs given those products don't include OpenStack or etcdv3 datastore support |
That makes perfect sense. But the PR description makes it sound like it was for a different reason related to code merge timing: "OSS only for now, since the command hasn't merged to Calico Enterprise yet." |
Adds reference docs for the new
calicoctl datastore migrate-policy-namescommand (projectcalico/calico#13257), for both the Next and 3.32 docs.The command rewrites pre-v3.32 policy names in an etcdv3 datastore so the stored name matches the v3 resource name. You only need it on an etcdv3 datastore (for example OpenStack) that was upgraded in place from before v3.32 - a Kubernetes datastore is migrated automatically by kube-controllers.
This is the reference-doc companion to Nell's OpenStack upgrade procedure in #2851, and like that PR it's aimed at the v3.32.2 release. OSS only for now, since the command hasn't merged to Calico Enterprise yet.
While I was in the
datastoreoverview I also fixed the help-text heading, which saidcalicoctl datastore migrate --helpbut shows thecalicoctl datastore --helpoutput.Related: CORE-13170