Skip to content

DOCS-3080: Fix inaccuracies on the BGPFilter reference #3136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ctauchen merged 4 commits into from
Oct 21, 2026
Merged

DOCS-3080: Fix inaccuracies on the BGPFilter reference #3136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbc3f1d
Fix inaccuracies on the BGPFilter reference for next
ctauchen Oct 20, 2026
e29d40f
Fix inaccuracies on the BGPFilter reference for 3.33
ctauchen Oct 20, 2026
64d689b
Fix inaccuracies on the BGPFilter reference for 3.32
ctauchen Oct 20, 2026
dd58253
Fix inaccuracies on the BGPFilter reference for 3.31
ctauchen Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions calico/reference/resources/bgpfilter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`).
The BGPFilter rules are applied sequentially: the `action` for
the **first** rule that matches is executed immediately.
If an address does not match any explicit BGP filter rule,
the default action is `Accept`.
it is accepted on import. On export, it is advertised only if
Calico would advertise it to that peer without the filter.

In order for a BGPFilter to be used in a BGP peering, its `name`
must be added to `filters` of the corresponding BGPPeer resource.
Expand Down Expand Up @@ -61,7 +62,7 @@ spec:

| 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 |

### Spec

Expand All @@ -84,7 +85,8 @@ spec:
| `peerType` | Only apply this rule to routes from/to the specified BGP peer type. If empty, the rule applies to all peers. | `eBGP`, `iBGP` | string | |
| `priority` | Only apply this rule to routes with the given priority (metric). Uses the same units as the `...RoutePriority` fields in FelixConfiguration. | 1-2147483646 | integer | |
| `communities` | Only apply this rule to routes carrying the specified BGP community. | See [BGP Filter Community Match](#bgp-filter-community-match). | object | |
| `action` | Action to be taken for this rule | `Accept` or `Reject` | string | |
| `asPathPrefix` | Only apply this rule to routes whose AS path begins with the specified sequence of AS numbers. | A list of valid AS numbers. | list of integer | |
| `action` | Action to be taken for this rule. Required.| `Accept` or `Reject` | string | |
| `operations` | Ordered list of route modifications to apply when the rule matches. Only valid when action is `Accept`. Maximum 10 operations. | See [BGP Filter Operation](#bgp-filter-operation). | list | |

### BGP Filter Rule v6
Expand All @@ -106,14 +108,14 @@ spec:

| Field | Description | Accepted Values | Schema | Default |
| ------ | --------------------------------------------- | ------------------------------------------------------------------- | ------ | ------- |
| `min` | Smallest matched mask size (0 by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
| `max` | Largest matched mask size (32/128 by default) | Valid integers between 1 and ipv4/6 max (32, 128) | int | |
| `min` | Smallest matched mask size (the CIDR's mask size by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
| `max` | Largest matched mask size (32/128 by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |

### BGP Filter Community Match

| 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 |

### BGP Filter Operation

Expand All @@ -129,16 +131,16 @@ Each operation is an object with exactly one of the following fields set:

| Field | Description | Accepted Values | Schema |
| ----- | ---------------------------- | ---------------------------------------------------------- | ------ |
| `value` | BGP community value to add. | Standard (`aa:nn`) or large (`aa:nn:mm`) community value. | string |
| `value` | BGP community value to add. Required. | Standard (`aa:nn`) or large (`aa:nn:mm`) community value. | string |

### BGP Filter Prepend AS Path

| Field | Description | Accepted Values | Schema |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ---------------- |
| `prefix` | Sequence of AS numbers to prepend to the route's AS path. The resulting path starts with these AS numbers in the order listed (e.g., `[65000, 65001]` produces `65000 65001 <original>`). | A list of 1-10 valid AS numbers. | list of integer |
| `prefix` | Sequence of AS numbers to prepend to the route's AS path. Required. The resulting path starts with these AS numbers in the order listed (e.g., `[65000, 65001]` produces `65000 65001 <original>`). | A list of 1-10 valid AS numbers. | list of integer |

### BGP Filter Set Priority

| Field | Description | Accepted Values | Schema |
| ----- | ---------------------------------------------------------------------------------------------------------- | --------------- | ------- |
| `value` | The priority (metric) value to set on the route. Uses the same units as FelixConfiguration RoutePriority fields. | 1-2147483646 | integer |
| `value` | The priority (metric) value to set on the route. Required. Uses the same units as FelixConfiguration RoutePriority fields. | 1-2147483646 | integer |
15 changes: 8 additions & 7 deletions calico_versioned_docs/version-3.31/reference/resources/bgpfilter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
The BGPFilter rules are applied sequentially: the `action` for
the **first** rule that matches is executed immediately.
If an address does not match any explicit BGP filter rule,
the default action is `Accept`.
it is accepted on import. On export, it is advertised only if
Calico would advertise it to that peer without the filter.

In order for a BGPFilter to be used in a BGP peering, its `name`
must be added to `filters` of the corresponding BGPPeer resource.
Expand Down Expand Up @@ -61,7 +62,7 @@

| 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 |

### Spec

Expand All @@ -76,12 +77,12 @@

| Field | Description | Accepted Values | Schema | Default |
| ------------- | ------------------------------------------ | ------------------------------------------------------------------- | ------ | ------- |
| cidr | IPv6 range | A valid IPv6 CIDR | string | |
| cidr | IPv4 range | A valid IPv4 CIDR | string | |

Check warning on line 80 in calico_versioned_docs/version-3.31/reference/resources/bgpfilter.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'CIDR' instead of 'cidr'.

Raw Output:
{"message":"[Vale.Terms] Use 'CIDR' instead of 'cidr'.","location":{"path":"calico_versioned_docs/version-3.31/reference/resources/bgpfilter.mdx","range":{"start":{"line":80,"column":3},"end":{"line":80,"column":7}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| prefixLength | [PrefixLength](#bgp-filter-prefix-length) | Valid integers between 0 and ipv4/6 max (32, 128) | | |
| matchOperator | Method by which to match candidate routes | `In`, `NotIn`, `Equal`, `NotEqual` | string | |
| source | Indicator of the source of route | `RemotePeers` means any route learned from other BGP peers | string | |
| interface | String to match interface names | A valid pattern to match interfaces. "*" can be used as a wildcard. | string | |
| action | Action to be taken for this rule | `Accept` or `Reject` | string | |
| action | Action to be taken for this rule. Required.| `Accept` or `Reject` | string | |

### BGP Filter Rule v6

Expand All @@ -92,11 +93,11 @@
| matchOperator | Method by which to match candidate routes | `In`, `NotIn`, `Equal`, `NotEqual` | string | |
| source | Indicator of the source of route | `RemotePeers` means any route learned from other BGP peers | string | |
| interface | String to match interface names | A valid pattern to match interfaces. "*" can be used as a wildcard. | string | |
| action | Action to be taken for this rule | `Accept` or `Reject` | string | |
| action | Action to be taken for this rule. Required.| `Accept` or `Reject` | string | |

### BGP Filter Prefix Length

| Field | Description | Accepted Values | Schema | Default |
| ------ | --------------------------------------------- | ------------------------------------------------------------------- | ------ | ------- |
| min | Smallest matched mask size (0 by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
| max | Largest matched mask size (32/128 by default) | Valid integers between 1 and ipv4/6 max (32, 128) | int | |
| min | Smallest matched mask size (the CIDR's mask size by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
| max | Largest matched mask size (32/128 by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
17 changes: 9 additions & 8 deletions calico_versioned_docs/version-3.32/reference/resources/bgpfilter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`).
The BGPFilter rules are applied sequentially: the `action` for
the **first** rule that matches is executed immediately.
If an address does not match any explicit BGP filter rule,
the default action is `Accept`.
it is accepted on import. On export, it is advertised only if
Calico would advertise it to that peer without the filter.

