Skip to content

Commit 3ec7311

Browse files
authored
Merge pull request #1082 from cxhiano/1021-doc
Provide more details on route parentRef in documentation for routes <> Gateways attachment.
2 parents bae59a6 + 5dbaa40 commit 3ec7311

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

site-src/concepts/api-overview.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,31 @@ The following is required for a Route to be attached to a Gateway:
171171
1. The Route needs an entry in its `parentRefs` field referencing the Gateway.
172172
2. At least one listener on the Gateway needs to allow this attachment.
173173

174+
#### Referencing Gateways
175+
176+
!!! info "Experimental Channel"
177+
178+
The `Port` field described below is currently only included in the
179+
"Experimental" channel of Gateway API. For more information on release
180+
channels, refer to the [related documentation](https://gateway-api.sigs.k8s.io/concepts/versioning/#adding-experimental-fields).
181+
182+
A Route can reference a Gateway by specifying the namespace (optional if the
183+
Route and the Gateway are in the same namespace) and name of the Gateway in
184+
a `parentRef`. A Route can further select a subset of listeners under the
185+
Gateway using the following fields in `parentRef`:
186+
187+
1. **SectionName** When `sectionName` is set, the Route selects the listener
188+
with the specified name.
189+
2. **Port** When `port` is set, the Route selects all listeners listening on
190+
the specified port and with protocol compatible with this kind of Route.
191+
192+
When multiple fields in `parentRef` are set, the Route selects listeners that
193+
satisfy all conditions specified in those fields. For example, when both
194+
`sectionName` and `port` are set, the Route selects listeners with the specified
195+
name AND listening on the specified port.
196+
197+
#### Restricting Route Attachment
198+
174199
Each Gateway listener can restrict which Routes can be attached with the
175200
following mechanisms:
176201

0 commit comments

Comments
 (0)