Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: docs for upgrades to include CRD upgrade notes and added upgrade notes that apply for v3.28+ #9546

Closed
wants to merge 1 commit into from

Conversation

venkatamutyala
Copy link

@venkatamutyala venkatamutyala commented Dec 2, 2024

Description

Documentation updates.

Artifacthub's README.md upgrade steps did not match what was on: https://docs.tigera.io/calico/latest/operations/upgrading/kubernetes-upgrade#all-other-upgrades this PR is to bring them into sync.

Related issues/PRs

N/A

Todos

  • Tests
  • Documentation
  • Release note

Release Note

Update docs to include upgrade instructions for CRDs and for v1.28+

Reminder for the reviewer

Make sure that this PR has the correct labels and milestone set.

Every PR needs one docs-* label.

  • docs-pr-required: This change requires a change to the documentation that has not been completed yet.
  • docs-completed: This change has all necessary documentation completed.
  • docs-not-required: This change has no user-facing impact and requires no docs.

Every PR needs one release-note-* label.

  • release-note-required: This PR has user-facing changes. Most PRs should have this label.
  • release-note-not-required: This PR has no user-facing changes.

Other optional labels:

  • cherry-pick-candidate: This PR should be cherry-picked to an earlier release. For bug fixes only.
  • needs-operator-pr: This PR is related to install and requires a corresponding change to the operator.

@venkatamutyala venkatamutyala requested a review from a team as a code owner December 2, 2024 22:25
@marvin-tigera marvin-tigera added this to the Calico v3.30.0 milestone Dec 2, 2024
@marvin-tigera marvin-tigera added release-note-required Change has user-facing impact (no matter how small) docs-pr-required Change is not yet documented labels Dec 2, 2024
@CLAassistant
Copy link

CLAassistant commented Dec 2, 2024

CLA assistant check
All committers have signed the CLA.

@venkatamutyala venkatamutyala changed the title fix: docs for upgrades to include CRD upgrade notes and added upgrade… fix: docs for upgrades to include CRD upgrade notes and added upgrade notes that apply for v3.28+ Dec 2, 2024
@@ -76,7 +86,13 @@ ownership of the helm resources to the new chart location.

## All other upgrades

1. Run the helm upgrade:
1. Upgrade CRDs:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's worth noting that as of just a few days ago, we merged a PR that removes the need for this step.

For reference: #9518

It moves management of these CRDs out of the helm chart and into our operator code, so that users won't need to perform this step 🎉

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will only take effect in Calico v3.30 though, so what you have here is appropriate for older versions.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How long until 3.30 is released? Would it make sense for me to break my PR into two different PRs? I suspect the note for v3.28+ will still apply after v3.30 is released?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@venkatamutyala yep, I think it makes sense to split into two PRs - the v3.28+ note still applies, but the CRD upgrade bits can be split out separately.

I think the CRD upgrade change should just be applied directly to older branches (release-v3.29, release-v3.28) instead of going through master.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just created:
#9557 - master
#9555 - release-v3.27
#9556 - release-v3.28

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this PR can be closed out now.

@caseydavenport caseydavenport self-assigned this Dec 2, 2024
@marvin-tigera marvin-tigera removed release-note-required Change has user-facing impact (no matter how small) docs-pr-required Change is not yet documented labels Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants