diff --git a/apis/v1alpha1/shared_types.go b/apis/v1alpha1/shared_types.go index 5f08e348e1..8f0af62184 100644 --- a/apis/v1alpha1/shared_types.go +++ b/apis/v1alpha1/shared_types.go @@ -187,10 +187,10 @@ type RouteGatewayStatus struct { GatewayRef GatewayReference `json:"gatewayRef"` // Conditions describes the status of the route with respect to the - // Gateway. For example, the "Admitted" condition indicates whether the - // route has been admitted or rejected by the Gateway, and why. Note - // that the route's availability is also subject to the Gateway's own - // status conditions and listener status. + // Gateway. The "Admitted" condition must always be specified by controllers + // to indicate whether the route has been admitted or rejected by the Gateway, + // and why. Note that the route's availability is also subject to the Gateway's + // own status conditions and listener status. // // +listType=map // +listMapKey=type @@ -201,16 +201,17 @@ type RouteGatewayStatus struct { // RouteStatus defines the observed state that is required across // all route types. type RouteStatus struct { - // Gateways is a list of the Gateways that are associated with the - // route, and the status of the route with respect to each of these - // Gateways. When a Gateway selects this route, the controller that - // manages the Gateway should add an entry to this list when the - // controller first sees the route and should update the entry as - // appropriate when the route is modified. + // Gateways is a list of Gateways that are associated with the route, + // and the status of the route with respect to each Gateway. When a + // Gateway selects this route, the controller that manages the Gateway + // must add an entry to this list when the controller first sees the + // route and should update the entry as appropriate when the route is + // modified. // // A maximum of 100 Gateways will be represented in this list. If this list // is full, there may be additional Gateways using this Route that are not - // included in the list. + // included in the list. An empty list means the route has not been admitted + // by any Gateway. // // +kubebuilder:validation:MaxItems=100 Gateways []RouteGatewayStatus `json:"gateways"` diff --git a/config/crd/bases/networking.x-k8s.io_httproutes.yaml b/config/crd/bases/networking.x-k8s.io_httproutes.yaml index 437e356ff9..1964c94d32 100644 --- a/config/crd/bases/networking.x-k8s.io_httproutes.yaml +++ b/config/crd/bases/networking.x-k8s.io_httproutes.yaml @@ -444,12 +444,12 @@ spec: description: Status defines the current state of HTTPRoute. properties: gateways: - description: "Gateways is a list of the Gateways that are associated with the route, and the status of the route with respect to each of these Gateways. When a Gateway selects this route, the controller that manages the Gateway should add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list." + description: "Gateways is a list of Gateways that are associated with the route, and the status of the route with respect to each Gateway. When a Gateway selects this route, the controller that manages the Gateway must add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list. An empty list means the route has not been admitted by any Gateway." items: description: RouteGatewayStatus describes the status of a route with respect to an associated Gateway. properties: conditions: - description: Conditions describes the status of the route with respect to the Gateway. For example, the "Admitted" condition indicates whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. + description: Conditions describes the status of the route with respect to the Gateway. The "Admitted" condition must always be specified by controllers to indicate whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. items: description: "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }" properties: diff --git a/config/crd/bases/networking.x-k8s.io_tcproutes.yaml b/config/crd/bases/networking.x-k8s.io_tcproutes.yaml index 2d2f94fe4a..25d002662d 100644 --- a/config/crd/bases/networking.x-k8s.io_tcproutes.yaml +++ b/config/crd/bases/networking.x-k8s.io_tcproutes.yaml @@ -164,12 +164,12 @@ spec: description: Status defines the current state of TCPRoute. properties: gateways: - description: "Gateways is a list of the Gateways that are associated with the route, and the status of the route with respect to each of these Gateways. When a Gateway selects this route, the controller that manages the Gateway should add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list." + description: "Gateways is a list of Gateways that are associated with the route, and the status of the route with respect to each Gateway. When a Gateway selects this route, the controller that manages the Gateway must add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list. An empty list means the route has not been admitted by any Gateway." items: description: RouteGatewayStatus describes the status of a route with respect to an associated Gateway. properties: conditions: - description: Conditions describes the status of the route with respect to the Gateway. For example, the "Admitted" condition indicates whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. + description: Conditions describes the status of the route with respect to the Gateway. The "Admitted" condition must always be specified by controllers to indicate whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. items: description: "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }" properties: diff --git a/config/crd/bases/networking.x-k8s.io_tlsroutes.yaml b/config/crd/bases/networking.x-k8s.io_tlsroutes.yaml index ccca1398ba..fe21d53605 100644 --- a/config/crd/bases/networking.x-k8s.io_tlsroutes.yaml +++ b/config/crd/bases/networking.x-k8s.io_tlsroutes.yaml @@ -173,12 +173,12 @@ spec: description: Status defines the current state of TLSRoute. properties: gateways: - description: "Gateways is a list of the Gateways that are associated with the route, and the status of the route with respect to each of these Gateways. When a Gateway selects this route, the controller that manages the Gateway should add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list." + description: "Gateways is a list of Gateways that are associated with the route, and the status of the route with respect to each Gateway. When a Gateway selects this route, the controller that manages the Gateway must add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list. An empty list means the route has not been admitted by any Gateway." items: description: RouteGatewayStatus describes the status of a route with respect to an associated Gateway. properties: conditions: - description: Conditions describes the status of the route with respect to the Gateway. For example, the "Admitted" condition indicates whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. + description: Conditions describes the status of the route with respect to the Gateway. The "Admitted" condition must always be specified by controllers to indicate whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. items: description: "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }" properties: diff --git a/config/crd/bases/networking.x-k8s.io_udproutes.yaml b/config/crd/bases/networking.x-k8s.io_udproutes.yaml index 7b72cea4da..8f848c4392 100644 --- a/config/crd/bases/networking.x-k8s.io_udproutes.yaml +++ b/config/crd/bases/networking.x-k8s.io_udproutes.yaml @@ -164,12 +164,12 @@ spec: description: Status defines the current state of UDPRoute. properties: gateways: - description: "Gateways is a list of the Gateways that are associated with the route, and the status of the route with respect to each of these Gateways. When a Gateway selects this route, the controller that manages the Gateway should add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list." + description: "Gateways is a list of Gateways that are associated with the route, and the status of the route with respect to each Gateway. When a Gateway selects this route, the controller that manages the Gateway must add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route is modified. \n A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not included in the list. An empty list means the route has not been admitted by any Gateway." items: description: RouteGatewayStatus describes the status of a route with respect to an associated Gateway. properties: conditions: - description: Conditions describes the status of the route with respect to the Gateway. For example, the "Admitted" condition indicates whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. + description: Conditions describes the status of the route with respect to the Gateway. The "Admitted" condition must always be specified by controllers to indicate whether the route has been admitted or rejected by the Gateway, and why. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. items: description: "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }" properties: diff --git a/docs-src/spec.md b/docs-src/spec.md index a01cf52eae..03fb362791 100644 --- a/docs-src/spec.md +++ b/docs-src/spec.md @@ -3540,10 +3540,10 @@ the route.
Conditions describes the status of the route with respect to the -Gateway. For example, the “Admitted” condition indicates whether the -route has been admitted or rejected by the Gateway, and why. Note -that the route’s availability is also subject to the Gateway’s own -status conditions and listener status.
+Gateway. The “Admitted” condition must always be specified by controllers +to indicate whether the route has been admitted or rejected by the Gateway, +and why. Note that the route’s availability is also subject to the Gateway’s +own status conditions and listener status.Gateways is a list of the Gateways that are associated with the -route, and the status of the route with respect to each of these -Gateways. When a Gateway selects this route, the controller that -manages the Gateway should add an entry to this list when the -controller first sees the route and should update the entry as -appropriate when the route is modified.
+Gateways is a list of Gateways that are associated with the route, +and the status of the route with respect to each Gateway. When a +Gateway selects this route, the controller that manages the Gateway +must add an entry to this list when the controller first sees the +route and should update the entry as appropriate when the route is +modified.
A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not -included in the list.
+included in the list. An empty list means the route has not been admitted +by any Gateway.Conditions describes the status of the route with respect to the -Gateway. For example, the “Admitted” condition indicates whether the -route has been admitted or rejected by the Gateway, and why. Note -that the route’s availability is also subject to the Gateway’s own -status conditions and listener status.
+Gateway. The “Admitted” condition must always be specified by controllers +to indicate whether the route has been admitted or rejected by the Gateway, +and why. Note that the route’s availability is also subject to the Gateway’s +own status conditions and listener status.Gateways is a list of the Gateways that are associated with the -route, and the status of the route with respect to each of these -Gateways. When a Gateway selects this route, the controller that -manages the Gateway should add an entry to this list when the -controller first sees the route and should update the entry as -appropriate when the route is modified.
+Gateways is a list of Gateways that are associated with the route, +and the status of the route with respect to each Gateway. When a +Gateway selects this route, the controller that manages the Gateway +must add an entry to this list when the controller first sees the +route and should update the entry as appropriate when the route is +modified.
A maximum of 100 Gateways will be represented in this list. If this list is full, there may be additional Gateways using this Route that are not -included in the list.
+included in the list. An empty list means the route has not been admitted +by any Gateway.