Repository navigation
[DOCS#CORE-13923]: Fix the BIRD probe edits for VXLAN-only manifests - #3177
Merged
Merged
Conversation
✅ 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.
🟢 Approval recommended
The reviewed documentation updates address the obsolete BIRD probe syntax and clarify VXLAN manifest usage across both affected versions, with no active review issues identified.
No open issues 🎉
What changed in this PR
Updates the Calico Open Source documentation for next and v3.33 to correct VXLAN-only manifest probe instructions and prevent BIRD health-check failures.
Changes:
- Replaces obsolete single-dash BIRD probe flags with the current double-dash syntax.
- Shows the resulting Felix-only probe configuration.
- Documents the older manifest syntax for scripted edits.
- Adds guidance for using
calico-vxlan.yaml, including itsCrossSubnetdefault.
| File | Description |
|---|---|
calico/getting-started/kubernetes/self-managed-onprem/config-options.mdx |
Updates the next-version VXLAN installation instructions and probe example. |
calico_versioned_docs/version-3.33/getting-started/kubernetes/self-managed-onprem/config-options.mdx |
Applies the equivalent corrections to the v3.33 documentation. |
Review effort: Lite
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.
Product Version(s):
Calico Open Source next and 3.33.
Issue:
Bug CORE-13923 (VXLAN probe crash-loop)
Link to docs preview:
getting-started/kubernetes/self-managed-onprem/config-options, "Switching from IP-in-IP to VXLAN" section, in next and 3.33.SME review:
DOCS review:
Additional information:
This PR fixes the VXLAN-only steps on the manifest install options page, which leave calico-node crash-looping on v3.33. Since PR 12225 (single calico binary), the probes run
calico component node healthwith double-dash flags, so the- -bird-readyand- -bird-livelines the page says to comment out no longer exist. Users leave the BIRD checks in, BIRD never starts, and every calico-node fails liveness and readiness.- --bird-liveand- --bird-readylines, and the YAML example shows the probes after the edit (Felix checks only) rather than the lines to remove. This also fixes the old example's misindented- -bird-readyline./bin/calico-nodewith single-dash flags, for anyone whose script matches the old form.calico-vxlan.yaml, which already setscalico_backend: "vxlan"and leaves BIRD out of the probes. It creates the default IP pool withCALICO_IPV4POOL_VXLANset to "CrossSubnet", so the tip says to change it to "Always" for VXLAN on all traffic.calico/(next) andversion-3.33/get the same edit, one commit each. The 3.31 and 3.32 manifests still use the single-dash form, so those pages are correct as is.make build-nextpasses with no broken links. Vale wasn't run locally; it runs in CI.Merge checklist:
Agent context
Decisions
/bin/calico-nodesingle-dash form, because a script matching- -bird-*silently does nothing against a v3.33 manifest. That is how the failure in Bug CORE-13923 (VXLAN probe crash-loop) was hit.$[manifestsUrl]/manifests/calico-vxlan.yamlas the no-edit path. On v3.33 the chart drops--bird-liveand--bird-readywhencalico_backendis "vxlan", but the manifest setsCALICO_IPV4POOL_VXLAN: CrossSubnet, notAlways, hence the note in the tip.calico/andcalico_versioned_docs/version-3.33/, since the repo README says bug fixes to released docs go in the matching versioned directory. Commit subjects follow the repo's "(next)" and "(3.33)" convention.Rejected alternatives
CALICO_NETWORKING_BACKENDisn't "bird", was discussed but kept out of this docs-only PR.Constraints and gotchas
/bin/calico-nodewith-bird-liveand-bird-ready.install-node.mdx(the "hard way" guide) also shows/bin/calico-node -bird-ready, but that page pinscalico/node:v3.20.0throughout, so updating only the probe would mismatch the image. Not touched.reference/configure-calico-node.mdxalready usescalico component node health --bird-ready; the ticket said it needed a change, but it doesn't.reference/component-resources/node/configuration.mdxpages also mention the BIRD flags. They're outside this OSS v3.33 ticket.Verification
git diff --quietshowed the twoconfig-options.mdxcopies were identical before the edit, so both get the same text.manifests/calico.yamlhas- --bird-liveand- --bird-ready; release-v3.32 has- -bird-liveand- -bird-ready. Release-v3.33manifests/calico-vxlan.yamlhascalico_backend: "vxlan",CALICO_IPV4POOL_VXLAN: CrossSubnet, and Felix-only probes.make build-next(next plus all released versions) exited 0 with[SUCCESS] Generated static files in "build".onBrokenLinksis "throw", so internal links on both edited pages resolve. Vale needs Docker and wasn't run locally.Code map
calico/getting-started/kubernetes/self-managed-onprem/config-options.mdx: "Switching from IP-in-IP to VXLAN" section; step text, probe YAML example, old-flag note, and thecalico-vxlan.yamltip.calico_versioned_docs/version-3.33/getting-started/kubernetes/self-managed-onprem/config-options.mdx: the same edit.Follow-ups
- -bird-*is being fixed separately, outside this repo.node/pkg/healthso the BIRD checks are skipped when BIRD isn't the networking backend. Not started.