Skip to content

DOCS-3083: Fix the CalicoNodeStatus resource reference #3182

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 5 commits into from
Nov 4, 2026
Merged

DOCS-3083: Fix the CalicoNodeStatus resource reference #3182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
36d9be2
DOCS-3083: Fix CalicoNodeStatus name rule
ctauchen Nov 4, 2026
c0889c2
DOCS-3083: Fix CalicoNodeStatus status fields in next
ctauchen Nov 4, 2026
bd23ba0
DOCS-3083: Fix CalicoNodeStatus status fields in 3.33
ctauchen Nov 4, 2026
203b9bb
DOCS-3083: Fix CalicoNodeStatus status fields in 3.32
ctauchen Nov 4, 2026
e823440
DOCS-3083: Fix CalicoNodeStatus status fields in 3.31
ctauchen Nov 4, 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
15 changes: 7 additions & 8 deletions calico/reference/resources/caliconodestatus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: |
{"apiVersion":"crd.projectcalico.org/v1","kind":"CalicoNodeStatus","metadata":{"annotations":{},"name":"my-caliconodestatus-1"},"spec":{"classes":["Agent","BGP","Routes"],"node":"my-kadm-node-0","updatePeriodSeconds":10}}
projectcalico.org/metadata: '{"uid":"6e3b676b-546a-41db-aeda-ad44f25ff73f","generation":2,"creationTimestamp":"2021-10-18T10:30:43Z","managedFields":[{"manager":"kubectl-client-side-apply","operation":"Update","apiVersion":"projectcalico.org/v3","time":"2021-10-18T10:30:43Z","fieldsType":"FieldsV1","fieldsV1":{"f:metadata":{"f:annotations":{".":{},"f:kubectl.kubernetes.io/last-applied-configuration":{}}},"f:spec":{".":{},"f:node":{},"f:updatePeriodSeconds":{}}}},{"manager":"kubectl-edit","operation":"Update","apiVersion":"crd.projectcalico.org/v1","time":"2021-10-18T12:59:25Z","fieldsType":"FieldsV1","fieldsV1":{"f:spec":{"f:classes":{}}}}]}'
{"apiVersion":"projectcalico.org/v3","kind":"CalicoNodeStatus","metadata":{"annotations":{},"name":"my-caliconodestatus-1"},"spec":{"classes":["Agent","BGP","Routes"],"node":"my-kadm-node-0","updatePeriodSeconds":10}}
creationTimestamp: '2021-10-18T10:30:43Z'
generation: 139
name: my-caliconodestatus-1
Expand Down Expand Up @@ -136,7 +135,7 @@

| Field | Description | Accepted Values | Schema |
| ----- | ----------------------------------------------------- | --------------------------------------------------- | ------ |
| name | The name of this CalicoNodeStatus resource. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string |
| name | The name of this CalicoNodeStatus resource. Required. | Lowercase alphanumeric string with optional `.` or `-`. | string |

### Spec

