Repository navigation
docs(networking): document reserved IP addresses - #811
Open
Timofei Larkin (lllamnyp) wants to merge 1 commit into
Open
Timofei Larkin (lllamnyp) wants to merge 1 commit into
Timofei Larkin (lllamnyp) wants to merge 1 commit into
Conversation
cozystack/cozystack#3382 adds two optional system packages, cozystack.address-controller and cozystack.metallb-iad, that let a tenant reserve an IP address which outlives the Service using it. Operators need more than the API: the driver only names an existing MetalLB pool, the packages enable an admission policy that changes what tenant clusters can set on their Services, the images are outside the repositories the release tooling mirrors, and finalizers make teardown order matter. The page covers enabling the packages, creating a class over an existing pool, how tenants reserve and attach an address, the admission policy and its rollout mode, air-gapped installs, teardown and CRD upgrades. It links the upstream operating guide for the step-by-step procedures rather than copying them. Assisted-by: LLM Signed-off-by: Timofei Larkin <lllamnyp@gmail.com>
Timofei Larkin (lllamnyp)
requested review from
Andrei Kvapil (kvaps),
myasnikovdaniil and
Timur Tukaev (tym83)
as code owners
November 13, 2026 15:24
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
 |
1 of 12 tasks
This branch has not been deployed
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.
What
Adds
networking/reserved-ip-addresses.mdto thenextdocs, an operator page for the two optional packages that cozystack/cozystack#3382 adds:cozystack.address-controller(IPAddressClass / IPAddress / IPAddressClaim) and its MetalLB drivercozystack.metallb-iad.It covers:
bundles.enabledPackages, and the variants where the platform does not emit the driver because MetalLB is absent.autoAssign: falseIPAddressPoolincozy-metallb, with the admin owning the pool and its advertisement. Also default and auto-claim classes,reclaimPolicyandreleaseDelay, and reserving part of a pool that auto-assigns today.local.sdn.cozystack.io/ip-address-claimon a guest Service of a tenant Kubernetes cluster, and opt-in auto-claim withlocal.sdn.cozystack.io/ip-address-class.[Warn, Audit]rollout through Package values.Step-by-step procedures, such as adopting an address a Service already holds and clearing finalizers by hand, link to the upstream operating guide rather than repeating it.
Notes for review
The image references and the admission policy's exemptions describe the packages as #3382 currently ships them, so a later change to either there needs the same change here. The page is in
next/and reaches a released version only when the trunk is promoted. The component cards for the two packages are a separate PR, #810.