Repository navigation
DOCS-3080: Fix inaccuracies on the BGPFilter reference - #3136
Merged
Merged
Conversation
Correct statements on the BGPFilter page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPFilter page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPFilter page that a kind cluster running the release showed to be wrong.
Correct statements on the BGPFilter 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
The documentation incorrectly rejects accepted uppercase/underscore names and narrows community lists to exactly one value.
7 open issues
What changed in this PR
Updates Calico BGPFilter reference documentation to reflect observed behavior across current and versioned releases.
Changes:
- Clarifies import/export behavior and field defaults.
- Corrects validation rules and required fields.
- Updates IPv4 rule documentation for supported versions.
| File | Summary |
|---|---|
calico/reference/resources/bgpfilter.mdx |
Updates current BGPFilter behavior and schema details. |
calico_versioned_docs/version-3.33/reference/resources/bgpfilter.mdx |
Applies corrections for Calico 3.33. |
calico_versioned_docs/version-3.32/reference/resources/bgpfilter.mdx |
Applies corrections for Calico 3.32. |
calico_versioned_docs/version-3.31/reference/resources/bgpfilter.mdx |
Corrects 3.31 IPv4 and action documentation. |
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 | | ||
| | ------ | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------- | | ||
| | `values` | List of BGP community values to match against. The route must carry at least one of these communities. | Standard (`aa:nn`) or large (`aa:nn:mm`) community values. | list of string | | ||
| | `values` | List of BGP community values to match against. Required. Must contain exactly one value, which the route must carry. | Standard (`aa:nn`) or large (`aa:nn:mm`) community values. | list of 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 | | ||
| | ------ | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------- | | ||
| | `values` | List of BGP community values to match against. The route must carry at least one of these communities. | Standard (`aa:nn`) or large (`aa:nn:mm`) community values. | list of string | | ||
| | `values` | List of BGP community values to match against. Required. Must contain exactly one value, which the route must carry. | Standard (`aa:nn`) or large (`aa:nn:mm`) community values. | list of 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 | | ||
| | ------ | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------- | | ||
| | `values` | List of BGP community values to match against. The route must carry at least one of these communities. | Standard (`aa:nn`) or large (`aa:nn:mm`) community values. | list of string | | ||
| | `values` | List of BGP community values to match against. Required. Must contain exactly one value, which the route must carry. | Standard (`aa:nn`) or large (`aa:nn:mm`) community values. | list of 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 BGPFilter reference that a kind cluster running each release showed to be wrong.
_and uppercase letters.asPathPrefix, andactionis required (next and 3.33).mindefaults to the CIDR's mask size, not 0.maxaccepts 0.values,addCommunity.value,prependASPath.prefixandsetPriority.valueare required (next, 3.33 and 3.32).cidr, andactionis required in both rule tables.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:
asPathPrefixandactiongaps. IPv6 matching couldn't be shown on an IPv4-only lab.asPathPrefixrow isn't added, because 3.32 rejects AS numbers above 2147483647.maxbelow the CIDR's mask size, or belowmin, gives a range that matches no route. The API accepts it.Preview: