Repository navigation
DOCS-3079: Fix inaccuracies on the BGPConfiguration reference - #3134
Merged
Merged
Conversation
Correct statements on the BGPConfiguration page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPConfiguration page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPConfiguration page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPConfiguration page that a kind cluster running the release showed to be wrong.
✅ 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. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation corrections were fully reviewed with no unresolved blocking issues.
No open issues 🎉
What changed in this PR
Updates BGPConfiguration reference documentation for current Calico and versions 3.31–3.33.
Changes:
- Corrects field behavior, validation, defaults, and descriptions.
- Documents version-specific AS number and route-programming behavior.
- Adds load balancer aggregation and IPv4/IPv6 CIDR details.
| File | Description |
|---|---|
calico/reference/resources/bgpconfig.mdx |
Updates current reference documentation. |
calico_versioned_docs/version-3.33/reference/resources/bgpconfig.mdx |
Updates the 3.33 reference. |
calico_versioned_docs/version-3.32/reference/resources/bgpconfig.mdx |
Updates the 3.32 reference. |
calico_versioned_docs/version-3.31/reference/resources/bgpconfig.mdx |
Updates the 3.31 reference. |
Review effort: Lite
Collaborator
Author
|
LGTM |
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 BGPConfiguration reference that a kind cluster running each release showed to be wrong.
_and uppercase letters.node.<nodename>BGPConfiguration with the Kubernetes datastore.logSeverityScreenalso acceptsTrace.nodeToNodeMeshEnabledis a boolean, not a string.asNumberstrings and dotted notation work through calicoctl or the API server, but not with kubectl on native v3 CRDs (next and 3.33 only).serviceLoadBalancerAggregation.bindModemakes the operator restart calico-node. No manual restart is needed.programClusterRouteshad the wrong values, default and description (values and default in next and 3.33, description in 3.32; the field doesn't exist in 3.31).prefixAdvertisementscidrtakes IPv4 or IPv6.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.
Not changed, for follow-up:
[parse-duration]link has no reference definition, so it renders as literal text. A rendering bug a cluster can't show.asNumberchange isn't applied: the old text is right in API server mode, the 3.32 default. The schema also rejects AS numbers above 2147483647 in 3.32, so "A valid AS Number" may need a range on this page and on BGPPeer. 3.33 wasn't tested for this.Preview: