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

Add stream-snippet as a ConfigMap and Annotation option #8029

Merged
merged 2 commits into from
Dec 23, 2021
Merged

Add stream-snippet as a ConfigMap and Annotation option #8029

merged 2 commits into from
Dec 23, 2021

Conversation

Eun
Copy link
Contributor

@Eun Eun commented Dec 10, 2021

What this PR does / why we need it:

This would make it possible to define extra configuration for the stream
context through the ConfigMap or an ingress annotation. e2e tests have been created for the new functionality.

This resolves the issue #4479 and replaces the pr #6404

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)
  • Documentation only

Which issue/s this PR fixes

fixes #4479
replaces #6404

How Has This Been Tested?

added e2e tests

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 k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Dec 10, 2021
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 10, 2021

CLA Signed

The committers are authorized under a signed CLA.

  • ✅ Tobias Salzmann (b83fc78469482273b8e934c24b59cf8319116f24)

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


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 cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 10, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @Eun!

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 k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority labels Dec 10, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @Eun. 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 the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 10, 2021
@Eun Eun changed the title Add stream-snippet as a ConfigMap and Annotation option (closes #4479) Add stream-snippet as a ConfigMap and Annotation option Dec 10, 2021
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 10, 2021
Copy link
Contributor

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

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

Thanks @Eun

/triage accepted
/priority important-longterm

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority labels Dec 10, 2021
@iamNoah1
Copy link
Contributor

/kind feature

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. and removed needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Dec 10, 2021
@rikatz
Copy link
Contributor

rikatz commented Dec 12, 2021

/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 Dec 12, 2021
Copy link
Contributor

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

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

@Eun

Please see go sec linting, that failed

@Eun
Copy link
Contributor Author

Eun commented Dec 14, 2021

@iamNoah1 I already checked the linter output, however this is not related to this pull request since the same errors also appear on all other commits: https://github.com/kubernetes/ingress-nginx/commits/main

Please advice how I should proceed.

@iamNoah1
Copy link
Contributor

@Eun good point. @rikatz how should we proceed here?

@rikatz
Copy link
Contributor

rikatz commented Dec 15, 2021

/assign IamNoah1

@Eun
Copy link
Contributor Author

Eun commented Dec 20, 2021

(I rebased, this fixed the security issue)

@rikatz rikatz self-assigned this Dec 21, 2021
ginkgo.It("should add value of stream-snippet to nginx config", func() {
host := "foo.com"

snippet := `server {listen 8000; proxy_pass 127.0.0.1:80;}`
Copy link
Contributor

Choose a reason for hiding this comment

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

This can be used for good, and for evil :)

I'm really worried nowadays about allowing more snippets directives, will need to think a bit better on this.

@rikatz
Copy link
Contributor

rikatz commented Dec 23, 2021

Spoke with @strongjz and we can merge this. We need tho to keep a good eye on this snippet directives, as they have been our main CVE cases :)

As soon as we can ship some privilege separation between control and dataplane I will be more comfortable with this.

/approve
/lgtm
Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 23, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Eun, rikatz

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 Dec 23, 2021
@k8s-ci-robot k8s-ci-robot merged commit ce9deaa into kubernetes:main Dec 23, 2021
@Preetham777
Copy link

Does this commit clearly handle all the stream directives?
Also is there a support or plan for this : https://docs.nginx.com/nginx/admin-guide/security-controls/terminating-ssl-tcp/#complete-example

@Eun
Copy link
Contributor Author

Eun commented Jan 4, 2022

Well this pr just adds the capability to use the stream snippet, the functionality is dependent on the nginx build.
Since the nginx binary in ingress-nginx is currently built with --with-stream_ssl_module, ssl termination should be available.

@rikatz rikatz added this to the v1.1.1 milestone Jan 9, 2022
rchshld pushed a commit to joomcode/ingress-nginx that referenced this pull request May 19, 2023
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. area/docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. 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. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request for stream-snippet
5 participants