Skip to content

DOCS-3103: Add the IPAM block resource reference - #3224

Open
ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3103-ipamblock
Open

ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3103-ipamblock

Conversation

@ctauchen

@ctauchen ctauchen commented Nov 16, 2026 •

Copy link
Copy Markdown
Collaborator

Copilot AI lite review requested due to automatic review settings November 16, 2026 18:52
@netlify

netlify Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for calico-docs-preview-next ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2b2d028
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6afc9910cdcb4ee693ece9a3
😎 Deploy Preview https://deploy-preview-3224--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2b2d028
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6afc99105cf768ba0ebd722b
😎 Deploy Preview https://deploy-preview-3224--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 90 (🟢 up 19 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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
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
ctauchen marked this pull request as ready for review November 17, 2026 18:03
@ctauchen
ctauchen requested a review from a team as a code owner November 17, 2026 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants