Skip to content

Add common examples to Service Topology documentation#17808

Closed
andrewsykim wants to merge 314 commits intokubernetes:dev-1.17from
andrewsykim:service-topology
Closed

Add common examples to Service Topology documentation#17808
andrewsykim wants to merge 314 commits intokubernetes:dev-1.17from
andrewsykim:service-topology

Conversation

@andrewsykim
Copy link
Copy Markdown
Member

@andrewsykim andrewsykim commented Nov 26, 2019

Follow-up PR to #17459.

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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 26, 2019
@k8sio-netlify-preview-bot
Copy link
Copy Markdown
Collaborator

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

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

Building with commit 1943afd

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

@k8s-ci-robot 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
@andrewsykim
Copy link
Copy Markdown
Member Author

/assign @johnbelamaric @imroc


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

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

Choose a reason for hiding this comment

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

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

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 26, 2019
Copy link
Copy Markdown
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.

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

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

## Prerequisites
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good catch, thank you

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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/

routing:

* Kubernetes 1.17 or later
* Kube-proxy running in iptables mode or IPVS mode
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done, thanks


{{% capture whatsnext %}}

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

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done, thanks

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

imroc commented Nov 27, 2019

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

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 27, 2019
{{% 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/)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should we have "Read about EndpointSlice" here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

good catch, added!

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

tengqm commented Nov 29, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 29, 2019
Tim Bannister and others added 4 commits December 23, 2019 17:03
* BlockVolume is no longer alpha

Signed-off-by: dulltz <isrgnoe@gmail.com>

* Apply comment

#18167 (comment)

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Apply comment

#18167 (comment)

* Apply comment

#18167 (review)
Signed-off-by: dulltz <isrgnoe@gmail.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
* Renamed FeatureGate RequestManagement to APIPriorityAndFairness

* sorted alphabetically

* wrote RequestManagement into the deprecated table
@kbhawkey
Copy link
Copy Markdown
Contributor

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

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

@andrewsykim: PR needs rebase.

Details

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.

@andrewsykim
Copy link
Copy Markdown
Member Author

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
Copy link
Copy Markdown
Contributor

sftim commented Jan 15, 2020

@andrewsykim

Should I re-open this PR against master?

Please do!

Tim Bannister and others added 5 commits January 15, 2020 07:39
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 <kiman@vmware.com>
Signed-off-by: Andrew Sy Kim <kiman@vmware.com>
@k8s-ci-robot 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
Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot 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
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

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

Details 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 area/blog Issues or PRs related to the Kubernetes Blog subproject language/de Issues or PRs related to German language language/es Issues or PRs related to Spanish language language/fr Issues or PRs related to French language language/id Issues or PRs related to Indonesian language language/it Issues or PRs related to Italian language language/ja Issues or PRs related to Japanese language language/ko Issues or PRs related to Korean language language/ru Issues or PRs related to Russian language language/vi Issues or PRs related to Vietnamese language language/zh Issues or PRs related to Chinese language labels Jan 15, 2020
@andrewsykim
Copy link
Copy Markdown
Member Author

/close

Closing in favor of #18712

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

@andrewsykim: Closed this PR.

Details

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. language/de Issues or PRs related to German language language/en Issues or PRs related to English language language/es Issues or PRs related to Spanish language language/fr Issues or PRs related to French language language/id Issues or PRs related to Indonesian language language/it Issues or PRs related to Italian language language/ja Issues or PRs related to Japanese language language/ko Issues or PRs related to Korean language language/ru Issues or PRs related to Russian language language/vi Issues or PRs related to Vietnamese language language/zh Issues or PRs related to Chinese language needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.