Skip to content
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
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

rainest
Copy link
Contributor

@rainest rainest commented Jun 25, 2024

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 to

{% if include.indent %}
{{ content | indent }}
{% else %}
{{ content }}
{% endif %}
per Lena.

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.

Copy link

netlify bot commented Jun 25, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit a0d106e
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/66a7fb06aa4452000892c823
😎 Deploy Preview https://deploy-preview-7578--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 93 (🟢 up 2 from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@rainest rainest force-pushed the doc/cross-namespace-plugin branch 2 times, most recently from 3ddd355 to 638ea04 Compare July 1, 2024 19:54
@rainest rainest force-pushed the doc/cross-namespace-plugin branch from 7c60602 to e09723b Compare July 16, 2024 23:02
@rainest rainest added review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:copyedit Request for writer review. review:sme Request for SME review, external to the docs team. labels Jul 17, 2024
@rainest rainest force-pushed the doc/cross-namespace-plugin branch from 75d9d20 to b2ca622 Compare July 17, 2024 01:00
@rainest rainest marked this pull request as ready for review July 17, 2024 01:02
@rainest rainest requested a review from a team as a code owner July 17, 2024 01:02
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.
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document cross namespace plugin attachment
3 participants