Repository navigation
DOCS-3081: Fix inaccuracies on the BGPPeer reference - #3135
Merged
Merged
Conversation
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.
✅ 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.
🟡 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
keepaliveTimewhere supported. - Documents
nextHopModeincompatibility withkeepOriginalNextHop: 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 | |
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.


Fixes statements on the BGPPeer reference that a kind cluster running each release showed to be wrong.
_and uppercase letters.asNumberandlocalASNumberstrings and dotted notation work through calicoctl or the API server, but not with kubectl on native v3 CRDs (next and 3.33 only).keepaliveTime(next, 3.33 and 3.32; the field doesn't exist in 3.31).nextHopModecan't be set together withkeepOriginalNextHop: 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:
optional, which Calico ignores. Markingkeyrequired 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."nodetakes the Calico node name, not the hostname. kind can't tell these apart.asNumberandnextHopModechanges aren't applied. The 3.32 schema rejects AS numbers above 2147483647, and with kubectl on native v3 CRDs, combiningnextHopModewithkeepOriginalNextHopdrops the whole peer.Preview: