Repository navigation
[DOCS#CORE-13917]: Tell users to upgrade Forklift after upgrading Calico Enterprise - #3176
Conversation
…ico Enterprise Forklift installed from the Calico Enterprise docs is not touched by a Calico Enterprise upgrade, so users kept running the old release. Each Enterprise upgrade page now ends with a step pointing them to the Forklift install page to install the latest version. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
✅ 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. |
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain, with the Forklift guidance added across the current and versioned upgrade documentation.
No open issues 🎉
What changed in this PR
Adds post-upgrade guidance reminding Calico Enterprise users to update Forklift separately after upgrading Enterprise.
Changes:
- Added an “Upgrade Forklift” section to Kubernetes operator, Helm, and OpenShift upgrade guides.
- Linked each section to the appropriate Forklift installation guide.
- Applied the updates to both current documentation and version 3.24-2.
| File | Description |
|---|---|
calico-enterprise/getting-started/upgrading/upgrading-enterprise/openshift-upgrade.mdx |
Adds OpenShift Forklift upgrade guidance. |
calico-enterprise/getting-started/upgrading/upgrading-enterprise/kubernetes-upgrade-tsee/operator.mdx |
Adds operator-based Kubernetes Forklift upgrade guidance. |
calico-enterprise/getting-started/upgrading/upgrading-enterprise/kubernetes-upgrade-tsee/helm.mdx |
Adds Helm-based Kubernetes Forklift upgrade guidance. |
calico-enterprise_versioned_docs/version-3.24-2/getting-started/upgrading/upgrading-enterprise/openshift-upgrade.mdx |
Applies the OpenShift guidance to version 3.24-2. |
calico-enterprise_versioned_docs/version-3.24-2/getting-started/upgrading/upgrading-enterprise/kubernetes-upgrade-tsee/operator.mdx |
Applies the operator-based Kubernetes guidance to version 3.24-2. |
calico-enterprise_versioned_docs/version-3.24-2/getting-started/upgrading/upgrading-enterprise/kubernetes-upgrade-tsee/helm.mdx |
Applies the Helm-based Kubernetes guidance to version 3.24-2. |
Review effort: Lite
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
lwr20
left a comment
lwr20
left a comment
There was a problem hiding this comment.
Looks good to me, and the links work in both the unversioned and 3.24-2 trees. Two small wording things inline. "Latest" is a bit misleading since the Forklift page installs the version that matches the docs, and the heading doesn't match the page style.
|
|
||
| ## Upgrade VM and L2-Specific Components | ||
|
|
||
| If you have VM-specific components installed such as the $[prodname] fork of Forklift, upgrading $[prodname] does not upgrade them. After the upgrade, install the latest version of Forklift by following [Install Forklift on Kubernetes](../../../../networking/kubevirt/install-forklift-kubernetes.mdx). |
There was a problem hiding this comment.
The Forklift manifests come from $[filesUrl], so the linked page installs the version that matches these docs, not the latest one. Can we say "install the matching version of Forklift" so nobody goes and grabs a newer docs version's manifests? Same on the other five pages.
There was a problem hiding this comment.
I think this one got missed. All six pages still say "install the latest version of Forklift". Can we change it to "the matching version"? Not a blocker if you'd rather leave it.
|
|
||
| </Tabs> | ||
|
|
||
| ## Upgrade VM and L2-Specific Components |
There was a problem hiding this comment.
The other headings on these pages are sentence case, and nothing L2-specific is listed under this one. Maybe just "Upgrade Forklift"?
There was a problem hiding this comment.
Will fix case, and will remove the reference to L2.
I had it as "Upgrade Forklift" before, but I feel that line makes it seem like a mandatory step - most users don't know what Forklift is, and it's not part of most upgrades, so I wanted something broader that tries to say "Upgrade things related to feature X" - saving them the need to investigate what Forklift is before deciding if they have it or not
There was a problem hiding this comment.
That makes sense, "VM-specific components" works for me.
|
LGTM |
Product Version(s):
Calico Enterprise 3.24 (unversioned pages and version-3.24-2).
Issue:
https://tigera.atlassian.net/browse/CORE-13917
Link to docs preview:
The new "Upgrade Forklift" section at the end of:
getting-started/upgrading/upgrading-enterprise/kubernetes-upgrade-tsee/operatorgetting-started/upgrading/upgrading-enterprise/kubernetes-upgrade-tsee/helmgetting-started/upgrading/upgrading-enterprise/openshift-upgradeSME review:
DOCS review:
Additional information:
Forklift is installed from its own manifests, so upgrading Calico Enterprise leaves it on the old release, and nothing tells users it is out of date. Each Enterprise upgrade page now ends with one line telling users who installed Forklift from these docs to install the latest version from the Forklift install page after the upgrade.
Re-running the install steps upgrades Forklift in place. In CORE-13917, re-applying the newer manifests over an older install rolled every component and left existing Providers, Plans and Maps alone.
3.24-2 is the only released version with Forklift docs, so no other versions are changed.
Merge checklist:
🤖 Generated with Claude Code