Update the CRD migration docs for DatastoreMigration v1 - #2888
Draft
caseydavenport wants to merge 3 commits into
Draft
Update the CRD migration docs for DatastoreMigration v1#2888caseydavenport wants to merge 3 commits into
caseydavenport wants to merge 3 commits into
Conversation
Bumps the example apiVersion and adds a note that an existing v1beta1 CRD has to be deleted first, since Kubernetes rejects dropping a version that's still in storedVersions.
Same v1 bump and delete-old-CRD note as crd-migration.mdx, plus the DatastoreMigration CRD path needs to point at manifests/ instead of the in-tree kube-controllers path, which is going away.
✅ 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. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Calico and Calico Enterprise CRD migration documentation to reflect the DatastoreMigration CRD/API moving to migration.projectcalico.org/v1, and aligns the on-prem/self-managed guide with the published CRD manifest location.
Changes:
- Update DatastoreMigration example resources to
apiVersion: migration.projectcalico.org/v1. - Add guidance about deleting an existing DatastoreMigration CRD when upgrading from earlier releases (due to
status.storedVersionsconstraints). - Fix the on-prem guide to reference the published DatastoreMigration CRD manifest instead of a kube-controllers source-tree path.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| calico/operations/crd-migration.mdx | Updates DatastoreMigration API version to v1 and adds upgrade note about storedVersions/CRD deletion. |
| calico/getting-started/kubernetes/self-managed-onprem/onpremises.mdx | Switches CRD install to published manifest URL, updates API version to v1, and adds the storedVersions/CRD deletion note. |
| calico-enterprise/operations/crd-migration.mdx | Mirrors the Calico doc updates for Enterprise: v1 apiVersion and CRD deletion note. |
|
|
||
| :::note | ||
|
|
||
| If you installed the DatastoreMigration CRD on an earlier release, delete it before applying this one: |
|
|
||
| :::note | ||
|
|
||
| If you installed the DatastoreMigration CRD on an earlier release, delete it before applying this one: |
|
|
||
| :::note | ||
|
|
||
| If you installed the DatastoreMigration CRD on an earlier release, delete it before applying this one: |
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 DatastoreMigration CRD is moving to
migration.projectcalico.org/v1on master (projectcalico/calico#13383). Bumps the example CR, and adds a note that an existing v1beta1 CRD has to be deleted first: Kubernetes rejects an update that drops a version still listed instoredVersions, sokubectl applyfails with a fairly confusing error otherwise. Deleting the CRD also deletes any DatastoreMigration resource, so the note calls that out too.Also fixes the second copy of the migration steps in
onpremises.mdx, which was still on v1beta1 and pointed at a CRD path inside the kube-controllers source tree. That path is going away, so it now uses the published manifest like the main page does.Versioned docs are untouched.
version-3.32correctly documents v1beta1, which is what that release serves.Related: CORE-12573