conditions

Documentation

Index

• Constants
• type Condition
  • func DeduplicateConditions(conds []Condition) []Condition
  • func NewDefaultGatewayClassConditions() []Condition
  • func NewDefaultGatewayConditions() []Condition
  • func NewDefaultListenerConditions() []Condition
  • func NewDefaultRouteConditions() []Condition
  • func NewGatewayAccepted() Condition
  • func NewGatewayAcceptedListenersNotValid() Condition
  • func NewGatewayClassConflict() Condition
  • func NewGatewayClassInvalidParameters(msg string) Condition
  • func NewGatewayConflict() []Condition
  • func NewGatewayConflictNotProgrammed() Condition
  • func NewGatewayInvalid(msg string) []Condition
  • func NewGatewayNotAcceptedListenersNotValid() []Condition
  • func NewGatewayNotProgrammedInvalid(msg string) Condition
  • func NewGatewayProgrammed() Condition
  • func NewGatewayUnsupportedValue(msg string) []Condition
  • func NewListenerAccepted() Condition
  • func NewListenerInvalidCertificateRef(msg string) []Condition
  • func NewListenerInvalidRouteKinds(msg string) []Condition
  • func NewListenerNoConflicts() Condition
  • func NewListenerNotProgrammedInvalid(msg string) Condition
  • func NewListenerProgrammed() Condition
  • func NewListenerProtocolConflict(msg string) []Condition
  • func NewListenerRefNotPermitted(msg string) []Condition
  • func NewListenerResolvedRefs() Condition
  • func NewListenerUnsupportedProtocol(msg string) []Condition
  • func NewListenerUnsupportedValue(msg string) []Condition
  • func NewRouteAccepted() Condition
  • func NewRouteBackendRefInvalidKind(msg string) Condition
  • func NewRouteBackendRefRefBackendNotFound(msg string) Condition
  • func NewRouteBackendRefRefNotPermitted(msg string) Condition
  • func NewRouteBackendRefUnsupportedValue(msg string) Condition
  • func NewRouteGatewayNotProgrammed(msg string) Condition
  • func NewRouteInvalidGateway() Condition
  • func NewRouteInvalidListener() Condition
  • func NewRouteNoMatchingListenerHostname() Condition
  • func NewRouteNoMatchingParent() Condition
  • func NewRouteNotAllowedByListeners() Condition
  • func NewRouteResolvedRefs() Condition
  • func NewRouteUnsupportedValue(msg string) Condition
  • func NewTODO(msg string) Condition

Constants

const (
	// GatewayClassReasonGatewayClassConflict indicates there are multiple GatewayClass resources
	// that reference this controller, and we ignored the resource in question and picked the
	// GatewayClass that is referenced in the command-line argument.
	// This reason is used with GatewayClassConditionAccepted (false).
	GatewayClassReasonGatewayClassConflict v1beta1.GatewayClassConditionReason = "GatewayClassConflict"

	// GatewayClassMessageGatewayClassConflict is a message that describes GatewayClassReasonGatewayClassConflict.
	GatewayClassMessageGatewayClassConflict = "The resource is ignored due to a conflicting GatewayClass resource"

	// ListenerReasonUnsupportedValue is used with the "Accepted" condition when a value of a field in a Listener
	// is invalid or not supported.
	ListenerReasonUnsupportedValue v1beta1.ListenerConditionReason = "UnsupportedValue"

	// ListenerMessageFailedNginxReload is a message used with ListenerConditionProgrammed (false)
	// when nginx fails to reload.
	ListenerMessageFailedNginxReload = "The Listener is not programmed due to a failure to " +
		"reload nginx with the configuration"

	// RouteReasonBackendRefUnsupportedValue is used with the "ResolvedRefs" condition when one of the
	// Route rules has a backendRef with an unsupported value.
	RouteReasonBackendRefUnsupportedValue = "UnsupportedValue"

	// RouteReasonInvalidGateway is used with the "Accepted" (false) condition when the Gateway the Route
	// references is invalid.
	RouteReasonInvalidGateway = "InvalidGateway"

	// RouteReasonInvalidListener is used with the "Accepted" condition when the Route references an invalid listener.
	RouteReasonInvalidListener v1beta1.RouteConditionReason = "InvalidListener"

	// RouteReasonGatewayNotProgrammed is used when the associated Gateway is not programmed.
	// Used with Accepted (false).
	RouteReasonGatewayNotProgrammed v1beta1.RouteConditionReason = "GatewayNotProgrammed"

	// GatewayReasonGatewayConflict indicates there are multiple Gateway resources to choose from,
	// and we ignored the resource in question and picked another Gateway as the winner.
	// This reason is used with GatewayConditionAccepted (false).
	GatewayReasonGatewayConflict v1beta1.GatewayConditionReason = "GatewayConflict"

	// GatewayMessageGatewayConflict is a message that describes GatewayReasonGatewayConflict.
	GatewayMessageGatewayConflict = "The resource is ignored due to a conflicting Gateway resource"

	// GatewayReasonUnsupportedValue is used with GatewayConditionAccepted (false) when a value of a field in a Gateway
	// is invalid or not supported.
	GatewayReasonUnsupportedValue v1beta1.GatewayConditionReason = "UnsupportedValue"

	// GatewayMessageFailedNginxReload is a message used with GatewayConditionProgrammed (false)
	// when nginx fails to reload.
	GatewayMessageFailedNginxReload = "The Gateway is not programmed due to a failure to " +
		"reload nginx with the configuration"

	// RouteMessageFailedNginxReload is a message used with RouteReasonGatewayNotProgrammed
	// when nginx fails to reload.
	RouteMessageFailedNginxReload = GatewayMessageFailedNginxReload + ". NGINX may still be configured " +
		"for this HTTPRoute. However, future updates to this resource will not be configured until the Gateway " +
		"is programmed again"
)

Types

type Condition

type Condition struct {
	Type    string
	Status  metav1.ConditionStatus
	Reason  string
	Message string
}

Condition defines a condition to be reported in the status of resources.

func DeduplicateConditions

func DeduplicateConditions(conds []Condition) []Condition

DeduplicateConditions removes duplicate conditions based on the condition type. The last condition wins. The order of conditions is preserved.

func NewDefaultGatewayClassConditions

func NewDefaultGatewayClassConditions() []Condition

NewDefaultGatewayClassConditions returns the default Conditions that must be present in the status of a GatewayClass.

func NewDefaultGatewayConditions

func NewDefaultGatewayConditions() []Condition

NewDefaultGatewayConditions returns the default Conditions that must be present in the status of a Gateway.

func NewDefaultListenerConditions

func NewDefaultListenerConditions() []Condition

NewDefaultListenerConditions returns the default Conditions that must be present in the status of a Listener.

func NewDefaultRouteConditions

func NewDefaultRouteConditions() []Condition

NewDefaultRouteConditions returns the default conditions that must be present in the status of an HTTPRoute.

func NewGatewayAccepted

func NewGatewayAccepted() Condition

NewGatewayAccepted returns a Condition that indicates the Gateway is accepted.

func NewGatewayAcceptedListenersNotValid

func NewGatewayAcceptedListenersNotValid() Condition

NewGatewayAcceptedListenersNotValid returns a Condition that indicates the Gateway is accepted, but has at least one listener that is invalid.

func NewGatewayClassConflict

func NewGatewayClassConflict() Condition

NewGatewayClassConflict returns a Condition that indicates that the GatewayClass is not accepted due to a conflict with another GatewayClass.

func NewGatewayClassInvalidParameters

func NewGatewayClassInvalidParameters(msg string) Condition

NewGatewayClassInvalidParameters returns a Condition that indicates that the GatewayClass has invalid parameters.

func NewGatewayConflict

func NewGatewayConflict() []Condition

NewGatewayConflict returns Conditions that indicate the Gateway has a conflict with another Gateway.

func NewGatewayConflictNotProgrammed

func NewGatewayConflictNotProgrammed() Condition

NewGatewayConflictNotProgrammed returns a custom Programmed Condition that indicates the Gateway has a conflict with another Gateway.

func NewGatewayInvalid

func NewGatewayInvalid(msg string) []Condition

NewGatewayInvalid returns Conditions that indicate the Gateway is not accepted and programmed because it is semantically or syntactically invalid. The provided message contains the details of why the Gateway is invalid.

func NewGatewayNotAcceptedListenersNotValid

func NewGatewayNotAcceptedListenersNotValid() []Condition

NewGatewayNotAcceptedListenersNotValid returns Conditions that indicate the Gateway is not accepted, because all listeners are invalid.

func NewGatewayNotProgrammedInvalid

func NewGatewayNotProgrammedInvalid(msg string) Condition

NewGatewayInvalid returns a Condition that indicates the Gateway is not programmed because it is semantically or syntactically invalid. The provided message contains the details of why the Gateway is invalid.

func NewGatewayProgrammed

func NewGatewayProgrammed() Condition

NewGatewayProgrammed returns a Condition that indicates the Gateway is programmed.

func NewGatewayUnsupportedValue

func NewGatewayUnsupportedValue(msg string) []Condition

NewGatewayUnsupportedValue returns Conditions that indicate that a field of the Gateway has an unsupported value. Unsupported means that the value is not supported by the implementation or invalid.

func NewListenerAccepted

func NewListenerAccepted() Condition

NewListenerAccepted returns a Condition that indicates that the Listener is accepted.

func NewListenerInvalidCertificateRef

func NewListenerInvalidCertificateRef(msg string) []Condition

NewListenerInvalidCertificateRef returns Conditions that indicate that a CertificateRef of a Listener is invalid.

