Skip to content

Add more context to the PROXY protocol gateway config section #12510

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
Merged
merged 7 commits into from
Jan 24, 2023
Merged

Add more context to the PROXY protocol gateway config section #12510

merged 7 commits into from
Jan 24, 2023

Conversation

bleggett
Copy link
Contributor

@bleggett bleggett commented Jan 24, 2023 •
edited
Loading

Add some more detail to the currently (somewhat sparse) PROXY protocol gateway config section.

  • PROXY protocol should only be used for TCP traffic - echo the upstream Envoy docs in strongly encouraging people to not use it with L7 load balancers/traffic.

  • Add more context around what it is, where to use it, and more pointers to Envoy docs with specifics.

Associated with istio/istio#42962

EDIT: As per discussion in istio/istio#42962 (comment), removing the experimental tag from the doc - we do not support PROXY protocol at all in Istio and it is not in any current feature matrix, but it may be enabled via EnvoyFilter, which is a feature that already has its own status.

  • Configuration Infrastructure
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Policies and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure

@bleggett bleggett requested a review from a team as a code owner January 24, 2023 01:03
@istio-policy-bot
Copy link

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been awhile since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, about our style guidelines,
    and about all the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be
    built as a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the Status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top notch. We do spell checking, we sanitize the markdown, we ensure all hyperlinks point
    to valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    status section of the page. Click on the Details link to get a list of the problems with your PR.
    Fix those problems and push an update to your PR. This will automatically rerun the tests and
    hopefully this time everything will be perfect.

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test labels Jan 24, 2023
@istio-testing
Copy link
Contributor

Hi @bleggett. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@bleggett bleggett mentioned this pull request Jan 24, 2023
Merged
@ericvn
Copy link
Contributor

ericvn commented Jan 24, 2023

/ok-to-test

@istio-testing istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Jan 24, 2023
bleggett and others added 5 commits January 24, 2023 09:50
@bleggett @frankbu
Update content/en/docs/ops/configuration/traffic-management/network-t…
461d408 
…opologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
@bleggett @frankbu
Update content/en/docs/ops/configuration/traffic-management/network-t…
966db06 
…opologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
@bleggett @frankbu
Update content/en/docs/ops/configuration/traffic-management/network-t…
723efe0 
…opologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
@bleggett @frankbu
Update content/en/docs/ops/configuration/traffic-management/network-t…
1e10742 
…opologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
@bleggett
As per discuss in istio/istio#42962 (comment)
fc8b46c
@bleggett
Copy link
Contributor Author

As per discussion in istio/istio#42962 (comment), removing the experimental tag from the doc - we do not support PROXY protocol at all in Istio and it is not in any current feature matrix, but it may be enabled via EnvoyFilter, which is a feature that already has its own status.

@bleggett bleggett requested a review from frankbu January 24, 2023 19:52
frankbu
frankbu approved these changes Jan 24, 2023
View reviewed changes
Copy link
Collaborator

@frankbu frankbu left a comment

Choose a reason for hiding this comment

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

LGTM

@istio-testing istio-testing merged commit a204008 into istio:master Jan 24, 2023
@bleggett bleggett deleted the proxy-proto-docs branch January 24, 2023 21:25
@bleggett bleggett mentioned this pull request Jan 25, 2023
Merged
5 tasks
justedennnnn pushed a commit to justedennnnn/istio.io that referenced this pull request Jun 29, 2023
@bleggett @frankbu @justedennnnn
Add more context to the PROXY protocol gateway config section (istio#…
1aeece8 
…12510)

* Add more context

* Update content/en/docs/ops/configuration/traffic-management/network-topologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

* Update content/en/docs/ops/configuration/traffic-management/network-topologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

* Update content/en/docs/ops/configuration/traffic-management/network-topologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

* Update content/en/docs/ops/configuration/traffic-management/network-topologies/index.md

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

* As per discuss in istio/istio#42962 (comment)

* Lint fix

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frankbu frankbu frankbu approved these changes

Assignees
No one assigned
Labels
ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. 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.
5 participants
@bleggett @istio-policy-bot @istio-testing @ericvn @frankbu