Skip to content

Commit

Permalink
Gateway API docs updated
Browse files Browse the repository at this point in the history
The ListenerReasonRefNotPermitted documentation has been improved to
specify that this reason can be triggered by either an unpermitted
BackendRef or an unpermitted CertificateRef.
Besides, the ListenerReasonInvalidCertificateRef documentation has
been improved to specify better what makes a listener CertificateRef
invalid.

Signed-off-by: Mattia Lavacca <lavacca.mattia@gmail.com>
  • Loading branch information
mlavacca committed Sep 30, 2022
1 parent 2738bba commit 614abc7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions apis/v1alpha2/gateway_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -397,17 +397,18 @@ const (

// This reason is used with the "ResolvedRefs" condition when the
// Listener has a TLS configuration with at least one TLS CertificateRef
// that is invalid or cannot be resolved.
// that is malformed or does not exist.
ListenerReasonInvalidCertificateRef ListenerConditionReason = "InvalidCertificateRef"

// This reason is used with the "ResolvedRefs" condition when an invalid or
// unsupported Route kind is specified by the Listener.
ListenerReasonInvalidRouteKinds ListenerConditionReason = "InvalidRouteKinds"

// This reason is used with the "ResolvedRefs" condition when
// one of the Listener's Routes has a BackendRef to an object in
// another namespace, where the object in the other namespace does
// not have a ReferenceGrant explicitly allowing the reference.
// one of the Listener's Routes references an object in another namespace,
// where the object in the other namespace does not have a ReferenceGrant
// explicitly allowing the reference. The unpermitted reference can be
// either a BackendRef, or a CertificateRef.
ListenerReasonRefNotPermitted ListenerConditionReason = "RefNotPermitted"
)

Expand Down
9 changes: 5 additions & 4 deletions apis/v1beta1/gateway_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -747,17 +747,18 @@ const (

// This reason is used with the "ResolvedRefs" condition when the
// Listener has a TLS configuration with at least one TLS CertificateRef
// that is invalid or cannot be resolved.
// that is malformed or does not exist.
ListenerReasonInvalidCertificateRef ListenerConditionReason = "InvalidCertificateRef"

// This reason is used with the "ResolvedRefs" condition when an invalid or
// unsupported Route kind is specified by the Listener.
ListenerReasonInvalidRouteKinds ListenerConditionReason = "InvalidRouteKinds"

// This reason is used with the "ResolvedRefs" condition when
// one of the Listener's Routes has a BackendRef to an object in
// another namespace, where the object in the other namespace does
// not have a ReferenceGrant explicitly allowing the reference.
// one of the Listener's Routes references an object in another namespace,
// where the object in the other namespace does not have a ReferenceGrant
// explicitly allowing the reference. The unpermitted reference must be
// either a BackendRef, or a CertificateRef.
ListenerReasonRefNotPermitted ListenerConditionReason = "RefNotPermitted"
)

Expand Down

0 comments on commit 614abc7

Please sign in to comment.