Repository navigation
docs: Add documentation for ListenerSets - #4568
Conversation
|
/retest |
1 similar comment
|
/retest |
| - [TCP routing](../tcp.md) | ||
| - [gRPC routing](../grpc-routing.md) | ||
|
|
||
| - [ListenerSets] (../listener-set.md) |
There was a problem hiding this comment.
| - [ListenerSets] (../listener-set.md) | |
| - [ListenerSets](../listener-set.md) |
There was a problem hiding this comment.
+1, would go one step further and recommend that both name and path share the same pluralization, so listener-sets.md
| spec: | ||
| parentRef: | ||
| name: parent-gateway | ||
| kind: Gateway |
There was a problem hiding this comment.
Only if it is in a different namespace
| A ListenerSet uses a parentRef to point to a specific Gateway | ||
|
|
||
| ```yaml | ||
| apiVersion: gateway.networking.k8s.io/v1 |
There was a problem hiding this comment.
For any examples that are a valid and complete resource, please use separate files in /examples and then embed them here - look at other guides for an example. Doing that allows our automated checks to ensure all the examples in our docs are valid.
There was a problem hiding this comment.
Thanks, updated
| - [TCP routing](../tcp.md) | ||
| - [gRPC routing](../grpc-routing.md) | ||
|
|
||
| - [ListenerSets] (../listener-set.md) |
There was a problem hiding this comment.
+1, would go one step further and recommend that both name and path share the same pluralization, so listener-sets.md
| certificateRefs: | ||
| - kind: Secret | ||
| group: "" | ||
| name: first-workload-cert # Provisioned via HTTP01 challenge |
There was a problem hiding this comment.
This comment doesn't really seem to make sense unless we're also showing users how to use a system that would provision a cert for them.
There was a problem hiding this comment.
Removed the comment
| is automatically marked with a `Conflicted: True` status and remains inactive until the higher-priority | ||
| resource is removed, ensuring a secure and predictable traffic flow. | ||
|
|
||
| ## Examples |
There was a problem hiding this comment.
I think the most critical example would likely be to show how to delegate TLS configuration to different namespaces. Likely with the following steps:
- Create Gateway that allows ListenerSets to attach from namespaces labeled
shared-gateway - Label 1 namespace
shared-gateway - Create a ListenerSet in that namespace and reference a TLS cert
This is not a blocker for this PR, just a suggestion for what might be more compelling, particularly for users coming from ingress-nginx.
There was a problem hiding this comment.
Updated the example and moved it to examples/standard
Co-authored-by: Suvin Nimnaka <hello@suvin.me> Co-authored-by: Rob Scott <rob.scott87@gmail.com>
|
/retest |
Co-authored-by: Nick Young <inocuo@gmail.com>
|
Thanks @youngnick I've applied the suggestions |
|
I think this looks pretty good now, so I'll approve and hold for other folks. /approve |
|
/retest |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: davidjumani, Suvink, youngnick The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/hold cancel now that 1.5 is out. 🙂 Thanks, @davidjumani! |
|
/lgtm |
* Add docs for listenerSets * add guide to index * fix markdown * add api type * update navigation * Apply suggestions from code review Co-authored-by: Suvin Nimnaka <hello@suvin.me> Co-authored-by: Rob Scott <rob.scott87@gmail.com> * address some more comments * update example * update doc * Apply suggestions from code review Co-authored-by: Nick Young <inocuo@gmail.com> --------- Co-authored-by: Suvin Nimnaka <hello@suvin.me> Co-authored-by: Rob Scott <rob.scott87@gmail.com> Co-authored-by: Nick Young <inocuo@gmail.com>
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR adds docs on ListenerSets which was promoted in v1.5
https://deploy-preview-4568--kubernetes-sigs-gateway-api.netlify.app/api-types/listenerset/
https://deploy-preview-4568--kubernetes-sigs-gateway-api.netlify.app/guides/listener-set/
Which issue(s) this PR fixes:
Ref #4249
Does this PR introduce a user-facing change?: