Skip to content

DOCS-3127: Document holding Typha when upgrading from CE 3.22 and OSS 3.31 - #3146

Open
ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3127-typha-hold
Open

ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3127-typha-hold

Conversation

@ctauchen

@ctauchen ctauchen commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Typha in CE 3.23 and OSS 3.32 rejects calico-node from earlier releases. This adds the steps to hold Typha during the upgrade, so calico-node rolls out node by node and non-cluster hosts stay connected.

Jira: https://tigera.atlassian.net/browse/DOCS-3127

Changes:

  • CE 3.23-2, 3.24-1, 3.24-2: new section on the operator, Helm and OpenShift upgrade pages
  • CE 3.23-2, 3.24-1, 3.24-2: upgrade note in the release notes
  • OSS 3.33: item on the upgrade notes page

Before merge:

  • @caseydavenport or @fasaxc to confirm the ignore annotation is supported for this procedure
  • Confirm the graceful restart tip, pending CI-2057
  • OSS steps were tested on CE only and need a 3.31 to 3.33 cluster run
  • Calico Cloud is out of scope until the installer question is answered

Preview:

The Helm and OpenShift upgrade pages carry the same section. 3.24-1 is not published, so its edits do not appear on the preview.

Copilot AI lite review requested due to automatic review settings October 21, 2026 10:19
@netlify

netlify Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit a3be832
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6ad8e9dc1701c3e6ddd6785d
😎 Deploy Preview https://deploy-preview-3146--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit a3be832
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6ad8e9dc9061116e8a00d9fc
😎 Deploy Preview https://deploy-preview-3146--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 95 (🔴 down 2 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Resolve the documented upgrade-path, cleanup, annotation-support, and release-note linking issues.

9 open issues
What changed in this PR

Adds Typha hold/release guidance for Calico Enterprise and OSS upgrades to prevent simultaneous calico-node disruption.

Changes:

  • Adds procedures for operator, Helm, and OpenShift upgrades.
  • Adds CE release-note warnings and links.
  • Adds OSS upgrade guidance.
File Summary Findings
calico-enterprise_versioned_docs/​version-3.24-2/​release-notes/​index.mdx Adds Typha upgrade warning. Moderate (1 vote): links only to the operator procedure.
calico-enterprise_versioned_docs/​version-3.24-2/​getting-started/​upgrading/​upgrading-enterprise/​openshift-upgrade.mdx Adds OpenShift hold procedure. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.24-2/​getting-started/​upgrading/​upgrading-enterprise/​kubernetes-upgrade-tsee/​operator.mdx Adds operator hold procedure. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.24-2/​getting-started/​upgrading/​upgrading-enterprise/​kubernetes-upgrade-tsee/​helm.mdx Adds Helm hold procedure. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.24-1/​release-notes/​index.mdx Adds Typha upgrade warning. Moderate (1 vote): links only to the operator procedure.
calico-enterprise_versioned_docs/​version-3.24-1/​getting-started/​upgrading/​upgrading-enterprise/​openshift-upgrade.mdx Adds OpenShift hold procedure. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.24-1/​getting-started/​upgrading/​upgrading-enterprise/​kubernetes-upgrade-tsee/​operator.mdx Adds operator hold procedure. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.24-1/​getting-started/​upgrading/​upgrading-enterprise/​kubernetes-upgrade-tsee/​helm.mdx Adds Helm hold procedure. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.23-2/​release-notes/​index.mdx Documents the Typha breaking change. Moderate (1 vote): links only to the operator procedure.
calico-enterprise_versioned_docs/​version-3.23-2/​getting-started/​upgrading/​upgrading-enterprise/​openshift-upgrade.mdx Adds OpenShift hold procedure. Moderate (1 vote): does not cover supported 3.21-to-3.23 upgrades. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.23-2/​getting-started/​upgrading/​upgrading-enterprise/​kubernetes-upgrade-tsee/​operator.mdx Adds operator hold procedure. Moderate (1 vote): does not cover supported 3.21-to-3.23 upgrades. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico-enterprise_versioned_docs/​version-3.23-2/​getting-started/​upgrading/​upgrading-enterprise/​kubernetes-upgrade-tsee/​helm.mdx Adds Helm hold procedure. Moderate (1 vote): does not cover supported 3.21-to-3.23 upgrades. Moderate (3 votes): cleanup is unconditional when no non-cluster hosts exist. Moderate (1 vote): unsupported ignore annotation requires confirmation or replacement.
calico_versioned_docs/​version-3.33/​operations/​upgrading/​upgrade-notes.mdx Adds OSS Typha upgrade guidance. —

Review effort: Lite

Comment on lines +89 to +92
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +98 to +101
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +101 to +104
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +91 to +94
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +98 to +101
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +101 to +104
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +91 to +94
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +98 to +101
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

Comment on lines +101 to +104
```bash
kubectl annotate deployment calico-typha -n calico-system unsupported.operator.tigera.io/ignore-
kubectl annotate deployment calico-typha-noncluster-host -n calico-system unsupported.operator.tigera.io/ignore-
```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in a3be832. The non-cluster host release command is now its own step, conditional on having held that Typha.

@ctauchen
ctauchen marked this pull request as ready for review October 21, 2026 16:23
@ctauchen
ctauchen requested a review from a team as a code owner October 21, 2026 16:23
@ctauchen

Copy link
Copy Markdown
Collaborator Author

Replies to the Copilot review summary items that have no inline thread:

  • 3.21 to 3.23 upgrades not covered: Done in a3be832. The 3.23 section and release note now say "3.22 or earlier", and Typha is held on its current version. The 3.24 pages keep "from 3.22", since 3.24 supports direct upgrades only from 3.23 and 3.22.
  • Release notes link only to the operator procedure: Done in a3be832. The release notes now link the section on the operator, Helm and OpenShift upgrade pages.
  • Unsupported ignore annotation needs confirmation: Won't do in this PR. This is already a merge blocker in the description, pending @caseydavenport or @fasaxc confirming the annotation is supported for this procedure. If they don't, the section goes back to a workaround with a warning.

Also fixed in a3be832, not raised by the review: the 3.24 pages said "A 3.23 calico-node can connect to a 3.22 Typha". It now reads "A newer calico-node can connect to an older Typha".

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.

2 participants