docs: Add IP reuse documentation

[MaxRink]

Split out from #683 as requested.

Changes:

• Add CAPM3 IP reuse / BMH name-based preallocation documentation.
• Document the BMH-based IPClaim name format and preAllocations example.
• Add clusterctl and controller flag configuration details.

Related: metal3-io/cluster-api-provider-metal3#3111

[metal3-io-bot]

Hi @MaxRink. Thanks for your PR.

I'm waiting for a metal3-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[tuminoid]

/ok-to-test

[tuminoid]

/copilot-review

[metal3-io-bot]

Copilot code review has been requested by @tuminoid. Please allow a few moments for the review to be added.

[Copilot]

Pull request overview

This PR adds user-guide documentation for CAPM3’s IP reuse feature (BMH name-based preallocation), including how IPClaim names are derived, how to use IPPool preAllocations, and how to enable the feature via clusterctl variables or controller flags.

Changes:

• Add a new CAPM3 “IP Reuse” documentation page describing the behavior, configuration, and troubleshooting steps.
• Include the new page in the CAPM3 features list.
• Add the new page to the user-guide table of contents (SUMMARY).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
docs/user-guide/src/SUMMARY.md	Adds the new “IP Reuse” page to the book navigation.
docs/user-guide/src/capm3/ip_reuse.md	New documentation page describing BMH name-based IP preallocation and configuration.
docs/user-guide/src/capm3/features.md	Links the new “IP Reuse” page from the CAPM3 features index.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[lentzi90]

/approve
Please check the nits from copilot

[metal3-io-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lentzi90

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [lentzi90]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[lentzi90]

Thank you! All good from my side. Let's see if we can get @fmuyassarov to take a look!
/cc @fmuyassarov

[tuminoid]

Thank you! All good from my side. Let's see if we can get @fmuyassarov to take a look! /cc @fmuyassarov

Ping @fmuyassarov

[fmuyassarov]

/lgtm