Basic-Auth doc misleading: fix double quotes leading to nginx config error #2770
Conversation
Annotation value is being inserted in nginx config with something like "$var". If one inserts an annotation value like `"my basic auth message"` (with double quotes) the resulting nginx config will be `""my basic auth""`
k8s-ci-robot
added
the
size/XS
|
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
added
the
cncf-cla: no
Codecov Report
@@ Coverage Diff @@
## master #2770 +/- ##
=======================================
Coverage 40.87% 40.87%
=======================================
Files 73 73
Lines 5108 5108
=======================================
Hits 2088 2088
Misses 2731 2731
Partials 289 289Continue to review full report at Codecov.
|
k8s-ci-robot
added
cncf-cla: yes
|
/assign @bowei |
docs/examples/auth/basic/README.md
Outdated
| @@ -40,7 +40,7 @@ metadata: | |||
| # name of the secret that contains the user/password definitions | |||
| nginx.ingress.kubernetes.io/auth-secret: basic-auth | |||
| # message to display with an appropriate context why the authentication is required | |||
| nginx.ingress.kubernetes.io/auth-realm: "Authentication Required - foo" | |||
| nginx.ingress.kubernetes.io/auth-realm: Authentication Required - foo | |||
There was a problem hiding this comment.
Indeed, double quotes should be avoided as much as possible in YAML. However I'd prefer to see single quotes here for clarity.
|
@chrisingenhaag please don't assign PRs manually |
|
ping @chrisingenhaag |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: antoineco, chrisingenhaag 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 |
k8s-ci-robot
added
the
approved
|
Merging. Only docs. |
|
@chrisingenhaag thanks! |
Annotation value is being inserted in nginx config with something like "$var". If one inserts an annotation value like
"my basic auth message"(with double quotes) the resulting nginx config will be""my basic auth"". But this config is wrong and basic-auth won´t work.What this PR does / why we need it:
Special notes for your reviewer: Documentation is misleading and suggests to use quotes for realm message with basic-auth annotations.