func NewListenerInvalidRouteKinds

func NewListenerInvalidRouteKinds(msg string) []Condition

NewListenerInvalidRouteKinds returns Conditions that indicate that an invalid or unsupported Route kind is specified by the Listener.

func NewListenerNoConflicts

func NewListenerNoConflicts() Condition

NewListenerNoConflicts returns a Condition that indicates that there are no conflicts in a Listener.

func NewListenerNotProgrammedInvalid

func NewListenerNotProgrammedInvalid(msg string) Condition

NewListenerNotProgrammedInvalid returns a Condition that indicates the Listener is not programmed because it is semantically or syntactically invalid. The provided message contains the details of why the Listener is invalid.

func NewListenerProgrammed

func NewListenerProgrammed() Condition

NewListenerProgrammed returns a Condition that indicates the Listener is programmed.

func NewListenerProtocolConflict

func NewListenerProtocolConflict(msg string) []Condition

NewListenerProtocolConflict returns Conditions that indicate multiple Listeners are specified with the same Listener port number, but have conflicting protocol specifications.

func NewListenerRefNotPermitted

func NewListenerRefNotPermitted(msg string) []Condition

NewListenerRefNotPermitted returns Conditions that indicates that the Listener references a TLS secret that is not permitted by a ReferenceGrant.

func NewListenerResolvedRefs

func NewListenerResolvedRefs() Condition

NewListenerResolvedRefs returns a Condition that indicates that all references in a Listener are resolved.

func NewListenerUnsupportedProtocol

func NewListenerUnsupportedProtocol(msg string) []Condition

NewListenerUnsupportedProtocol returns Conditions that indicate that the protocol of a Listener is unsupported.

func NewListenerUnsupportedValue

func NewListenerUnsupportedValue(msg string) []Condition

NewListenerUnsupportedValue returns Conditions that indicate that a field of a Listener has an unsupported value. Unsupported means that the value is not supported by the implementation or invalid.

func NewRouteAccepted

func NewRouteAccepted() Condition

NewRouteAccepted returns a Condition that indicates that the HTTPRoute is accepted.

func NewRouteBackendRefInvalidKind

func NewRouteBackendRefInvalidKind(msg string) Condition

NewRouteBackendRefInvalidKind returns a Condition that indicates that the Route has a backendRef with an invalid kind.

func NewRouteBackendRefRefBackendNotFound

func NewRouteBackendRefRefBackendNotFound(msg string) Condition

NewRouteBackendRefRefBackendNotFound returns a Condition that indicates that the Route has a backendRef that points to non-existing backend.

func NewRouteBackendRefRefNotPermitted

func NewRouteBackendRefRefNotPermitted(msg string) Condition

NewRouteBackendRefRefNotPermitted returns a Condition that indicates that the Route has a backendRef that is not permitted.

func NewRouteBackendRefUnsupportedValue

func NewRouteBackendRefUnsupportedValue(msg string) Condition

NewRouteBackendRefUnsupportedValue returns a Condition that indicates that the Route has a backendRef with an unsupported value.

func NewRouteGatewayNotProgrammed

func NewRouteGatewayNotProgrammed(msg string) Condition

NewRouteGatewayNotProgrammed returns a Condition that indicates that the Gateway it references is not programmed, which does not guarantee that the HTTPRoute has been configured.

func NewRouteInvalidGateway

func NewRouteInvalidGateway() Condition

NewRouteInvalidGateway returns a Condition that indicates that the Route is not Accepted because the Gateway it references is invalid.

func NewRouteInvalidListener

func NewRouteInvalidListener() Condition

NewRouteInvalidListener returns a Condition that indicates that the HTTPRoute is not accepted because of an invalid listener.

func NewRouteNoMatchingListenerHostname

func NewRouteNoMatchingListenerHostname() Condition

NewRouteNoMatchingListenerHostname returns a Condition that indicates that the hostname of the listener does not match the hostnames of the HTTPRoute.

func NewRouteNoMatchingParent

func NewRouteNoMatchingParent() Condition

NewRouteNoMatchingParent returns a Condition that indicates that the Route is not Accepted because it specifies a Port and/or SectionName that does not match any Listeners in the Gateway.

func NewRouteNotAllowedByListeners

func NewRouteNotAllowedByListeners() Condition

NewRouteNotAllowedByListeners returns a Condition that indicates that the HTTPRoute is not allowed by any listener.

func NewRouteResolvedRefs

func NewRouteResolvedRefs() Condition

NewRouteResolvedRefs returns a Condition that indicates that all the references on the Route are resolved.

func NewRouteUnsupportedValue

func NewRouteUnsupportedValue(msg string) Condition

NewRouteUnsupportedValue returns a Condition that indicates that the HTTPRoute includes an unsupported value.

func NewTODO

func NewTODO(msg string) Condition

NewTODO returns a Condition that can be used as a placeholder for a condition that is not yet implemented.