Add missing annotations to Docs #3264
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/S
antoineco
suggested changes
Oct 18, 2018
| @@ -44,6 +44,7 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz | |||
| |[nginx.ingress.kubernetes.io/limit-rps](#rate-limiting)|number| | |||
| |[nginx.ingress.kubernetes.io/permanent-redirect](#permanent-redirect)|string| | |||
| |[nginx.ingress.kubernetes.io/permanent-redirect-code](#permanent-redirect-code)|number| | |||
| |[nginx.ingress.kubernetes.io/temporal-redirect](#temporal-redirect)|string| | |||
There was a problem hiding this comment.
"-code" is missing in the anchor.
There was a problem hiding this comment.
OK, this is not a code so I'll correct the right place
| @@ -66,6 +67,7 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz | |||
| |[nginx.ingress.kubernetes.io/ssl-redirect](#server-side-https-enforcement-through-redirect)|"true" or "false"| | |||
| |[nginx.ingress.kubernetes.io/ssl-passthrough](#ssl-passthrough)|"true" or "false"| | |||
| |[nginx.ingress.kubernetes.io/upstream-hash-by](#custom-nginx-upstream-hashing)|string| | |||
| |[nginx.ingress.kubernetes.io/x-forwarded-prefix](#x-forwarded-prefix)|string| | |||
There was a problem hiding this comment.
"-header" is missing in the anchor.
| @@ -352,6 +354,9 @@ This annotation allows to return a permanent redirect instead of sending data to | |||
|
|
|||
| This annotation allows you to modify the status code used for permanent redirects. For example `nginx.ingress.kubernetes.io/permanent-redirect-code: '308'` would return your permanent-redirect with a 308. | |||
|
|
|||
| ### Temporal Redirect Code | |||
| This annotation allows you to return a temporal redirect (Return Code 302) instead of sendind data to the upstream. For example `nginx.ingress.kubernetes.io/temporal-redirect: https://www.google.com` would redirect everything to Google with a Return Code of 301 (Moved Temporarily) | |||
There was a problem hiding this comment.
You say 302, and then 301.
| @@ -352,6 +354,9 @@ This annotation allows to return a permanent redirect instead of sending data to | |||
|
|
|||
| This annotation allows you to modify the status code used for permanent redirects. For example `nginx.ingress.kubernetes.io/permanent-redirect-code: '308'` would return your permanent-redirect with a 308. | |||
|
|
|||
| ### Temporal Redirect Code | |||
There was a problem hiding this comment.
Is this really a "code"? Looks like a URL to me.
Add missing annotations to Docs Signed-off-by: Ricardo Pchevuzinske Katz <[email protected]>
|
@antoineco Corrected as asked! Thanks for the review |
|
/lgtm thanks! |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: antoineco, 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 |
k8s-ci-robot
added
the
approved
|
Merging. The error in e2e is being fixed in #3265 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it: This PR adds some missing annotations into Docs
Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close that issue when PR gets merged): fixes #3255Special notes for your reviewer: