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.

Sign up for GitHub

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
Closed

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion charts/tigera-operator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ of the chart into the `tigera-operator` namespace.
When upgrading from a version of Calico v3.22 or lower to a version of Calico v3.23 or greater, you must complete the following steps to migrate
ownership of the helm resources to the new chart location.

## Upgrade OwnerReferences

If you do not use OwnerReferences on resources in the projectcalico.org/v3 API group, you can skip this section.

Starting in Calico v3.28, a change in the way UIDs are generated for projectcalico.org/v3 resources requires that you update any OwnerReferences that refer to projectcalico.org/v3 resources as an owner. After upgrade, the UID for all projectcalico.org/v3 resources will be changed, resulting in any owned resources being garbage collected by Kubernetes.

Remove any OwnerReferences from resources in your cluster that have apiGroup: projectcalico.org/v3.
Perform the upgrade normally.
Add new OwnerReferences to your resources referencing the new UID.

## Upgrade from Calico versions prior to v3.23.0

1. Patch existing resources so that the new chart can assume ownership.
Expand Down Expand Up @@ -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.


```bash
kubectl apply --server-side --force-conflicts -f https://raw.githubusercontent.com/projectcalico/calico/{{site.data.versions[0].title}}/manifests/operator-crds.yaml
```

2. Run the helm upgrade:

```bash
helm upgrade {{site.prodname | downcase}} projectcalico/tigera-operator
Expand Down