-
Notifications
You must be signed in to change notification settings - Fork 14.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for (alpha) feature ServiceIPStaticSubrange #32345
Conversation
👷 Deploy Preview for kubernetes-io-vnext-staging processing.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
/lgtm
/approve
/assign @nate-double-u |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @aojea
This documentation is not yet ready I'm afraid - you need to document the behavior when ServiceIPStaticSubrange is enabled.
content/en/docs/reference/command-line-tools-reference/feature-gates.md
Outdated
Show resolved
Hide resolved
content/en/docs/reference/command-line-tools-reference/feature-gates.md
Outdated
Show resolved
Hide resolved
/lgtm cancel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammatical nit
@@ -1037,6 +1038,12 @@ Each feature gate is designed for enabling/disabling a specific feature: | |||
topology of the cluster. See | |||
[ServiceTopology](/docs/concepts/services-networking/service-topology/) | |||
for more details. | |||
- `ServiceIPStaticSubrange`: Enable a new strategy for Services ClusterIP allocations, so users can |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit + adding on to Tim's suggestions above.
- `ServiceIPStaticSubrange`: Enable a new strategy for Services ClusterIP allocations, so users can | |
- `ServiceIPStaticSubrange`: Enables a strategy for Services ClusterIP allocations, whereby users can |
content/en/docs/reference/command-line-tools-reference/feature-gates.md
Outdated
Show resolved
Hide resolved
/lgtm |
LGTM label has been added. Git tree hash: 4a2dae7c5a96c4d32185b8017cbc32daa9ac740c
|
If you enable the `ServiceIPStaticSubrange` | ||
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/), | ||
the allocation strategy subdivides the `ClusterIP` range in two bands, based on | ||
the size of the configured `service-cluster-ip-range` by the following formula | ||
`min(max(16, cidrSize / 16), 256)`, described as _never less than 16 or more than 256, | ||
with a graduated step function between them_. Dynamic IP allocations will be preferently | ||
chosen from the upper band, reducing risks of collisions with the IPs | ||
assigned on the lower band. | ||
This allows users to use the lower band of the `service-cluster-ip-range` for their | ||
Services with static IPs assigned with a very low risk of collision. | ||
{{< /note >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sftim PTAL
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replaced collision with conflict since the latter seems more appropriate, given the context
I do realize that collision has been used elsewhere in the K8s documentation and am not sure if the wording was intentional to keep it consistent across docs. Rest of it is slightly rephrased for clarity.
/label tide/merge-method-squash |
content/en/docs/reference/command-line-tools-reference/feature-gates.md
Outdated
Show resolved
Hide resolved
/retitle Add documentation for (alpha) feature ServiceIPStaticSubrange |
This allows users to use the lower band of the `service-cluster-ip-range` for their | ||
Services with static IPs assigned with a very low risk of running into conflicts. | ||
{{< /note >}} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We usually wouldn't put a feature gate shortcode inside a note. I'd use a 3rd-level (or maybe a 4th-level) heading here; for example:
#### IP address ranges for `type: ClusterIP` Services {#service-ip-static-sub-range}
(and then skip the note callout entirely).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm for correctness
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tengqm, thockin 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:
Approvers can indicate their approval by writing |
LGTM label has been added. Git tree hash: 15003b65552c2bc517b4807a31a62c59e796eca2
|
/lgtm |
/sig network
KEP kubernetes/enhancements#3070