Expand All @@ -151,9 +150,9 @@
| Field | Description | Values |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| lastUpdated | Timestamp representing the server time when the CalicoNodeStatus object last updated. It is represented in RFC3339 form and is in UTC. |
| agent | List of [BGP daemon status](#bgpdaemonstatus) on the node. | 'birdV4' holds status of IPv4 bird daemon, 'birdV6' holds status of IPv6 bird daemon |
| bgp | List of [BGP status](#bgpstatus) on the node. | 'peersV4' holds status of IPv4 BGP peers, 'peersV6' holds status of IPv6 BGP peers |
| routes | List of [Route status](#routestatus) learned by BGP daemon on the node. | 'routesV4' holds status of IPv4 routes , 'routesV6' holds status of IPv6 routes |
| agent | [BGP daemon status](#bgpdaemonstatus) on the node. | 'birdV4' holds status of IPv4 bird daemon, 'birdV6' holds status of IPv6 bird daemon |
| bgp | [BGP status](#bgpstatus) on the node. | 'peersV4' holds status of IPv4 BGP peers, 'peersV6' holds status of IPv6 BGP peers |

Check warning on line 154 in calico/reference/resources/caliconodestatus.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'BGP' instead of 'bgp'.

Raw Output:
{"message":"[Vale.Terms] Use 'BGP' instead of 'bgp'.","location":{"path":"calico/reference/resources/caliconodestatus.mdx","range":{"start":{"line":154,"column":3},"end":{"line":154,"column":6}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| routes | [Route status](#routestatus) learned by BGP daemon on the node. | 'routesV4' holds status of IPv4 routes , 'routesV6' holds status of IPv6 routes |

### Classes

Expand Down Expand Up @@ -205,7 +204,7 @@
| Field | Description | Schema | Possible Values |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------- |
| type | Type indicates if the route is being used for forwarding or not. | string | FIB, RIB |
| destination | Destination IP of the route. | `ip` | |
| destination | Destination CIDR of the route. | `cidr` | |
| gateway | Gateway IP of the route. If the route does not involve a gateway, for example a direct route, the value is `N/A`. | `ip` or `N/A` | |
| interface | Network interface for the destination. For a blackhole route, the value is `blackhole`. For a unreachable route, the value is `unreachable`. | string | |
| learnedFrom | Information regarding where this route originated. | [learned from](#learnedfrom) | |
Expand All @@ -215,4 +214,4 @@
| Field | Description | Schema | Possible Values |
| ---------- | --------------------------------------------------------------------------------------- | ------ | ----------------------------------------- |
| sourceType | Type of the source where a route is learned from. | string | Kernel, Static, Direct, NodeMesh, BGPPeer |
| peerIP | If sourceType is NodeMesh or BGPPeer, IP address of the router that sent us this route. | `ip` | |
| peerIP | If sourceType is NodeMesh or BGPPeer, IP address of the router that sent us this route. For a BGPPeer session with a port set, in `peerIP` or through a BGPConfiguration `listenPort`, the value also contains the port, for example `10.0.0.1.port.1790`. | string | |

Check failure on line 217 in calico/reference/resources/caliconodestatus.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] 'sourceType' looks like code; format it as code.

Raw Output:
{"message":"[Vale.Spelling] 'sourceType' looks like code; format it as code.","location":{"path":"calico/reference/resources/caliconodestatus.mdx","range":{"start":{"line":217,"column":19},"end":{"line":217,"column":29}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
15 changes: 7 additions & 8 deletions calico_versioned_docs/version-3.31/reference/resources/caliconodestatus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: |
{"apiVersion":"crd.projectcalico.org/v1","kind":"CalicoNodeStatus","metadata":{"annotations":{},"name":"my-caliconodestatus-1"},"spec":{"classes":["Agent","BGP","Routes"],"node":"my-kadm-node-0","updatePeriodSeconds":10}}
projectcalico.org/metadata: '{"uid":"6e3b676b-546a-41db-aeda-ad44f25ff73f","generation":2,"creationTimestamp":"2021-10-18T10:30:43Z","managedFields":[{"manager":"kubectl-client-side-apply","operation":"Update","apiVersion":"projectcalico.org/v3","time":"2021-10-18T10:30:43Z","fieldsType":"FieldsV1","fieldsV1":{"f:metadata":{"f:annotations":{".":{},"f:kubectl.kubernetes.io/last-applied-configuration":{}}},"f:spec":{".":{},"f:node":{},"f:updatePeriodSeconds":{}}}},{"manager":"kubectl-edit","operation":"Update","apiVersion":"crd.projectcalico.org/v1","time":"2021-10-18T12:59:25Z","fieldsType":"FieldsV1","fieldsV1":{"f:spec":{"f:classes":{}}}}]}'
{"apiVersion":"projectcalico.org/v3","kind":"CalicoNodeStatus","metadata":{"annotations":{},"name":"my-caliconodestatus-1"},"spec":{"classes":["Agent","BGP","Routes"],"node":"my-kadm-node-0","updatePeriodSeconds":10}}
creationTimestamp: '2021-10-18T10:30:43Z'
generation: 139
name: my-caliconodestatus-1
Expand Down Expand Up @@ -136,7 +135,7 @@

| Field | Description | Accepted Values | Schema |
| ----- | ----------------------------------------------------- | --------------------------------------------------- | ------ |
| name | The name of this CalicoNodeStatus resource. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string |
| name | The name of this CalicoNodeStatus resource. Required. | Lowercase alphanumeric string with optional `.` or `-`. | string |

### Spec

Expand All @@ -151,9 +150,9 @@
| Field | Description | Values |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| lastUpdated | Timestamp representing the server time when the CalicoNodeStatus object last updated. It is represented in RFC3339 form and is in UTC. |
| agent | List of [BGP daemon status](#bgpdaemonstatus) on the node. | 'birdV4' holds status of IPv4 bird daemon, 'birdV6' holds status of IPv6 bird daemon |
| bgp | List of [BGP status](#bgpstatus) on the node. | 'peersV4' holds status of IPv4 BGP peers, 'peersV6' holds status of IPv6 BGP peers |
| routes | List of [Route status](#routestatus) learned by BGP daemon on the node. | 'routesV4' holds status of IPv4 routes , 'routesV6' holds status of IPv6 routes |
| agent | [BGP daemon status](#bgpdaemonstatus) on the node. | 'birdV4' holds status of IPv4 bird daemon, 'birdV6' holds status of IPv6 bird daemon |
| bgp | [BGP status](#bgpstatus) on the node. | 'peersV4' holds status of IPv4 BGP peers, 'peersV6' holds status of IPv6 BGP peers |

Check warning on line 154 in calico_versioned_docs/version-3.31/reference/resources/caliconodestatus.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'BGP' instead of 'bgp'.

Raw Output:
{"message":"[Vale.Terms] Use 'BGP' instead of 'bgp'.","location":{"path":"calico_versioned_docs/version-3.31/reference/resources/caliconodestatus.mdx","range":{"start":{"line":154,"column":3},"end":{"line":154,"column":6}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| routes | [Route status](#routestatus) learned by BGP daemon on the node. | 'routesV4' holds status of IPv4 routes , 'routesV6' holds status of IPv6 routes |

### Classes

Expand Down Expand Up @@ -205,7 +204,7 @@
| Field | Description | Schema | Possible Values |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------- |
| type | Type indicates if the route is being used for forwarding or not. | string | FIB, RIB |
| destination | Destination IP of the route. | `ip` | |
| destination | Destination CIDR of the route. | `cidr` | |
| gateway | Gateway IP of the route. If the route does not involve a gateway, for example a direct route, the value is `N/A`. | `ip` or `N/A` | |
| interface | Network interface for the destination. For a blackhole route, the value is `blackhole`. For a unreachable route, the value is `unreachable`. | string | |
| learnedFrom | Information regarding where this route originated. | [learned from](#learnedfrom) | |
Expand All @@ -215,4 +214,4 @@
| Field | Description | Schema | Possible Values |
| ---------- | --------------------------------------------------------------------------------------- | ------ | ----------------------------------------- |
| sourceType | Type of the source where a route is learned from. | string | Kernel, Static, Direct, NodeMesh, BGPPeer |
| peerIP | If sourceType is NodeMesh or BGPPeer, IP address of the router that sent us this route. | `ip` | |
| peerIP | If sourceType is NodeMesh or BGPPeer, IP address of the router that sent us this route. For a BGPPeer session with a port set, in `peerIP` or through a BGPConfiguration `listenPort`, the value also contains the port, for example `10.0.0.1.port.1790`. | string | |

Check failure on line 217 in calico_versioned_docs/version-3.31/reference/resources/caliconodestatus.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] 'sourceType' looks like code; format it as code.

Raw Output:
{"message":"[Vale.Spelling] 'sourceType' looks like code; format it as code.","location":{"path":"calico_versioned_docs/version-3.31/reference/resources/caliconodestatus.mdx","range":{"start":{"line":217,"column":19},"end":{"line":217,"column":29}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
15 changes: 7 additions & 8 deletions calico_versioned_docs/version-3.32/reference/resources/caliconodestatus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: |
{"apiVersion":"crd.projectcalico.org/v1","kind":"CalicoNodeStatus","metadata":{"annotations":{},"name":"my-caliconodestatus-1"},"spec":{"classes":["Agent","BGP","Routes"],"node":"my-kadm-node-0","updatePeriodSeconds":10}}
projectcalico.org/metadata: '{"uid":"6e3b676b-546a-41db-aeda-ad44f25ff73f","generation":2,"creationTimestamp":"2021-10-18T10:30:43Z","managedFields":[{"manager":"kubectl-client-side-apply","operation":"Update","apiVersion":"projectcalico.org/v3","time":"2021-10-18T10:30:43Z","fieldsType":"FieldsV1","fieldsV1":{"f:metadata":{"f:annotations":{".":{},"f:kubectl.kubernetes.io/last-applied-configuration":{}}},"f:spec":{".":{},"f:node":{},"f:updatePeriodSeconds":{}}}},{"manager":"kubectl-edit","operation":"Update","apiVersion":"crd.projectcalico.org/v1","time":"2021-10-18T12:59:25Z","fieldsType":"FieldsV1","fieldsV1":{"f:spec":{"f:classes":{}}}}]}'
{"apiVersion":"projectcalico.org/v3","kind":"CalicoNodeStatus","metadata":{"annotations":{},"name":"my-caliconodestatus-1"},"spec":{"classes":["Agent","BGP","Routes"],"node":"my-kadm-node-0","updatePeriodSeconds":10}}
creationTimestamp: '2021-10-18T10:30:43Z'
generation: 139
name: my-caliconodestatus-1
Expand Down Expand Up @@ -136,7 +135,7 @@

| Field | Description | Accepted Values | Schema |
| ----- | ----------------------------------------------------- | --------------------------------------------------- | ------ |
| name | The name of this CalicoNodeStatus resource. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string |
| name | The name of this CalicoNodeStatus resource. Required. | Lowercase alphanumeric string with optional `.` or `-`. | string |

### Spec

Expand All @@ -151,9 +150,9 @@
| Field | Description | Values |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| lastUpdated | Timestamp representing the server time when the CalicoNodeStatus object last updated. It is represented in RFC3339 form and is in UTC. |
| agent | List of [BGP daemon status](#bgpdaemonstatus) on the node. | 'birdV4' holds status of IPv4 bird daemon, 'birdV6' holds status of IPv6 bird daemon |
| bgp | List of [BGP status](#bgpstatus) on the node. | 'peersV4' holds status of IPv4 BGP peers, 'peersV6' holds status of IPv6 BGP peers |
| routes | List of [Route status](#routestatus) learned by BGP daemon on the node. | 'routesV4' holds status of IPv4 routes , 'routesV6' holds status of IPv6 routes |
| agent | [BGP daemon status](#bgpdaemonstatus) on the node. | 'birdV4' holds status of IPv4 bird daemon, 'birdV6' holds status of IPv6 bird daemon |
| bgp | [BGP status](#bgpstatus) on the node. | 'peersV4' holds status of IPv4 BGP peers, 'peersV6' holds status of IPv6 BGP peers |

Check warning on line 154 in calico_versioned_docs/version-3.32/reference/resources/caliconodestatus.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'BGP' instead of 'bgp'.

Raw Output:
{"message":"[Vale.Terms] Use 'BGP' instead of 'bgp'.","location":{"path":"calico_versioned_docs/version-3.32/reference/resources/caliconodestatus.mdx","range":{"start":{"line":154,"column":3},"end":{"line":154,"column":6}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| routes | [Route status](#routestatus) learned by BGP daemon on the node. | 'routesV4' holds status of IPv4 routes , 'routesV6' holds status of IPv6 routes |

### Classes

Expand Down Expand Up @@ -205,7 +204,7 @@
| Field | Description | Schema | Possible Values |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------- |
| type | Type indicates if the route is being used for forwarding or not. | string | FIB, RIB |
| destination | Destination IP of the route. | `ip` | |
| destination | Destination CIDR of the route. | `cidr` | |
| gateway | Gateway IP of the route. If the route does not involve a gateway, for example a direct route, the value is `N/A`. | `ip` or `N/A` | |
| interface | Network interface for the destination. For a blackhole route, the value is `blackhole`. For a unreachable route, the value is `unreachable`. | string | |
| learnedFrom | Information regarding where this route originated. | [learned from](#learnedfrom) | |
Expand All @@ -215,4 +214,4 @@
| Field | Description | Schema | Possible Values |
| ---------- | --------------------------------------------------------------------------------------- | ------ | ----------------------------------------- |
| sourceType | Type of the source where a route is learned from. | string | Kernel, Static, Direct, NodeMesh, BGPPeer |
| peerIP | If sourceType is NodeMesh or BGPPeer, IP address of the router that sent us this route. | `ip` | |
| peerIP | If sourceType is NodeMesh or BGPPeer, IP address of the router that sent us this route. For a BGPPeer session with a port set, in `peerIP` or through a BGPConfiguration `listenPort`, the value also contains the port, for example `10.0.0.1.port.1790`. | string | |

Check failure on line 217 in calico_versioned_docs/version-3.32/reference/resources/caliconodestatus.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] 'sourceType' looks like code; format it as code.

Raw Output:
{"message":"[Vale.Spelling] 'sourceType' looks like code; format it as code.","location":{"path":"calico_versioned_docs/version-3.32/reference/resources/caliconodestatus.mdx","range":{"start":{"line":217,"column":19},"end":{"line":217,"column":29}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
Loading
Loading