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

Document Service Traffic Policies #28981

Closed
wants to merge 2 commits into from
Closed

Document Service Traffic Policies #28981

wants to merge 2 commits into from

Conversation

andrewsykim
Copy link
Member

@andrewsykim andrewsykim commented Jul 16, 2021 •
edited
Loading

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

Documents traffic policies that can be set for Services. This PR adds documentation for both internalTrafficPolicy and externalTrafficPolicy. externalTrafficPolicy has always existed and is not new, but I realized the services document didn't have any explicit mention of it so I added it here. internalTrafficPolicy is a new feature we promoted to beta in v1.22. This PR also documents the new ProxyTerminatingEndpoints feature (alpha) and it's relation to externalTrafficPolicy.

Related KEPS:
kubernetes/enhancements#2086
kubernetes/enhancements#1669

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

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign onlydole after the PR has been reviewed.
You can assign the PR to them by writing /assign @onlydole 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:

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 language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jul 16, 2021
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 16, 2021
@netlify
Copy link

netlify bot commented Jul 16, 2021

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: a1cad5e

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/60f1e4c7e6ff4c0007d4cb7c

😎 Browse the preview: https://deploy-preview-28981--kubernetes-io-main-staging.netlify.app

@netlify
Copy link

netlify bot commented Jul 16, 2021 •
edited
Loading

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: 7bec0db

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/60f1e8d6c9f7d70008b9cd9c

😎 Browse the preview: https://deploy-preview-28981--kubernetes-io-main-staging.netlify.app/docs/concepts/services-networking/service

@andrewsykim andrewsykim changed the title [WIP] Document Service Traffic Policies [Document Service Traffic Policies Jul 16, 2021
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 16, 2021
@andrewsykim andrewsykim changed the title [Document Service Traffic Policies Document Service Traffic Policies Jul 16, 2021
andrewsykim
andrewsykim commented Jul 16, 2021
View reviewed changes
content/en/docs/concepts/services-networking/service.md

{{< note >}}
{{< feature-state for_k8s_version="v1.22" state="alpha" >}}
If the feature gate ProxyTerminatingEndpoints is enabled from kube-proxy, it will route traffic to terminating endpoints
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 struggled a bit with writing this section, the problem is quite nuanced and hard to articulate in a simple way. Definitely open to suggestions on how to improve the wording here

@andrewsykim
Copy link
Member Author

/assign @thockin @robscott @maplain

For technical review

@PI-Victor
Copy link
Member

PI-Victor commented Jul 19, 2021 •
edited
Loading

@andrewsykim please change the branch to dev-1.22

/assign @carlisia @ritpanjw
@carlisia @ritpanjw since this covers both #1669 and #2086 in k/enhancements i'm assign this to both
/sig network

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

@andrewsykim please change the branch to dev-1.22 this PR is targeted at the wrong branch

@andrewsykim
Copy link
Member Author

Sorry, let me do that now

@andrewsykim andrewsykim mentioned this pull request Jul 26, 2021
Closed
@andrewsykim
Copy link
Member Author

#29121

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

@daminisatya daminisatya Awaiting requested review from daminisatya

@kbarnard10 kbarnard10 Awaiting requested review from kbarnard10

Assignees

@carlisia carlisia

@robscott robscott

@maplain maplain

@thockin thockin

@ritpanjw ritpanjw

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@andrewsykim @k8s-ci-robot @PI-Victor @carlisia @robscott @maplain @thockin @ritpanjw