Skip to content

DOCS-3081: Fix inaccuracies on the BGPPeer reference - #3135

Merged
ctauchen merged 4 commits into
tigera:mainfrom
ctauchen:DOCS-3081-fact-check-bgppeer
Oct 21, 2026
Merged

ctauchen merged 4 commits into
tigera:mainfrom
ctauchen:DOCS-3081-fact-check-bgppeer

Conversation

@ctauchen

@ctauchen ctauchen commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes statements on the BGPPeer reference that a kind cluster running each release showed to be wrong.

  • The name rule allowed _ and uppercase letters.
  • asNumber and localASNumber strings and dotted notation work through calicoctl or the API server, but not with kubectl on native v3 CRDs (next and 3.33 only).
  • The Spec table was missing keepaliveTime (next, 3.33 and 3.32; the field doesn't exist in 3.31).
  • nextHopMode can't be set together with keepOriginalNextHop: true. The page said the old field is ignored (next, 3.33 and 3.31).

Reproduced on v3.33.0 for next and 3.33 (native v3 CRD and API server mode), v3.32.2 for 3.32, and v3.31.7 for 3.31. The selector bracketing example in the shared selectors partial is fixed in the NetworkPolicy fact-check PR.

Not changed, for follow-up:

  • The KeyRef table doesn't list optional, which Calico ignores. Marking key required is right only for kubectl on native v3 CRDs. Elsewhere a missing key is accepted and the peering silently gets no password. Suggested wording: "If omitted, no password is configured."
  • If calico-node can't read the password secret or key, it logs a warning and peers without a password. The page doesn't say so.
  • node takes the Calico node name, not the hostname. kind can't tell these apart.
  • In 3.32, the asNumber and nextHopMode changes aren't applied. The 3.32 schema rejects AS numbers above 2147483647, and with kubectl on native v3 CRDs, combining nextHopMode with keepOriginalNextHop drops the whole peer.

Preview:

Correct statements on the BGPPeer page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPPeer page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPPeer page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPPeer page that a kind cluster running the release showed to be wrong.
Copilot AI lite review requested due to automatic review settings October 20, 2026 06:57
@netlify

netlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit b358920
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6ad710c9c3f0994dd5f3bec1
😎 Deploy Preview https://deploy-preview-3135--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: 90 (🟢 up 16 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.

@netlify

netlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

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

Name Link
🔨 Latest commit b358920
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6ad710c9caacc4720af75629
😎 Deploy Preview https://deploy-preview-3135--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.

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

Correct the name-rule wording in all four references to retain valid uppercase letters and underscores.

4 open issues
What changed in this PR

Updates BGPPeer reference documentation to correct version-specific behavior across Calico releases.

Changes:

  • Clarifies AS-number handling.
  • Adds keepaliveTime where supported.
  • Documents nextHopMode incompatibility with keepOriginalNextHop: true.
  • Updates naming guidance.
File Summary
calico/​reference/​resources/​bgppeer.mdx Updates current BGPPeer reference; name-rule wording still excludes valid uppercase and _ characters.
calico_versioned_docs/​version-3.33/​reference/​resources/​bgppeer.mdx Updates v3.33 reference; name-rule wording still excludes valid uppercase and _ characters.
calico_versioned_docs/​version-3.32/​reference/​resources/​bgppeer.mdx Adds keepaliveTime and updates v3.32 guidance; name-rule wording still excludes valid uppercase and _ characters.
calico_versioned_docs/​version-3.31/​reference/​resources/​bgppeer.mdx Updates v3.31 guidance; name-rule wording still excludes valid uppercase and _ characters.

Review effort: Lite

| Field | Description | Accepted Values | Schema |
| ----- | ------------------------------------------------------------------ | --------------------------------------------------- | ------ |
| name | Unique name to describe this resource instance. Must be specified. | Alphanumeric string with optional `.`, `_`, or `-`. | string |
| name | Unique name to describe this resource instance. Must be specified. | Lowercase alphanumeric string with optional `.` or `-`. | string |
| Field | Description | Accepted Values | Schema |
| ----- | ------------------------------------------------------------------ | --------------------------------------------------- | ------ |
| name | Unique name to describe this resource instance. Must be specified. | Alphanumeric string with optional `.`, `_`, or `-`. | string |
| name | Unique name to describe this resource instance. Must be specified. | Lowercase alphanumeric string with optional `.` or `-`. | string |
| Field | Description | Accepted Values | Schema |
| ----- | ------------------------------------------------------------------ | --------------------------------------------------- | ------ |
| name | Unique name to describe this resource instance. Must be specified. | Alphanumeric string with optional `.`, `_`, or `-`. | string |
| name | Unique name to describe this resource instance. Must be specified. | Lowercase alphanumeric string with optional `.` or `-`. | string |
| Field | Description | Accepted Values | Schema |
| ----- | ------------------------------------------------------------------ | --------------------------------------------------- | ------ |
| name | Unique name to describe this resource instance. Must be specified. | Alphanumeric string with optional `.`, `_`, or `-`. | string |
| name | Unique name to describe this resource instance. Must be specified. | Lowercase alphanumeric string with optional `.` or `-`. | string |

@ctauchen ctauchen left a comment

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.

LGTM

@ctauchen
ctauchen marked this pull request as ready for review October 21, 2026 16:22
@ctauchen
ctauchen requested a review from a team as a code owner October 21, 2026 16:22
@ctauchen
ctauchen merged commit 0c87ff0 into tigera:main Oct 21, 2026
11 checks passed
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