-
Notifications
You must be signed in to change notification settings - Fork 605
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
KGO: add guide for kongpluginbinding #8049
Conversation
|
Name | Link |
---|---|
🔨 Latest commit | 4889778 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@randmonkey Can you please add an example of how to bind to a service and a consumer at the same time?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some nits with suggestions.
I think it may be beneficial to include actual curl
commands for testing if something is properly configured from actual client PoV, WDYT?
f3a95d5
to
2c33a63
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please update the nav file with the link to this new guide? Otherwise it won't get generated.
You'll need to add an entry to the Guides section here: https://github.com/randmonkey/docs.konghq.com/blob/kgo/guide_kongpluginbinding/app/_data/docs_nav_kgo_1.4.x.yml#L77
with:
- text: Managing Plugin Bindings in Konnect by CRD
url: /guides/konnect-plugin-binding/
We should also mention that depending on the types in the combination, in most of the cases (service + consumer, service + consumer group, route + consumer, route + consumer group), we generate just one Plugin attached to multiple objects, while for others (service + route), we generate a plugin per object. |
rate-limiting-minute-10-a0z1x KongPlugin rate-limiting-minute-10 True | ||
``` | ||
|
||
#### Attaching Plugins to Multiple Entities |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd add a table to this section showing what combinations of entities will be produced when using konghq.com/plugins
annotation.
This can be based on https://github.com/Kong/gateway-operator/blob/f189f2d3972fe08122bb27ead06152132ee791a0/controller/konnect/reconciler_kongplugin_combinations_test.go.
So for instance if service and route have the annotation we produce 2 plugins: 1 for service and 1 for route.
When service and consumer have the annotation: we produce 1 plugin binding both to the plugin.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added suggestions for title headings according to the style guide
https://docs.konghq.com/contributing/style-guide/#headings-and-page-titles
ba8d057
to
918c312
Compare
Co-authored-by: Jakub Warczarek <[email protected]> Co-authored-by: Grzegorz Burzyński <[email protected]> Co-authored-by: Angel <[email protected]>
Co-authored-by: Angel <[email protected]>
918c312
to
9384c6e
Compare
@mheap's point has been addressed in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm OK merging this as is. I'll handle adding the nav entry and note mentioned by @czeslavo in a separate PR.
Description
Add guide page for using
KongPluginBinding
to configure plugins with Konnect.Fixes Kong/gateway-operator#568.
Dependent on #8034 for adding navigator page for KGO 1.4.
Testing instructions
Preview link:
Checklist