📖 book: add ipam contract

[schrej]

What this PR does / why we need it:
Adds the IPAM contract to the book.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

/area ipam
/area documentation

[k8s-ci-robot]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[sbueringer]

@schrej Still interested in this one?

[schrej]

Yes, just forgot about it... I think I put it on hold due to some uncertainty with regards to clusterctl move. And now I also need to update regarding spec.clusterName instead of the annotation.

[schrej]

/remove-lifecycle stale

[enxebre]

@schrej is this still wip? lgtm as good starting point

[sbueringer]

@schrej friendly reminder 😀

[schrej]

I think this should be ready now. I've updated it to include the new spec.clusterName field and noted that the cluster name label is deprecated.

Sorry that it took so long.

[sbueringer]

@lubronzhan Do you maybe have some time to take a first look? (in case you're familiar with what we did in CAPV at the time)

[lubronzhan]

Sorry for the late reply. Overall LGTM!

[sbueringer]

Thx! Just a few small findings.

[sbueringer]

What about controller / blockOwnerDeletion here?

[schrej]

Good point. We're currently investigating an issue when deleting metal3 based clusters where claims are deadlocked due to the cluster vanishing before they are cleaned up. The paused check prevents the claim from being released if the cluster can't be found. We'll either have to make sure that the cluster doesn't get deleted, or ignore the paused check when releasing addresses.

[schrej]

I propose to merge this as is, and we'll update it if we change how this works in the in-cluster ipam implementation.
I've added a note to the ipam issue: kubernetes-sigs/cluster-api-ipam-provider-in-cluster#289

[schrej]

I think it's a good idea to set both and I've added a bullet point that recommends it. I've also added a sentence to deletion indicating that the infra Machine deletion should block until the claim is gone, which is the case with the correct owner ref.

[fabriziopandini]

Nice!
Happy to lgtm/approve once findings are addressed

[fabriziopandini]

Thanks for documenting this contract, good documentation is the foundation of CAPI extensibility!
/lgtm
/approve

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 0d317cd80dc02c2a55e5f6cc1ff25b80820ebd11

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [fabriziopandini]

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