Repository navigation
Conversation
✅ Deploy Preview for calico-docs-preview-next ready!Built without sensitive environment variables
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.
🟡 Changes recommended
Active moderate inaccuracies remain in the API-mode description across the affected IPAMBlock pages, with additional cooldown-state wording issues in two versions.
5 open issues
Clarify v3 APIs are available in both datastore modes · New Clarify v3 APIs are available in both datastore modes · New Clarify v3 APIs are available in both datastore modes · New Include released addresses awaiting reuse in attributes description · New Include released addresses awaiting reuse in attributes description · New
What changed in this PR
Adds the IPAMBlock resource reference to Calico Open Source documentation for the next, 3.33, and 3.32 versions, including field definitions, ownership details, release behavior, and an example manifest.
Changes:
- Adds IPAMBlock reference pages to all three documentation trees.
- Links IPAMBlock from each resource overview.
- Adds IPAMBlock to the corresponding resource sidebars.
| File | Description |
|---|---|
| sidebars-calico.js | Adds IPAMBlock to the next-version Calico resource sidebar. |
| calico/reference/resources/overview.mdx | Lists IPAMBlock in the next-version resource overview. |
| calico/reference/resources/ipamblock.mdx | Adds the next-version IPAMBlock resource reference page. |
| calico_versioned_sidebars/version-3.33-sidebars.json | Adds IPAMBlock to the 3.33 resource sidebar. |
| calico_versioned_sidebars/version-3.32-sidebars.json | Adds IPAMBlock to the 3.32 resource sidebar. |
| calico_versioned_docs/version-3.33/reference/resources/overview.mdx | Lists IPAMBlock in the 3.33 resource overview. |
| calico_versioned_docs/version-3.33/reference/resources/ipamblock.mdx | Adds the 3.33 IPAMBlock resource reference page. |
| calico_versioned_docs/version-3.32/reference/resources/overview.mdx | Lists IPAMBlock in the 3.32 resource overview. |
| calico_versioned_docs/version-3.32/reference/resources/ipamblock.mdx | Adds the 3.32 IPAMBlock resource reference page. |
Review effort: Lite
| You don't normally create or change them. | ||
| To see the blocks in a cluster and how full each one is, use [`calicoctl ipam show --show-blocks`](../calicoctl/ipam/show.mdx). | ||
|
|
||
| The `projectcalico.org/v3` version of this resource exists only when the cluster uses [native v3 CRDs](../../operations/native-v3-crds.mdx). |
| You don't normally create or change them. | ||
| To see the blocks in a cluster and how full each one is, use [`calicoctl ipam show --show-blocks`](../calicoctl/ipam/show.mdx). | ||
|
|
||
| The `projectcalico.org/v3` version of this resource exists only when the cluster uses [native v3 CRDs](../../operations/native-v3-crds.mdx). |
| You don't normally create or change them. | ||
| To see the blocks in a cluster and how full each one is, use [`calicoctl ipam show --show-blocks`](../calicoctl/ipam/show.mdx). | ||
|
|
||
| The `projectcalico.org/v3` version of this resource exists only when the cluster uses [native v3 CRDs](../../operations/native-v3-crds.mdx). |
| | affinityClaimTime | The time when the owner claimed the block. | | date-time string | | | ||
| | allocations | One entry for each address in the block, in order. The entry at position 0 is for the first address in the CIDR. A `null` entry means the address is free. Any other entry is the position, in `attributes`, of the item that describes what holds the address. Required. | | list of integers or `null` | | | ||
| | unallocated | The positions of the free addresses in the block. $[prodname] IPAM assigns the address at the start of the list first and adds an address to the end of the list when it is released. Required. | | list of integers | | | ||
| | attributes | One item for each assigned address. Each item describes what holds the address. Required. | | list of [AllocationAttribute](#allocationattribute) | | |
| | affinityClaimTime | The time when the owner claimed the block. | | date-time string | | | ||
| | allocations | One entry for each address in the block, in order. The entry at position 0 is for the first address in the CIDR. A `null` entry means the address is free. Any other entry is the position, in `attributes`, of the item that describes what holds the address. Required. | | list of integers or `null` | | | ||
| | unallocated | The positions of the free addresses in the block. $[prodname] IPAM assigns the address at the start of the list first and adds an address to the end of the list when it is released. Required. | | list of integers | | | ||
| | attributes | One item for each assigned address. Each item describes what holds the address. Required. | | list of [AllocationAttribute](#allocationattribute) | | |
ctauchen
marked this pull request as ready for review
November 17, 2026 18:03
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.



Adds a reference page for the IPAMBlock resource to Calico Open Source next, 3.33, and 3.32.
Jira: https://tigera.atlassian.net/browse/DOCS-3103
Previews: