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

EndpointSlice API GA Doc Updates for 1.21 #27070

Merged
merged 1 commit into from
Mar 29, 2021
Merged

EndpointSlice API GA Doc Updates for 1.21 #27070

merged 1 commit into from
Mar 29, 2021

Conversation

swetharepakula
Copy link
Member

@k8s-ci-robot k8s-ci-robot added this to the 1.21 milestone Mar 15, 2021
@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 15, 2021
@k8sio-netlify-preview-bot
Copy link
Collaborator

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

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

Building with commit 02afb71

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/605bb3a821e6be0008e4e59a

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

/cc @robscott

@robscott
Copy link
Member

Thanks for the work on this! I think you'll also need changes to a couple more files:

@robscott
Copy link
Member

/sig network

@k8s-ci-robot k8s-ci-robot added the sig/network Categorizes an issue or PR as relevant to SIG Network. label Mar 15, 2021
@PI-Victor
Copy link
Member

thank you for opening this!

/assign

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 17, 2021
@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 17, 2021
@swetharepakula swetharepakula force-pushed the eps-ga-docs branch 2 times, most recently from 7162b14 to 0aeb542 Compare March 18, 2021 01:06
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 23, 2021
tengqm
tengqm reviewed Mar 23, 2021
View reviewed changes
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
content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/endpoint-slices.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/endpoint-slices.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/endpoint-slices.md Outdated
be supported in the v1 API. Instead, the v1 API supports setting individual
node name and zone fields. These fields will be automatically translated
between API versions. For example, the value of
topology[topology.kubernetes.io/zone] in the v1beta1 API will be accessible in
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
topology[topology.kubernetes.io/zone] in the v1beta1 API will be accessible in
`topology.kubernetes.io/zone` in the v1beta1 API are available as

Copy link
Member Author

Choose a reason for hiding this comment

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

The field in the API is topology which is a map. In this case we are referring to the key value pair topology[topology.kubernetes.io/zone]. I added backticks, does that make it clearer?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe topology["topology.kubernetes.io/zone"] would be slightly clearer? Agree that the topology[ prefix adds important context here.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see. Since topology is a map, and topology.kubernetes.io/zone is a key in that map, we may want to revise the sentence so that the text is more clearer for YAML developers/users.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have called out that topology.kubernetes.io/zone as a key in the topology field in the new version. Let me know if the text is clear enough now. I am not exactly sure how to describe it for YAML users.

content/en/docs/concepts/services-networking/endpoint-slices.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/endpoint-slices.md Outdated Show resolved Hide resolved
@swetharepakula
Copy link
Member Author

swetharepakula commented Mar 23, 2021 •
edited
Loading

Because of kubernetes/kubernetes#100472, I have added doc changes to mention the deprecation.

@swetharepakula swetharepakula mentioned this pull request Mar 23, 2021
Merged
sftim
sftim reviewed Mar 23, 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.

A bit more feedback. We can merge this as-is; however there are a couple of points about factual accuracy that we might want to look at.

content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/enabling-endpointslices.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/enabling-endpointslices.md Outdated Show resolved Hide resolved
@swetharepakula swetharepakula force-pushed the eps-ga-docs branch 2 times, most recently from 4c7471a to c165a73 Compare March 24, 2021 00:19
@swetharepakula
Copy link
Member Author

Newest update removes content/en/docs/tasks/administer-cluster/enabling-endpointslices.md and adds a redirect from that to content/en/docs/concepts/services-networking/endpoint-slices.md. The new over capacity annotation has been added to content/en/docs/reference/labels-annotations-taints.md.

Thanks for all the feedback!

kbhawkey
kbhawkey reviewed Mar 24, 2021
View reviewed changes
static/_redirects Outdated Show resolved Hide resolved
@swetharepakula
Update EndpointSlice Docs
02afb71 
 * Deprecate `endpointslices.discovery.k8s.io/v1beta1`
 * Removes `content/en/docs/tasks/administer-cluster/enabling-endpointslices.md`
 and redirects requests to that page to
 `content/en/docs/concepts/services-networking/endpoint-slices.md`
@tengqm
Copy link
Contributor

tengqm commented Mar 25, 2021

/lgtm

@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: f8ec686c90f0e1e6c2356a6261eba66401b1722c

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 25, 2021
@PI-Victor
Copy link
Member

@reylejano this seems to have all the concerns addressed, is it ok to approve?

@reylejano
Copy link
Member

Several sig doc members have made reviews and theirs comments have been addressed
A sig docs member has given an lgtm

@robscott can you give a technical lgtm

@PI-Victor
Copy link
Member

@kubernetes/sig-network-pr-reviews please provide a tech review for this PR by 31st of March in order to get it into the release.
thank you!

@robscott
Copy link
Member

Thanks!

/lgtm

@reylejano
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano

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 29, 2021
@k8s-ci-robot k8s-ci-robot merged commit aea393a into kubernetes:dev-1.21 Mar 29, 2021
@sftim sftim mentioned this pull request Apr 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robscott robscott robscott left review comments

@liggitt liggitt liggitt left review comments

@kbhawkey kbhawkey kbhawkey left review comments

@tengqm tengqm tengqm left review comments

@sftim sftim sftim left review comments

@freehan freehan Awaiting requested review from freehan

Assignees

@robscott robscott

@tengqm tengqm

@PI-Victor PI-Victor

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

Successfully merging this pull request may close these issues.
10 participants
@swetharepakula @k8sio-netlify-preview-bot @robscott @PI-Victor @reylejano @tengqm @k8s-ci-robot @liggitt @kbhawkey @sftim