Skip to content
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

Merged
merged 1 commit into from
Apr 1, 2022

Conversation

aojea
Copy link
Member

@aojea aojea commented Mar 18, 2022

/sig network
KEP kubernetes/enhancements#3070

@k8s-ci-robot k8s-ci-robot added the sig/network Categorizes an issue or PR as relevant to SIG Network. label Mar 18, 2022
@k8s-ci-robot k8s-ci-robot added this to the 1.24 milestone Mar 18, 2022
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 18, 2022
@netlify
Copy link

netlify bot commented Mar 18, 2022

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit d81296a
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6244009dd1d96b000956c6d9

@aojea
Copy link
Member Author

aojea commented Mar 18, 2022

/assign @tengqm @thockin

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 18, 2022
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 18, 2022
Copy link
Member

@thockin thockin left a comment

Choose a reason for hiding this comment

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

Thanks!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 18, 2022
@mehabhalodiya
Copy link
Contributor

/assign @nate-double-u

Copy link
Contributor

@sftim sftim left a 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.

@sftim
Copy link
Contributor

sftim commented Mar 19, 2022

/lgtm cancel

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 19, 2022
Copy link
Contributor

@divya-mohan0209 divya-mohan0209 left a 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
Copy link
Contributor

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.

Suggested change
- `ServiceIPStaticSubrange`: Enable a new strategy for Services ClusterIP allocations, so users can
- `ServiceIPStaticSubrange`: Enables a strategy for Services ClusterIP allocations, whereby users can

@tengqm
Copy link
Contributor

tengqm commented Mar 21, 2022

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4a2dae7c5a96c4d32185b8017cbc32daa9ac740c

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2022
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 21, 2022
Comment on lines 1240 to 1250
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 >}}
Copy link
Member Author

Choose a reason for hiding this comment

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

@sftim PTAL

Copy link
Contributor

@divya-mohan0209 divya-mohan0209 left a 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.

content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
@tengqm
Copy link
Contributor

tengqm commented Mar 21, 2022

/label tide/merge-method-squash

@sftim
Copy link
Contributor

sftim commented Mar 29, 2022

/retitle Add documentation for (alpha) feature ServiceIPStaticSubrange

@k8s-ci-robot k8s-ci-robot changed the title ServiceIPStaticSubrange alpha feature in 1.24 Add documentation for (alpha) feature ServiceIPStaticSubrange Mar 29, 2022
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 >}}

Copy link
Contributor

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).

Copy link
Member

@thockin thockin left a comment

Choose a reason for hiding this comment

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

/lgtm for correctness

@tengqm
Copy link
Contributor

tengqm commented Mar 29, 2022

/approve

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Mar 29, 2022
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 30, 2022
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 30, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 15003b65552c2bc517b4807a31a62c59e796eca2

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 1, 2022
@k8s-ci-robot k8s-ci-robot merged commit 9778eaf into kubernetes:dev-1.24 Apr 1, 2022
@nate-double-u
Copy link
Contributor

/lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/network Categorizes an issue or PR as relevant to SIG Network. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants