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

docs/concepts/services-networking/service/ needs overhaul #14770

Closed
MrHohn opened this issue Jun 6, 2019 · 34 comments
Closed

docs/concepts/services-networking/service/ needs overhaul #14770

MrHohn opened this issue Jun 6, 2019 · 34 comments
Assignees
@sftim
Labels
kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/network Categorizes an issue or PR as relevant to SIG Network. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@MrHohn
Copy link
Member

MrHohn commented Jun 6, 2019

This is a Feature Request

What would you like to be added

Overhaul https://kubernetes.io/docs/concepts/services-networking/service/. From a high level, I guess it would be great to do:

  • Make it really talk about concept. e.g. what does service do, what is its relationship with label/endpoint/pod, what are the service types and other essential API surface, etc.
  • Split the kube-proxy implementation details / history to somewhere else.
  • Remove the cloud specific tutorials / notes.

Why is this needed
The service doc page contains too much unnecessary information. It brings lots of confusion to people who just wants to learn the concept of a kubernete service. The kube-proxy implementation doesn't really matter as they all serve the same service API. It would be more clear to extract those nuances to another place for folks that are willing to dig deeper.

The doc also contains too much cloud provider specific content that really should be served on provider's own place. e.g. how to configure X load balancer feature on Y cloudprovider.

Comments
@MrHohn
Copy link
Member Author

MrHohn commented Jun 6, 2019

/kind feature
/language en

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language labels Jun 6, 2019
@sftim
Copy link
Contributor

sftim commented Jun 6, 2019

Hi @MrHohn

Is this a duplicate of #3735?

@MrHohn
Copy link
Member Author

MrHohn commented Jun 6, 2019

Hi @sftim, #3735 focuses more about mentioning Ingress from the Service page so folks can get the right direction while this issue cares more about how Service page is constructed in general. So I don't think it is a duplicate.

@sftim
Copy link
Contributor

sftim commented Jun 7, 2019

The Service page certainly wants more work done on it.

@sftim sftim mentioned this issue Jun 7, 2019
Closed
3 tasks
@sftim
Copy link
Contributor

sftim commented Jun 7, 2019

Slightly relevant: #12410 talks about kube-proxy examples.

@sftim
Copy link
Contributor

sftim commented Jun 12, 2019

Discussed in SIG Docs weekly meeting.
/priority important-longterm
cc @cody-clark

@k8s-ci-robot k8s-ci-robot added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Jun 12, 2019
@sftim
Copy link
Contributor

sftim commented Jun 12, 2019

Also relevant to #11382 because the current page is heavy on AWS-specific detail.

@sftim sftim mentioned this issue Jun 28, 2019
Merged
@sftim sftim mentioned this issue Jul 28, 2019
Closed
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 10, 2019
@sftim
Copy link
Contributor

sftim commented Sep 10, 2019

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 10, 2019
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 9, 2019
@sftim
Copy link
Contributor

sftim commented Dec 11, 2019

Also see #18085

@sftim
Copy link
Contributor

sftim commented Dec 11, 2019

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 11, 2019
@sftim sftim mentioned this issue Jan 11, 2020
Closed
@sftim
Copy link
Contributor

sftim commented Feb 20, 2020

Also see #19176

@sftim sftim mentioned this issue Mar 7, 2020
Closed
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 20, 2020
@sftim
Copy link
Contributor

sftim commented Jun 14, 2020

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 14, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot
Copy link
Contributor

@sftim: Reopened this issue.

In response to this:

/reopen
/lifecycle frozen

We still need to do this

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 k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Aug 1, 2021
@sftim
Copy link
Contributor

sftim commented Aug 1, 2021

Closed issue #9122 is apposite too
/sig network
/triage accepted

@k8s-ci-robot k8s-ci-robot added sig/network Categorizes an issue or PR as relevant to SIG Network. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 1, 2021
@sftim
Copy link
Contributor

sftim commented Aug 1, 2021

Also relevant: issue #29107 (about the very first sentence)

@sftim
Copy link
Contributor

sftim commented Sep 27, 2021

Also see issue #29827

@sftim sftim mentioned this issue Oct 6, 2021
Merged
@sftim sftim mentioned this issue Dec 8, 2021
Closed
@sftim
Copy link
Contributor

sftim commented Mar 14, 2022

Also relevant: #32243

@sftim sftim moved this to In Progress in SIG Docs k/website Board Mar 23, 2022
@sftim sftim self-assigned this Mar 23, 2022
This was referenced Sep 7, 2022
Merged
Merged
Merged
Merged
Merged
Merged
Merged
This was referenced Nov 1, 2022
Closed
Merged
@sftim
Copy link
Contributor

sftim commented Dec 18, 2022

Also see #38542

@sftim
Copy link
Contributor

sftim commented May 16, 2023

This is mostly Done. We can open smaller issues - such as #41173 - to track specifics.

/close

@k8s-ci-robot
Copy link
Contributor

@sftim: Closing this issue.

In response to this:

This is mostly Done. We can open smaller issues - such as #41173 - to track specifics.

/close

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.

@github-project-automation github-project-automation bot moved this from In Progress to Done in SIG Docs k/website Board May 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sftim sftim

Labels
kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/network Categorizes an issue or PR as relevant to SIG Network. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Docs k/website Board
Status: Done
Milestone
No milestone
Development

No branches or pull requests
5 participants
@irvifa @MrHohn @k8s-ci-robot @sftim @fejta-bot