site: Update annotations doc with better ingress.class information #2420
Conversation
This file contains hidden or 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
894eb15 to
31dd524
Compare
Codecov Report
@@ Coverage Diff @@
## master #2420 +/- ##
=======================================
Coverage 76.98% 76.98%
=======================================
Files 66 66
Lines 5475 5475
=======================================
Hits 4215 4215
Misses 1164 1164
Partials 96 96 Continue to review full report at Codecov.
|
31dd524 to
eea5fd5
Compare
jpeach
suggested changes
Apr 8, 2020
Contributor
jpeach
left a comment
There was a problem hiding this comment.
Great to capture this info!
eea5fd5 to
dc43090
Compare
jpeach
approved these changes
Apr 8, 2020
site/docs/master/annotations.md
Outdated
| ## Contour specific HTTPProxy annotations | ||
| - `projectcontour.io/ingress.class`: The Ingress class that should interpret and serve the HTTPProxy. If not set, then all all Contour instances serve the HTTPProxy. If specified as `projectcontour.io/ingress.class: contour`, then Contour serves the HTTPProxy and any others that have no annotation defined. If any other value, Contour ignores the HTTPProxy definition. | ||
| You can override the default class `contour` with the `--ingress-class-name` flag at runtime. | ||
| - `projectcontour.io/ingress.class`: The Ingress class that should interpret and serve the HTTPProxy.See the [main ingress-class annotation section](#ingress-class) for more details. |
Contributor
There was a problem hiding this comment.
- space after the
. - "main Ingress class annotation section"
site/docs/master/annotations.md
Outdated
| ## Contour specific Ingress annotations | ||
|
|
||
| - `projectcontour.io/ingress.class`: The Ingress class that should interpret and serve the Ingress. If not set, then all Ingress controllers serve the Ingress. If specified as `projectcontour.io/ingress.class: contour`, then Contour serves the Ingress. If any other value, Contour ignores the Ingress definition. You can override the default class `contour` with the `--ingress-class-name` flag at runtime. This can be useful while you are migrating from another controller, or if you need multiple instances of Contour. | ||
| - `projectcontour.io/ingress.class`: The Ingress class that should interpret and serve the Ingress. See the [main ingress-class annotation section](#ingress-class) for more details. |
Contributor
There was a problem hiding this comment.
"main Ingress class annotation section"
dc43090 to
e62b893
Compare
Signed-off-by: Nick Young <[email protected]>
e62b893 to
b5c97bc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Signed-off-by: Nick Young [email protected]