Add common examples to Service Topology documentation #17808

andrewsykim · 2019-11-26T05:59:54Z

Follow-up PR to #17459.

fixes some typos
adds missing "enabling service topology" page
adds common examples of using the Service Topology feature.

k8sio-netlify-preview-bot · 2019-11-26T06:00:07Z

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

Building with commit 1943afd

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5ddf16d5ef951900082e76f5

andrewsykim · 2019-11-26T06:00:37Z

/assign @johnbelamaric @imroc

imroc · 2019-11-26T07:06:54Z

content/en/docs/tasks/administer-cluster/enabling-service-topology.md

+
+{{< feature-state for_k8s_version="v1.17" state="alpha" >}}
+
+To enable service topology, enable the `ServiceTopology` and `EndpointSlice` feature gate for all Kubernetes components:


/lgtm
Although some components do not need to enable these features, it may be easier to just enable them all, without having to remember these details.

sftim

Some feedback. I noticed that the new task page ends up with two Prerequisites sections.

sftim · 2019-11-26T11:14:12Z

content/en/docs/tasks/administer-cluster/enabling-service-topology.md

+preferentially routed to endpoints that are on the same Node as the client, or
+in the same availability zone.
+
+## Prerequisites


I recommend moving this to the {{% capture prerequisites %}} section (at time of writing, that starts on line 15)

Good catch, thank you

So the page actually renders the prerequisite capture as a "Before you begin" so I think it looks okay as-is.

https://5ddcbf5c6044c00008fa6e29--kubernetes-io-vnext-staging.netlify.com/docs/tasks/administer-cluster/enabling-service-topology/

sftim · 2019-11-26T11:15:04Z

content/en/docs/tasks/administer-cluster/enabling-service-topology.md

+routing:
+
+   * Kubernetes 1.17 or later
+   * Kube-proxy running in iptables mode or IPVS mode


Consider making kube-proxy be a glossary tooltip. You can also link to the Service concept page, if you like; there is a section about the different modes.

done, thanks

sftim · 2019-11-26T11:15:49Z

content/en/docs/tasks/administer-cluster/enabling-service-topology.md

+
+{{% capture whatsnext %}}
+
+* Read about using [Service Topology](/docs/concepts/services-networking/service-topology)


Suggested change

* Read about using [Service Topology](/docs/concepts/services-networking/service-topology)

* Read about the [Service Topology](/docs/concepts/services-networking/service-topology) concept

done, thanks

imroc · 2019-11-27T07:50:47Z

/lgtm

Maybe also change enabling Service Topology to Enabling Service Topology by the way in What's Next section, although it was not touched by this commit yet.

johnbelamaric · 2019-11-28T00:16:58Z

content/en/docs/tasks/administer-cluster/enabling-service-topology.md

+{{% capture whatsnext %}}
+
+* Read about the [Service Topology](/docs/concepts/services-networking/service-topology) concept
+* Read [Connecting Applications with Services](/docs/concepts/services-networking/connect-applications-service/)


Should we have "Read about EndpointSlice" here?

good catch, added!

tengqm · 2019-11-29T00:47:17Z

/lgtm

* BlockVolume is no longer alpha Signed-off-by: dulltz <[email protected]> * Apply comment #18167 (comment) Co-Authored-By: Tim Bannister <[email protected]> * Apply comment #18167 (comment) * Apply comment #18167 (review) Signed-off-by: dulltz <[email protected]> Co-authored-by: Tim Bannister <[email protected]>

* Renamed FeatureGate RequestManagement to APIPriorityAndFairness * sorted alphabetically * wrote RequestManagement into the deprecated table

kbhawkey · 2019-12-23T22:09:46Z

@andrewsykim , would you comment on the status of this PR. Thank you. Are there outstanding 1.17 updates?

k8s-ci-robot · 2019-12-23T22:09:53Z

@andrewsykim: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Added missing article in one of the sentences

andrewsykim · 2020-01-15T15:18:42Z

Sorry this fell off my radar. I think it would be good to still add the changes. Should I re-open this PR against master?

sftim · 2020-01-15T15:32:29Z

@andrewsykim

Should I re-open this PR against master?

Please do!

The Kubernetes logo links to the top-of-site for the current localization, so localize the title attribute.

Related kubernetes/minikube#6013 When using the `vmware` driver for minikube the shared folder will be in `/mnt/hgfs` instead of directly on root `/`.

Signed-off-by: Andrew Sy Kim <[email protected]>

k8s-ci-robot · 2020-01-15T17:14:16Z

New changes are detected. LGTM label has been removed.

k8s-ci-robot · 2020-01-15T17:14:56Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign steveperry-53
You can assign the PR to them by writing /assign @steveperry-53 in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

andrewsykim · 2020-01-15T17:17:42Z

/close

Closing in favor of #18712

k8s-ci-robot · 2020-01-15T17:17:44Z

@andrewsykim: Closed this PR.

In response to this:

/close

Closing in favor of #18712

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 26, 2019

andrewsykim mentioned this pull request Nov 26, 2019

Service topology alpha documentation #17459

Merged

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 26, 2019

k8s-ci-robot assigned imroc and johnbelamaric Nov 26, 2019

k8s-ci-robot requested review from johnbelamaric and sftim November 26, 2019 06:00

imroc reviewed Nov 26, 2019

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 26, 2019

sftim reviewed Nov 26, 2019

View reviewed changes

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 26, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 27, 2019

johnbelamaric reviewed Nov 28, 2019

View reviewed changes

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2019

k8s-ci-robot assigned tengqm Nov 29, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 29, 2019

mrbobbytables force-pushed the dev-1.17 branch from 6e99b11 to fa71e44 Compare December 6, 2019 22:57

sftim and others added 4 commits December 23, 2019 17:03

ru translation for project slogan

c6429d4

Minor fix for a typo. (#18182)

bc549fd

Renamed FeatureGate RequestManagement to APIPriorityAndFairness (#18184)

f1f7c1b

* Renamed FeatureGate RequestManagement to APIPriorityAndFairness * sorted alphabetically * wrote RequestManagement into the deprecated table

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 23, 2019

mayakacz and others added 3 commits January 15, 2020 05:09

Add link to K8s bug bounty to K8s website (#18690)

7b08e59

Add missing article (#18707)

ffb37e6

Added missing article in one of the sentences

Fix typo: default-manager -> default-scheduler (#18649)

cd3020b

sftim and others added 5 commits January 15, 2020 07:39

Localize logo title (#18318)

7d424c3

The Kubernetes logo links to the top-of-site for the current localization, so localize the title attribute.

Update vmware shared folder location (#18674)

ff79db8

Related kubernetes/minikube#6013 When using the `vmware` driver for minikube the shared folder will be in `/mnt/hgfs` instead of directly on root `/`.

Remove security alias for zh security.md (#18694)

a18b023

service topology: add missing 'enabling service topology' page

f787cce

Signed-off-by: Andrew Sy Kim <[email protected]>

service topology: add common examples

3eea137

Signed-off-by: Andrew Sy Kim <[email protected]>

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 15, 2020

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 15, 2020

andrewsykim mentioned this pull request Jan 15, 2020

Add common examples to Service Topology documentation #18712

Merged

k8s-ci-robot closed this Jan 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add common examples to Service Topology documentation #17808

Add common examples to Service Topology documentation #17808

andrewsykim commented Nov 26, 2019 •

edited

Loading

k8sio-netlify-preview-bot commented Nov 26, 2019 •

edited

Loading

andrewsykim commented Nov 26, 2019

imroc Nov 26, 2019

sftim left a comment

sftim Nov 26, 2019

andrewsykim Nov 26, 2019

andrewsykim Nov 26, 2019

sftim Nov 26, 2019

andrewsykim Nov 26, 2019

sftim Nov 26, 2019

andrewsykim Nov 26, 2019

imroc commented Nov 27, 2019

johnbelamaric Nov 28, 2019

andrewsykim Nov 28, 2019

tengqm commented Nov 29, 2019

kbhawkey commented Dec 23, 2019

k8s-ci-robot commented Dec 23, 2019

andrewsykim commented Jan 15, 2020

sftim commented Jan 15, 2020

k8s-ci-robot commented Jan 15, 2020

k8s-ci-robot commented Jan 15, 2020

andrewsykim commented Jan 15, 2020

k8s-ci-robot commented Jan 15, 2020


		{{< feature-state for_k8s_version="v1.17" state="alpha" >}}

		To enable service topology, enable the `ServiceTopology` and `EndpointSlice` feature gate for all Kubernetes components:


		{{% capture whatsnext %}}

		* Read about using [Service Topology](/docs/concepts/services-networking/service-topology)

	* Read about using [Service Topology](/docs/concepts/services-networking/service-topology)
	* Read about the [Service Topology](/docs/concepts/services-networking/service-topology) concept

Add common examples to Service Topology documentation #17808

Add common examples to Service Topology documentation #17808

Conversation

andrewsykim commented Nov 26, 2019 • edited Loading

k8sio-netlify-preview-bot commented Nov 26, 2019 • edited Loading

andrewsykim commented Nov 26, 2019

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imroc commented Nov 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tengqm commented Nov 29, 2019

kbhawkey commented Dec 23, 2019

k8s-ci-robot commented Dec 23, 2019

andrewsykim commented Jan 15, 2020

sftim commented Jan 15, 2020

k8s-ci-robot commented Jan 15, 2020

k8s-ci-robot commented Jan 15, 2020

andrewsykim commented Jan 15, 2020

k8s-ci-robot commented Jan 15, 2020

andrewsykim commented Nov 26, 2019 •

edited

Loading

k8sio-netlify-preview-bot commented Nov 26, 2019 •

edited

Loading