gatewayapi

Documentation

Index

• func CertificateRef(name, namespace string) gatewayapi_v1beta1.SecretObjectReference
• func GatewayListenerParentRef(namespace, name, listener string, port int) gatewayapi_v1beta1.ParentReference
• func GatewayParentRef(namespace, name string) gatewayapi_v1beta1.ParentReference
• func HTTPBackendRef(serviceName string, port int, weight int32) []gatewayapi_v1beta1.HTTPBackendRef
• func HTTPBackendRefs(backendRefs ...[]gatewayapi_v1beta1.HTTPBackendRef) []gatewayapi_v1beta1.HTTPBackendRef
• func HTTPHeaderMatch(matchType gatewayapi_v1beta1.HeaderMatchType, name, value string) []gatewayapi_v1beta1.HTTPHeaderMatch
• func HTTPQueryParamMatches(namesAndValues map[string]string) []gatewayapi_v1beta1.HTTPQueryParamMatch
• func HTTPRouteMatch(pathType gatewayapi_v1beta1.PathMatchType, value string) []gatewayapi_v1beta1.HTTPRouteMatch
• func HostnameDeref(hostname *gatewayapi_v1beta1.Hostname) string
• func IsRefToGateway(parentRef gatewayapi_v1beta1.ParentReference, gateway types.NamespacedName) bool
• func IsValidHostname(hostname string) error
• func ServiceBackendObjectRef(name string, port int) gatewayapi_v1beta1.BackendObjectReference
• func TLSRouteBackendRef(serviceName string, port int, weight *int32) []gatewayapi_v1alpha2.BackendRef
• func TLSRouteBackendRefs(backendRefs ...[]gatewayapi_v1alpha2.BackendRef) []gatewayapi_v1alpha2.BackendRef
• type ValidateListenersResult
  • func ValidateListeners(listeners []gatewayapi_v1beta1.Listener) ValidateListenersResult

Functions

func CertificateRef

func CertificateRef(name, namespace string) gatewayapi_v1beta1.SecretObjectReference

func GatewayListenerParentRef

func GatewayListenerParentRef(namespace, name, listener string, port int) gatewayapi_v1beta1.ParentReference

func GatewayParentRef

func GatewayParentRef(namespace, name string) gatewayapi_v1beta1.ParentReference

func HTTPBackendRef

func HTTPBackendRef(serviceName string, port int, weight int32) []gatewayapi_v1beta1.HTTPBackendRef

func HTTPBackendRefs

func HTTPBackendRefs(backendRefs ...[]gatewayapi_v1beta1.HTTPBackendRef) []gatewayapi_v1beta1.HTTPBackendRef

func HTTPHeaderMatch

func HTTPHeaderMatch(matchType gatewayapi_v1beta1.HeaderMatchType, name, value string) []gatewayapi_v1beta1.HTTPHeaderMatch

func HTTPQueryParamMatches

func HTTPQueryParamMatches(namesAndValues map[string]string) []gatewayapi_v1beta1.HTTPQueryParamMatch

func HTTPRouteMatch

func HTTPRouteMatch(pathType gatewayapi_v1beta1.PathMatchType, value string) []gatewayapi_v1beta1.HTTPRouteMatch

func HostnameDeref

func HostnameDeref(hostname *gatewayapi_v1beta1.Hostname) string

HostnameDeref returns the hostname as a string if it's not nil, or an empty string otherwise.

func IsRefToGateway

func IsRefToGateway(parentRef gatewayapi_v1beta1.ParentReference, gateway types.NamespacedName) bool

IsRefToGateway returns whether the provided parent ref is a reference to a Gateway with the given namespace/name, irrespective of whether a section/listener name has been specified (i.e. a parent ref to a listener on the specified gateway will return "true").

func IsValidHostname

func IsValidHostname(hostname string) error

IsValidHostname validates that a given hostname is syntactically valid. It returns nil if valid and an error if not valid.

func ServiceBackendObjectRef

func ServiceBackendObjectRef(name string, port int) gatewayapi_v1beta1.BackendObjectReference

func TLSRouteBackendRef

func TLSRouteBackendRef(serviceName string, port int, weight *int32) []gatewayapi_v1alpha2.BackendRef

func TLSRouteBackendRefs

func TLSRouteBackendRefs(backendRefs ...[]gatewayapi_v1alpha2.BackendRef) []gatewayapi_v1alpha2.BackendRef

Types

type ValidateListenersResult

type ValidateListenersResult struct {
	InsecurePort int
	SecurePort   int

	InvalidListenerConditions map[gatewayapi_v1beta1.SectionName]metav1.Condition
}

func ValidateListeners

func ValidateListeners(listeners []gatewayapi_v1beta1.Listener) ValidateListenersResult

ValidateListeners validates protocols, ports and hostnames on a set of listeners. It ensures that:

• all protocols are supported
• each listener group (grouped by protocol, with HTTPS & TLS going together) uses a single port
• listener hostnames are syntactically valid
• hostnames within each listener group are unique

It returns the insecure & secure ports to use, as well as conditions for all invalid listeners. If a listener is not in the "InvalidListenerConditions" map, it is assumed to be valid according to the above rules.