Skip to content

DOCS-3082: Fix inaccuracies on the BlockAffinity reference #3127

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 19, 2026
Merged

DOCS-3082: Fix inaccuracies on the BlockAffinity reference #3127

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
a95e0b1
Fix BlockAffinity name and spec field text (next)
ctauchen Oct 16, 2026
012e63f
Fix BlockAffinity name and spec field text (3.33)
ctauchen Oct 16, 2026
dc1d677
Fix BlockAffinity name and spec field text (3.32)
ctauchen Oct 16, 2026
2990c1b
Fix BlockAffinity name and spec field text (3.31)
ctauchen Oct 16, 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
8 changes: 4 additions & 4 deletions calico/reference/resources/blockaffinity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@

| 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. | Lower-case alphanumeric string with optional `.` or `-`. | string |

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------- | -------------------------------------------------------------------------- | ----------------------------------- | ------- | ------- |
| state | State of the affinity with regard to any referenced IPAM blocks. | confirmed, pending, pendingDeletion | string | |
| node | The node that this affinity is assigned to. | The hostname of the node | string | |
| cidr | The CIDR range this block affinity references. | A valid IPv4 or IPv6 CIDR. | string | |
| state | State of the affinity with regard to any referenced IPAM blocks. Required. | confirmed, pending, pendingDeletion, or empty | string | |

Check failure on line 22 in calico/reference/resources/blockaffinity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'pendingDeletion'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'pendingDeletion'?","location":{"path":"calico/reference/resources/blockaffinity.mdx","range":{"start":{"line":22,"column":110},"end":{"line":22,"column":125}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| node | The node that this affinity is assigned to. Required. | The name of the node, or `load-balancer` for blocks in a LoadBalancer IP pool | string | |
| cidr | The CIDR range this block affinity references. Required. | A valid IPv4 or IPv6 CIDR. | string | |

Check warning on line 24 in calico/reference/resources/blockaffinity.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/reference/resources/blockaffinity.mdx","range":{"start":{"line":24,"column":3},"end":{"line":24,"column":7}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| deleted | When set to true, clients should treat this block as if it does not exist. | true, false | boolean | `false` |
8 changes: 4 additions & 4 deletions calico_versioned_docs/version-3.31/reference/resources/blockaffinity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@

| 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. | Lower-case alphanumeric string with optional `.` or `-`. | string |

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------- | -------------------------------------------------------------------------- | ----------------------------------- | ------- | ------- |
| state | State of the affinity with regard to any referenced IPAM blocks. | confirmed, pending, pendingDeletion | string | |
| node | The node that this affinity is assigned to. | The hostname of the node | string | |
| cidr | The CIDR range this block affinity references. | A valid IPv4 or IPv6 CIDR. | string | |
| state | State of the affinity with regard to any referenced IPAM blocks. Required. | confirmed, pending, pendingDeletion | string | |

Check failure on line 22 in calico_versioned_docs/version-3.31/reference/resources/blockaffinity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'pendingDeletion'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'pendingDeletion'?","location":{"path":"calico_versioned_docs/version-3.31/reference/resources/blockaffinity.mdx","range":{"start":{"line":22,"column":110},"end":{"line":22,"column":125}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| node | The node that this affinity is assigned to. Required. | The name of the node, or `load-balancer` | string | |
| cidr | The CIDR range this block affinity references. Required. | A valid IPv4 or IPv6 CIDR. | string | |

Check warning on line 24 in calico_versioned_docs/version-3.31/reference/resources/blockaffinity.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/blockaffinity.mdx","range":{"start":{"line":24,"column":3},"end":{"line":24,"column":7}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| deleted | When set to true, clients should treat this block as if it does not exist. | true, false | boolean | `false` |
8 changes: 4 additions & 4 deletions calico_versioned_docs/version-3.32/reference/resources/blockaffinity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@

| 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. | Lower-case alphanumeric string with optional `.` or `-`. | string |

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------- | -------------------------------------------------------------------------- | ----------------------------------- | ------- | ------- |
| state | State of the affinity with regard to any referenced IPAM blocks. | confirmed, pending, pendingDeletion | string | |
| node | The node that this affinity is assigned to. | The hostname of the node | string | |
| cidr | The CIDR range this block affinity references. | A valid IPv4 or IPv6 CIDR. | string | |
| state | State of the affinity with regard to any referenced IPAM blocks. Required. | confirmed, pending, pendingDeletion | string | |

Check failure on line 22 in calico_versioned_docs/version-3.32/reference/resources/blockaffinity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'pendingDeletion'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'pendingDeletion'?","location":{"path":"calico_versioned_docs/version-3.32/reference/resources/blockaffinity.mdx","range":{"start":{"line":22,"column":110},"end":{"line":22,"column":125}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| node | The node that this affinity is assigned to. Required. | The name of the node, or `load-balancer` for blocks in a LoadBalancer IP pool | string | |
| cidr | The CIDR range this block affinity references. Required. | A valid IPv4 or IPv6 CIDR. | string | |

Check warning on line 24 in calico_versioned_docs/version-3.32/reference/resources/blockaffinity.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.32/reference/resources/blockaffinity.mdx","range":{"start":{"line":24,"column":3},"end":{"line":24,"column":7}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| deleted | When set to true, clients should treat this block as if it does not exist. | true, false | boolean | `false` |
8 changes: 4 additions & 4 deletions calico_versioned_docs/version-3.33/reference/resources/blockaffinity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@

| 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. | Lower-case alphanumeric string with optional `.` or `-`. | string |

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------- | -------------------------------------------------------------------------- | ----------------------------------- | ------- | ------- |
| state | State of the affinity with regard to any referenced IPAM blocks. | confirmed, pending, pendingDeletion | string | |
| node | The node that this affinity is assigned to. | The hostname of the node | string | |
| cidr | The CIDR range this block affinity references. | A valid IPv4 or IPv6 CIDR. | string | |
| state | State of the affinity with regard to any referenced IPAM blocks. Required. | confirmed, pending, pendingDeletion, or empty | string | |

Check failure on line 22 in calico_versioned_docs/version-3.33/reference/resources/blockaffinity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'pendingDeletion'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'pendingDeletion'?","location":{"path":"calico_versioned_docs/version-3.33/reference/resources/blockaffinity.mdx","range":{"start":{"line":22,"column":110},"end":{"line":22,"column":125}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| node | The node that this affinity is assigned to. Required. | The name of the node, or `load-balancer` for blocks in a LoadBalancer IP pool | string | |
| cidr | The CIDR range this block affinity references. Required. | A valid IPv4 or IPv6 CIDR. | string | |

Check warning on line 24 in calico_versioned_docs/version-3.33/reference/resources/blockaffinity.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.33/reference/resources/blockaffinity.mdx","range":{"start":{"line":24,"column":3},"end":{"line":24,"column":7}}},"severity":"WARNING","code":{"value":"Vale.Terms"}}
| deleted | When set to true, clients should treat this block as if it does not exist. | true, false | boolean | `false` |
Loading