-
Notifications
You must be signed in to change notification settings - Fork 589
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add cross-namespace KongPlugin doc #7578
Open
rainest
wants to merge
6
commits into
main
Choose a base branch
from
doc/cross-namespace-plugin
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
✅ Deploy Preview for kongdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
3ddd355
to
638ea04
Compare
7c60602
to
e09723b
Compare
75d9d20
to
b2ca622
Compare
Modify the example Gateway resource's Listener to allow routes from any namespace, for compatibility with docs that do not use the default namespace only.
b2ca622
to
d9430c9
Compare
randmonkey
approved these changes
Aug 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Kubernetes Team
Kubernetes task tracking (including KIC)
review:copyedit
Request for writer review.
review:general
Review for general accuracy and presentation. Does the doc work? Does it output correctly?
review:sme
Request for SME review, external to the docs team.
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.
Description
Add a new KIC guide for cross-namespace KongPlugin management using ReferenceGrants.
Fixes Kong/kubernetes-ingress-controller#6130
Testing instructions
Preview link:
https://deploy-preview-7578--kongdocs.netlify.app/kubernetes-ingress-controller/3.2.x/get-started/ for the change to allow routes from any namespace in the stock Gateway example.
https://deploy-preview-7578--kongdocs.netlify.app/kubernetes-ingress-controller/latest/plugins/cross-namespace/ for the new guide.
Reviewer notes
KIC 3.2.0 has a bug that breaks the cross-namespace functionality. This bug is fixed in 3.2.3.
Vale is mad about the "Luka" name from the Google style guide name list. I forget where to tell it to ignore that.
Something weird is happening with the consumer include that changes the entire thing into a code block. Dunno how to fix that in Jekyll.a0d106e fixes this. Apparently Markdown is a bit screwy re includes and indents, and will treat four spaces as a code block request unless it's in a list. Upshot of this is that the include currently can only be used if it's in a list. I was able to rework to that here fine, but we may want to try using an optional indent filter similar todocs.konghq.com/app/_includes/md/k8s/controller-install-tabs.md
Lines 18 to 22 in 8716c92
Checklist
This has a version/GWAPI prereq disclaimer instead of conditional tags, since the entire guide has a version requirement. It's only in 3.2 in the nav.