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.

Sign up for GitHub

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

Jump to bottom

Document the route kinds compatible for each protocolType #2263

Merged
merged 8 commits into from
Jun 21, 2024
Merged

Document the route kinds compatible for each protocolType #2263

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
49fdad0
Document the route kinds compatible for each protocolType
abs007 Feb 29, 2024
d97d5d3
Add changes
abs007 Mar 7, 2024
efd7923
Run make command
abs007 Mar 8, 2024
fa88a77
Fix grammar
abs007 Mar 14, 2024
62ab86d
Run make command
abs007 Mar 14, 2024
2f4ba59
Add suggested changes
abs007 Mar 30, 2024
cdf6d0b
Merge branch 'main' into Document-route-kinds-for-protocolType
shaneutt Jun 21, 2024
d5c2b0a
chore: run generators
shaneutt Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions apis/v1/gateway_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,15 @@ type AllowedRoutes struct {
//
// +optional
// +kubebuilder:validation:MaxItems=8
//
// The following list states the Route kinds compatible for each protocolType
shaneutt marked this conversation as resolved.
Show resolved Hide resolved
// for route kinds and protocolTypes included in Gateway API
//
// HTTP: HTTPRoutes, GRPCRoutes
// HTTPS: HTTPRoutes, GRPCRoutes, TLSRoute
shaneutt marked this conversation as resolved.
Show resolved Hide resolved
// TLS: TLSRoutes, TCPRoutes
// TCP: TCPRoutes
// UDP: UDPRoutes
Kinds []RouteGroupKind `json:"kinds,omitempty"`
}

Expand Down
56 changes: 28 additions & 28 deletions config/crd/experimental/gateway.networking.k8s.io_gateways.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 28 additions & 28 deletions config/crd/standard/gateway.networking.k8s.io_gateways.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions site-src/concepts/api-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,17 @@ following mechanisms:
If none of the above are specified, a Gateway listener will trust Routes
attached from the same namespace that support the listener protocol.

The following table shows the **Route kinds** compatible for each **protocolType**

|protocolType|core kind/s compatible|
|------------|----------------------|
| HTTP | HTTPRoutes, GRPCRoutes |
| HTTPS | HTTPRoutes, GRPCRoutes, TLSRoute |
shaneutt marked this conversation as resolved.
Show resolved Hide resolved
| TLS | TLSRoutes, TCPRoutes |
| TCP | TCPRoutes |
| UDP | UDPRoutes |


#### Further Gateway - Route attachment examples

The following `my-route` Route wants to attach to the `foo-gateway` in the
Expand Down