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.

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

Fix proxy protocol support for X-Forwarded-Port #4956

Merged
merged 1 commit into from
Jan 26, 2020

Conversation

djboris9
Copy link
Contributor

@djboris9 djboris9 commented Jan 24, 2020

This PR fixes issue #4951 by using the $proxy_protocol_server_port value
as X-Forwarded-Port, when Proxy Protocol is enabled.

What this PR does / why we need it:

  • The nginx.tmpl was changed to assign $proxy_protocol_server_port as pass_server_port
    value when Proxy Protocol is enabled.
  • lua_ingress.lua had to be adjusted in order not to overwrite pass_server_port as it's already set in nginx.tmpl.
  • The Proxy Protocol E2E test was updated to validate the correct X-Forwarded-Port.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Which issue/s this PR fixes

fixes #4951

How Has This Been Tested?

Ran the E2E test suite and testet it in our lab environment with Proxy Protocol enabled and disabled.
https was only tested without TLS passthrough on our lab.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 24, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @djboris9!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @djboris9. Thanks for your PR.

I'm waiting for a kubernetes 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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 24, 2020
@djboris9
Copy link
Contributor Author

I signed it

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 24, 2020
@djboris9
Copy link
Contributor Author

/assign @aledbf

@aledbf
Copy link
Member

aledbf commented Jan 24, 2020

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 24, 2020
@codecov-io
Copy link

codecov-io commented Jan 24, 2020

Codecov Report

Merging #4956 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #4956      +/-   ##
=========================================
+ Coverage   58.48%   58.5%   +0.01%     
=========================================
  Files          88      88              
  Lines        6728    7119     +391     
=========================================
+ Hits         3935    4165     +230     
- Misses       2363    2497     +134     
- Partials      430     457      +27
Impacted Files Coverage Δ
internal/ingress/metric/collectors/socket.go 79.12% <0%> (+0.15%) ⬆️
internal/ingress/controller/template/template.go 79.97% <0%> (+0.36%) ⬆️
cmd/nginx/main.go 6.91% <0%> (+0.42%) ⬆️
internal/ingress/types_equals.go 20.72% <0%> (+3.23%) ⬆️
internal/ingress/controller/nginx.go 33.2% <0%> (+3.51%) ⬆️
internal/ingress/annotations/opentracing/main.go 63.15% <0%> (+9.31%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12aa726...665f924. Read the comment docs.

@aledbf
Copy link
Member

aledbf commented Jan 24, 2020

/retest

@aledbf
Copy link
Member

aledbf commented Jan 24, 2020

@djboris9 just in case the failures are not related to your change

@djboris9
Copy link
Contributor Author

/retest

1 similar comment
@djboris9
Copy link
Contributor Author

/retest

@aledbf
Copy link
Member

aledbf commented Jan 26, 2020

This variable is available since NGINX v1.17.6

@aledbf
Copy link
Member

aledbf commented Jan 26, 2020

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 26, 2020
@aledbf
Copy link
Member

aledbf commented Jan 26, 2020

@djboris9 thanks!

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, djboris9

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

The pull request process is described 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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 26, 2020
@k8s-ci-robot k8s-ci-robot merged commit 2f8cbeb into kubernetes:master Jan 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proxy protocol support for X-Forwarded-Port
4 participants