Document the route kinds compatible for each protocolType (kubernetes…

…-sigs#2263) * Document the route kinds compatible for each protocolType Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Fix grammar Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add suggested changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * chore: run generators --------- Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> Co-authored-by: Shane Utt <shaneutt@linux.com>
BobyMCbobs · Jun 21, 2024 · a518fef · a518fef
1 parent 02581a1
commit a518fef
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 57 deletions.
diff --git a/apis/v1/gateway_types.go b/apis/v1/gateway_types.go
@@ -526,6 +526,15 @@ type AllowedRoutes struct {
 	//
 	// +optional
 	// +kubebuilder:validation:MaxItems=8
+	//
+	// The following list states the Route kinds compatible for each protocolType
+	// for route kinds and protocolTypes included in Gateway API
+	//
+	// HTTP: HTTPRoutes, GRPCRoutes
+	// HTTPS: HTTPRoutes, GRPCRoutes, TLSRoutes
+	// TLS: TLSRoutes, TCPRoutes
+	// TCP: TCPRoutes
+	// UDP:	UDPRoutes
 	Kinds []RouteGroupKind `json:"kinds,omitempty"`
 }
 

diff --git a/config/crd/experimental/gateway.networking.k8s.io_gateways.yaml b/config/crd/experimental/gateway.networking.k8s.io_gateways.yaml
diff --git a/config/crd/standard/gateway.networking.k8s.io_gateways.yaml b/config/crd/standard/gateway.networking.k8s.io_gateways.yaml
diff --git a/pkg/generated/openapi/zz_generated.openapi.go b/pkg/generated/openapi/zz_generated.openapi.go
diff --git a/site-src/concepts/api-overview.md b/site-src/concepts/api-overview.md
@@ -260,6 +260,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, TLSRoutes |
+| 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