Updates route godocs in gateway API type

kubernetes-sigs · Feb 25, 2020 · ac8b39b · ac8b39b
1 parent f3d1e48
commit ac8b39b
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 141 deletions.
diff --git a/api/v1alpha1/gateway_types.go b/api/v1alpha1/gateway_types.go
@@ -56,10 +56,18 @@ type GatewaySpec struct {
 	// Listeners associated with this Gateway. Listeners define what addresses,
 	// ports, protocols are bound on this Gateway.
 	Listeners []Listener `json:"listeners"`
-	// Routes associated with this Gateway. Routes define protocol-specific
-	// routing to backends (e.g. Services).  Typically the resource is
-	// "httproute" or "tcproute" in group "networking.x.k8s.io", or an
+	// Routes is a list of resources to associate with the Gateway. A route is a
+	// resource capable of servicing a request and allows a cluster operator to
+	// expose a cluster resource (i.e. Service) by externally-reachable URL,
+	// load-balance traffic and terminate SSL/TLS. Typically, a route is a
+	// "httproute" or "tcproute" in group "networking.x.k8s.io". However, an
 	// implementation may support other resources.
+	//
+	// If unspecified, no routes will be associated to the Gateway.
+	//
+	// Support: Core
+	//
+	// +optional
 	Routes []RouteObjectReference `json:"routes"`
 }
 

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/networking.x.k8s.io_gateways.yaml b/config/crd/bases/networking.x.k8s.io_gateways.yaml
@@ -172,10 +172,13 @@ spec:
                 type: object
               type: array
             routes:
-              description: Routes associated with this Gateway. Routes define protocol-specific
-                routing to backends (e.g. Services).  Typically the resource is "httproute"
-                or "tcproute" in group "networking.x.k8s.io", or an implementation
-                may support other resources.
+              description: "Routes is a list of resources to associate with the Gateway.
+                A route is a resource capable of servicing a request and allows a
+                cluster operator to expose a cluster resource (i.e. Service) by externally-reachable
+                URL, load-balance traffic and terminate SSL/TLS. Typically, a route
+                is a \"httproute\" or \"tcproute\" in group \"networking.x.k8s.io\".
+                However, an implementation may support other resources. \n If unspecified,
+                no routes will be associated to the Gateway. \n Support: Core"
               items:
                 description: LocalObjectReference identifies an API object within
                   a known namespace.
@@ -199,7 +202,6 @@ spec:
           required:
           - class
           - listeners
-          - routes
           type: object
         status:
           description: GatewayStatus defines the observed state of Gateway.