In order for a BGPFilter to be used in a BGP peering, its `name`
must be added to `filters` of the corresponding BGPPeer resource.
Expand Down Expand Up @@ -61,7 +62,7 @@ spec:

| 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 |

### Spec

Expand Down Expand Up @@ -106,14 +107,14 @@ spec:

| Field | Description | Accepted Values | Schema | Default |
| ------ | --------------------------------------------- | ------------------------------------------------------------------- | ------ | ------- |
| `min` | Smallest matched mask size (0 by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
| `max` | Largest matched mask size (32/128 by default) | Valid integers between 1 and ipv4/6 max (32, 128) | int | |
| `min` | Smallest matched mask size (the CIDR's mask size by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
| `max` | Largest matched mask size (32/128 by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |

### BGP Filter Community Match

| 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 |

### BGP Filter Operation

Expand All @@ -129,16 +130,16 @@ Each operation is an object with exactly one of the following fields set:

| Field | Description | Accepted Values | Schema |
| ----- | ---------------------------- | ---------------------------------------------------------- | ------ |
| `value` | BGP community value to add. | Standard (`aa:nn`) or large (`aa:nn:mm`) community value. | string |
| `value` | BGP community value to add. Required. | Standard (`aa:nn`) or large (`aa:nn:mm`) community value. | string |

### BGP Filter Prepend AS Path

| Field | Description | Accepted Values | Schema |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ---------------- |
| `prefix` | Sequence of AS numbers to prepend to the route's AS path. The resulting path starts with these AS numbers in the order listed (e.g., `[65000, 65001]` produces `65000 65001 <original>`). | A list of 1-10 valid AS numbers. | list of integer |
| `prefix` | Sequence of AS numbers to prepend to the route's AS path. Required. The resulting path starts with these AS numbers in the order listed (e.g., `[65000, 65001]` produces `65000 65001 <original>`). | A list of 1-10 valid AS numbers. | list of integer |

### BGP Filter Set Priority

| Field | Description | Accepted Values | Schema |
| ----- | ---------------------------------------------------------------------------------------------------------- | --------------- | ------- |
| `value` | The priority (metric) value to set on the route. Uses the same units as FelixConfiguration RoutePriority fields. | 1-2147483646 | integer |
| `value` | The priority (metric) value to set on the route. Required. Uses the same units as FelixConfiguration RoutePriority fields. | 1-2147483646 | integer |
Loading
Loading