Skip to content
This repository was archived by the owner on Feb 22, 2022. It is now read-only.

[stable/nginx-ingress] replace ambiguous controller.headers option#16217

Merged
k8s-ci-robot merged 3 commits intohelm:masterfrom
jwalker343:master
Aug 12, 2019
Merged

[stable/nginx-ingress] replace ambiguous controller.headers option#16217
k8s-ci-robot merged 3 commits intohelm:masterfrom
jwalker343:master

Conversation

@jwalker343
Copy link
Copy Markdown
Contributor

@jwalker343 jwalker343 commented Aug 9, 2019 •
edited
Loading

What this PR does / why we need it:

controller.headers is ambiguous because the headers can be added to the client response, or as the request is passed to the backend. Here are the relevant nginx-ingress configuration options:

This PR replaces the ambiguous config with two commands handling both use cases.

Special notes for your reviewer:

First contribution, all feedback appreciated.

Specifically Looking for feedback on the best way to handle deprecating the option, as-is if someone is using that option it will stop working, hence the major version bump.

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

  • DCO signed
  • Chart Version bumped
  • Variables are documented in the README.md
  • Title of the PR starts with chart name (e.g. [stable/chart])

@jwalker343
[stable/nginx-ingress] deprecate ambiguous controller.headers option …
4ec0e37 
…and add configuration for add-headers.

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>
@helm-bot helm-bot added Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 9, 2019
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Aug 9, 2019

Hi @jwalker343. Thanks for your PR.

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

Details

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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 9, 2019
@jwalker343
Copy link
Copy Markdown
Contributor Author

jwalker343 commented Aug 9, 2019

/assign @taharah

taharah
taharah suggested changes Aug 11, 2019
View reviewed changes
@helm-bot helm-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 12, 2019
@jwalker343
[stable/nginx-ingress] flex controller.headers with new controller.pr…
88fca84 
…oxySetHeaders

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>
@jwalker343
Copy link
Copy Markdown
Contributor Author

jwalker343 commented Aug 12, 2019

@taharah I've updated the PR so that controller.headers can flex with controller.proxySetHeaders so that this is not a breaking change.

I did leave controller.headers as deprecated in the readme

ChiefAlexander
ChiefAlexander suggested changes Aug 12, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@ChiefAlexander ChiefAlexander left a comment

Choose a reason for hiding this comment

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

Looking good. Can I also get you to create a test to use your new values.

@ChiefAlexander
Copy link
Copy Markdown
Contributor

ChiefAlexander commented Aug 12, 2019

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 12, 2019
@jwalker343
[stable/nginx-ingress] Include tests, proper version and notes.txt no…
402410b 
…tice

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>
@jwalker343
Copy link
Copy Markdown
Contributor Author

jwalker343 commented Aug 12, 2019

@ChiefAlexander Updated with bump to the version, notice in notes.txt and also added value testing in the ci folder.

@ChiefAlexander
Copy link
Copy Markdown
Contributor

ChiefAlexander commented Aug 12, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 12, 2019
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Aug 12, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ChiefAlexander, jwalker343

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

The pull request process is described here

Details 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 Aug 12, 2019
@k8s-ci-robot k8s-ci-robot merged commit 4003548 into helm:master Aug 12, 2019
ThoTischner pushed a commit to bitsbeats/charts that referenced this pull request Aug 13, 2019
@jwalker343
[stable/nginx-ingress] replace ambiguous controller.headers option (h…
0a4178b 
…elm#16217)

* [stable/nginx-ingress] deprecate ambiguous controller.headers option and add configuration for add-headers.

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] flex controller.headers with new controller.proxySetHeaders

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] Include tests, proper version and notes.txt notice

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>
landorg pushed a commit to landorg/charts that referenced this pull request Aug 19, 2019
@jwalker343 @landorg
[stable/nginx-ingress] replace ambiguous controller.headers option (h…
d738b82 
…elm#16217)

* [stable/nginx-ingress] deprecate ambiguous controller.headers option and add configuration for add-headers.

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] flex controller.headers with new controller.proxySetHeaders

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] Include tests, proper version and notes.txt notice

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>
Signed-off-by: Roland Gritzer <gritzer.roland@gmail.com>
kengou pushed a commit to kengou/charts that referenced this pull request Sep 18, 2019
@jwalker343 @kengou
[stable/nginx-ingress] replace ambiguous controller.headers option (h…
2a0c450 
…elm#16217)

* [stable/nginx-ingress] deprecate ambiguous controller.headers option and add configuration for add-headers.

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] flex controller.headers with new controller.proxySetHeaders

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] Include tests, proper version and notes.txt notice

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>
ramkumarvs pushed a commit to yugabyte/charts-helm-fork that referenced this pull request Sep 30, 2019
@jwalker343
[stable/nginx-ingress] replace ambiguous controller.headers option (h…
9050636 
…elm#16217)

* [stable/nginx-ingress] deprecate ambiguous controller.headers option and add configuration for add-headers.

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] flex controller.headers with new controller.proxySetHeaders

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>

* [stable/nginx-ingress] Include tests, proper version and notes.txt notice

Signed-off-by: Johnny Walker <johnny.walker@spinen.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

2 more reviewers

@taharah taharah taharah requested changes

@ChiefAlexander ChiefAlexander ChiefAlexander requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

@taharah taharah

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). lgtm Indicates that a PR is ready to be merged. ok-to-test size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jwalker343 @k8s-ci-robot @ChiefAlexander @taharah @helm-bot