[CORE-13122] OpenStack: document the one-shot policy name migration for etcd clusters#2851
Open
nelljerram wants to merge 1 commit into
Open
[CORE-13122] OpenStack: document the one-shot policy name migration for etcd clusters#2851nelljerram wants to merge 1 commit into
nelljerram wants to merge 1 commit into
Conversation
Calico v3.32 changed how policies in the default tier are stored in the etcd datastore. Kubernetes clusters migrate existing data automatically via kube-controllers, but OpenStack clusters do not run kube-controllers as a service, so the migration must be run once by hand after upgrading from a version earlier than v3.32 (projectcalico/calico#13221). Add the procedure to the OpenStack upgrade page: symptoms if skipped, preconditions (all nodes upgraded first; duplicate-pair cleanup), the docker invocation including TLS and username/password auth variants, completion output, idempotency, and verification. The version-3.32 copy differs in using the standalone calico/kube-controllers image (the combined calico/calico image is v3.33+) and in noting that the mode requires v3.32.2 or later.
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds OpenStack-specific upgrade documentation for the one-time etcd policy name migration required when upgrading from Calico versions earlier than v3.32 (since OpenStack deployments don’t run kube-controllers as a service to perform the automatic migration).
Changes:
- Adds upgrade-page callouts/steps indicating the required one-time migration for upgrades from < v3.32.
- Documents the migration procedure end-to-end (symptoms, prerequisites, docker commands incl. TLS and username/password auth, idempotency, and verification).
- Adds a version-3.32 variant that uses the standalone
calico/kube-controllersimage and notes the v3.32.2+ requirement.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| calico/operations/upgrading/openstack-upgrade.mdx | Adds the policy-name migration section and links it into both CentOS/Ubuntu upgrade flows for “next” (unversioned) docs. |
| calico_versioned_docs/version-3.32/operations/upgrading/openstack-upgrade.mdx | Adds the same migration guidance for the v3.32 doc set, using the standalone kube-controllers image and a v3.32.2+ note. |
Comment on lines
+247
to
+251
| docker run --rm --net=host \ | ||
| -e DATASTORE_TYPE=etcdv3 \ | ||
| -e ETCD_ENDPOINTS=http://127.0.0.1:2379 \ | ||
| -e ENABLED_CONTROLLERS=openstackmigrations \ | ||
| $[registry]$[imageNames.calico/kube-controllers]:$[releaseTitle] |
Comment on lines
+258
to
+266
| docker run --rm --net=host \ | ||
| -v /etc/calico/certs:/etc/calico/certs:ro \ | ||
| -e DATASTORE_TYPE=etcdv3 \ | ||
| -e ETCD_ENDPOINTS=https://etcd1:2379,https://etcd2:2379 \ | ||
| -e ETCD_CA_CERT_FILE=/etc/calico/certs/ca.pem \ | ||
| -e ETCD_CERT_FILE=/etc/calico/certs/client.pem \ | ||
| -e ETCD_KEY_FILE=/etc/calico/certs/client-key.pem \ | ||
| -e ENABLED_CONTROLLERS=openstackmigrations \ | ||
| $[registry]$[imageNames.calico/kube-controllers]:$[releaseTitle] |
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.
Calico v3.32 changed how policies in the default tier are stored in the etcd datastore. Kubernetes clusters migrate existing data automatically via kube-controllers, but OpenStack clusters do not run kube-controllers as a service, so the migration must be run once by hand after upgrading from a version earlier than v3.32
(projectcalico/calico#13221).
Add the procedure to the OpenStack upgrade page: symptoms if skipped, preconditions (all nodes upgraded first; duplicate-pair cleanup), the docker invocation including TLS and username/password auth variants, completion output, idempotency, and verification.
The version-3.32 copy differs in using the standalone calico/kube-controllers image (the combined calico/calico image is v3.33+) and in noting that the mode requires v3.32.2 or later.