Add class annotations to K8S plugin examples #2347
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
Add "kubernetes.io/ingress.class: kong" annotations to Ingress, KongConsumer, and global KongClusterPlugin examples. As of controller 0.10.0, this annotation is required by default on these resources, and our examples should include them as such. Adding this annotation does not create issues for older versions--they were simply more permissive about when they permitted resources that lacked them by default, but still work fine when the annotation is present.
|
Deploy preview for kongdocs ready! Built with commit e2d78aa |
lena-larionova
approved these changes
Oct 2, 2020
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.
Add
kubernetes.io/ingress.class: kongannotations to Ingress, KongConsumer, and global KongClusterPlugin examples. As of controller 0.10.0, this annotation is required by default on these resources, and our examples should include them as such. Adding this annotationdoes not create issues for older versions--they were simply more permissive about when they permitted resources that lacked them by default, but still work fine when the annotation is present.
Minor note is that this annotation should have a different value when using a non-standard class, e.g.
kubernetes.io/ingress.class: mycustomclass. Usingkubernetes.io/ingress.class: kongwith a custom class will in fact exclude those resources when using some other class. However, as users must intentionally set a custom class and adapt examples elsewhere to their environment, we can reasonably expect them to be aware that they need to change the value if they use one.Submitted as a result of Kong/kubernetes-ingress-controller#884