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.

Sign up for GitHub

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

Jump to bottom

Promote IPv4/IPv6 dual-stack support to Beta #26826

Merged
merged 5 commits into from
Mar 8, 2021
Merged

Promote IPv4/IPv6 dual-stack support to Beta #26826

merged 5 commits into from
Mar 8, 2021

Conversation

bridgetkromhout
Copy link
Member

Enhancements issue: kubernetes/enhancements#563
Kubernetes PR: kubernetes/kubernetes#98969

Signed-off-by: Bridget Kromhout bridget@kromhout.org

@bridgetkromhout
Docs update for enhancement 563, release 1.21.
3e7055c 
Signed-off-by: Bridget Kromhout <bridget@kromhout.org>
@k8s-ci-robot k8s-ci-robot added this to the 1.21 milestone Mar 3, 2021
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 3, 2021
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Mar 3, 2021 •
edited
Loading

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 99e46a5

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6041fedebae4d60007706433

@k8s-ci-robot k8s-ci-robot requested review from aramase and lachie83 March 3, 2021 23:58
@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. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 3, 2021
@bridgetkromhout bridgetkromhout mentioned this pull request Mar 4, 2021
Closed
@annajung
Copy link
Contributor

annajung commented Mar 4, 2021

cc @reylejano

@tengqm
Copy link
Contributor

tengqm commented Mar 4, 2021

/retitle Promote IPv4/IPv6 dual-stack support to Beta

Please also update table on the page content/en/docs/reference/command-line-tools-reference/feature-gates.md.

@k8s-ci-robot k8s-ci-robot changed the title Docs update for enhancement 563, release 1.21. Promote IPv4/IPv6 dual-stack support to Beta Mar 4, 2021
bridgetkromhout and others added 2 commits March 3, 2021 21:14
@bridgetkromhout @tengqm
Update content/en/docs/concepts/services-networking/dual-stack.md
d8aa722 
Clarifying how to disable the dual-stack feature when necessary.

Co-authored-by: Qiming Teng <tengqm@outlook.com>
@bridgetkromhout
Update to indicate dual-stack move to beta in 1.21
31777fa 
Signed-off-by: Bridget Kromhout <bridget@kromhout.org>
@bridgetkromhout
Copy link
Member Author

Thanks, @tengqm!

Please also update table on the page content/en/docs/reference/command-line-tools-reference/feature-gates.md.

I updated that table per your request, and also updated the other indicator on the top of the docs page so it is also correct for 1.21.

@aojea
Copy link
Member

aojea commented Mar 4, 2021 •
edited
Loading

lgtm

EDIT

just FYI, if we want to add a link to the kubeadm docs too
#26675

@bridgetkromhout
Restoring alpha details with end date
bb9f8eb 
Signed-off-by: Bridget Kromhout <bridget@kromhout.org>
@bridgetkromhout
Copy link
Member Author

just FYI, if we want to add a link to the kubeadm docs too

Hi, @aojea -

I see that PR; I assumed it would be merged on its own - is there any action for me to take here in terms of edits to this Pr? Thanks.

@aojea
Copy link
Member

aojea commented Mar 4, 2021

ee that PR; I assumed it would be merged on its own - is there any action for me to take here in terms of edits to this Pr? Thanks.

I'm not familiar with the website, so I don't know if we use cross references, so I just wanted to let you know, nothing else :)

@bridgetkromhout
Copy link
Member Author

@aojea Based on my understanding of the website, I believe the link being added in #26675 is being placed in the correct location. Thanks for flagging!

sftim
sftim reviewed Mar 5, 2021
View reviewed changes
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 for this PR.

The Markdown looks good to me.
I would however revise the text “If you enable IPv4/IPv6 dual-stack networking for your Kubernetes cluster, the cluster will support the simultaneous assignment of both IPv4 and IPv6 addresses.” in https://kubernetes.io/docs/concepts/services-networking/dual-stack/ - to reflect that you typically don't have to take any action to enable it.

You might also want to reword:

Enabling IPv4/IPv6 dual-stack on your Kubernetes cluster provides the following features:

content/en/docs/concepts/services-networking/dual-stack.md Outdated

{{< note >}}
An example of an IPv4 CIDR: `10.244.0.0/16` (though you would supply your own address range)

An example of an IPv6 CIDR: `fdXY:IJKL:MNOP:15::/64` (this shows the format but is not a valid address - see [RFC 4193](https://tools.ietf.org/html/rfc4193))

Starting in 1.21, IPv4/IPv6 dual-stack defaults to true.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Starting in 1.21, IPv4/IPv6 dual-stack defaults to true.
Starting in 1.21, IPv4/IPv6 dual-stack defaults to enabled.

content/en/docs/concepts/services-networking/dual-stack.md

To enable IPv4/IPv6 dual-stack, enable the `IPv6DualStack` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) for the relevant components of your cluster, and set dual-stack cluster network assignments:
To configure IPv4/IPv6 dual-stack, set dual-stack cluster network assignments:
Copy link
Contributor

Choose a reason for hiding this comment

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

When features are beta, we typically still mention that the feature gate needs to be enabled, but tweak the wording. This helps people who are using older versions of Kubernetes spot that they might want to swap to reading documentation appropriate for their version.

@bridgetkromhout
Clarifying dual-stack as default in 1.21.
99e46a5 
Signed-off-by: Bridget Kromhout <bridget@kromhout.org>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 5, 2021
@bridgetkromhout
Copy link
Member Author

Thanks for the review, @sftim! I've edited to reflect your feedback.

@sftim
Copy link
Contributor

sftim commented Mar 5, 2021

/sig network

@k8s-ci-robot k8s-ci-robot added the sig/network Categorizes an issue or PR as relevant to SIG Network. label Mar 5, 2021
sftim
sftim reviewed Mar 5, 2021
View reviewed changes
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.

Markdown LGTM

@kubernetes/sig-network-pr-reviews any concerns?

@aojea
Copy link
Member

aojea commented Mar 5, 2021

LGTM

@sftim
Copy link
Contributor

sftim commented Mar 5, 2021

/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 5, 2021
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 8b7642859ccb456962f00b9468e4135a16876bfc

@reylejano
Copy link
Member

/assign @ChandaniM123

@bridgetkromhout
Copy link
Member Author

Hi, @sftim - thanks for giving an LGTM. I see @ChandaniM123 was assigned 3 days ago but I'm not sure what the next step is to get us the approved label. Can you provide guidance? Thanks.

@sftim
Copy link
Contributor

sftim commented Mar 8, 2021

SIG Docs uses slightly different approval conventions from other SIGs, mostly I think because a merge to master is an update to the live website.
A SIG Docs approver (other than me) can approve this change. If another reviewer, reviewing on behalf of SIG Docs, adds their /lgtm, then I can approve this.

@sftim
Copy link
Contributor

sftim commented Mar 8, 2021

I'm sure we'll get this fully reviewed well before the release. The deadline for docs to be reviewable is 2021-03-24 so you're getting this in nice and early @bridgetkromhout

@annajung
Copy link
Contributor

annajung commented Mar 8, 2021

Hi @bridgetkromhout, thanks for following up!
This lgtm and with review from both sig docs / sig network, I'm happy to approve this!

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: annajung

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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 8, 2021
@k8s-ci-robot k8s-ci-robot merged commit 31c5e7b into kubernetes:dev-1.21 Mar 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@tengqm tengqm tengqm left review comments

@aramase aramase Awaiting requested review from aramase

@lachie83 lachie83 Awaiting requested review from lachie83

Assignees

@ChandaniM123 ChandaniM123

@sftim sftim

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
1.21
Development

Successfully merging this pull request may close these issues.
9 participants
@bridgetkromhout @k8sio-netlify-preview-bot @annajung @tengqm @aojea @sftim @k8s-ci-robot @reylejano @ChandaniM123