annotation

func ContourAnnotation ¶ added in v1.11.0

func ContourAnnotation(o metav1.Object, key string) string

ContourAnnotation checks the Object for the given annotation with the "projectcontour.io/" prefix.

func HTTPAllowed ¶

func HTTPAllowed(i *networking_v1.Ingress) bool

HTTPAllowed returns true unless the kubernetes.io/ingress.allow-http annotation is present and set to false.

func IngressClass ¶

func IngressClass(o metav1.Object) string

IngressClass returns the first matching ingress class for the following annotations: 1. projectcontour.io/ingress.class 2. kubernetes.io/ingress.class

func IsKnown ¶

func IsKnown(key string) bool

IsKnown checks if an annotation is one Contour knows about.

func MaxConnections ¶

func MaxConnections(o metav1.Object) uint32

MaxConnections returns the value of the first matching max-connections annotation for the following annotations: 1. projectcontour.io/max-connections

'0' is returned if the annotation is absent or unparsable.

func MaxPendingRequests ¶

func MaxPendingRequests(o metav1.Object) uint32

MaxPendingRequests returns the value of the first matching max-pending-requests annotation for the following annotations: 1. projectcontour.io/max-pending-requests

'0' is returned if the annotation is absent or unparsable.

func MaxRequests ¶

func MaxRequests(o metav1.Object) uint32

MaxRequests returns the value of the first matching max-requests annotation for the following annotations: 1. projectcontour.io/max-requests

'0' is returned if the annotation is absent or unparsable.

func MaxRetries ¶

func MaxRetries(o metav1.Object) uint32

MaxRetries returns the value of the first matching max-retries annotation for the following annotations: 1. projectcontour.io/max-retries

'0' is returned if the annotation is absent or unparsable.

func NumRetries ¶

func NumRetries(i *networking_v1.Ingress) uint32

NumRetries returns the number of retries specified by the "projectcontour.io/num-retries" annotation.

func ParseUpstreamProtocols ¶

func ParseUpstreamProtocols(m map[string]string) map[string]string

ParseUpstreamProtocols parses the annotations map for projectcontour.io/upstream-protocol.{protocol} annotations. 'protocol' identifies which protocol must be used in the upstream.

func PerHostMaxConnections ¶ added in v1.28.0

func PerHostMaxConnections(o metav1.Object) uint32

PerHostMaxConnections returns the value of the first matching per-host-max-connectionss annotation for the following annotations: 1. projectcontour.io/per-host-max-connections

'0' is returned if the annotation is absent or unparsable.

func PerTryTimeout ¶

func PerTryTimeout(i *networking_v1.Ingress) (timeout.Setting, error)

PerTryTimeout returns the duration envoy will wait per retry cycle.

func TLSCertNamespace ¶ added in v1.20.0

func TLSCertNamespace(i *networking_v1.Ingress) string

TLSCertNamespace returns the namespace name of the delegated certificate if projectcontour.io/tls-cert-namespace annotation is present and non-empty

func TLSRequired ¶

func TLSRequired(i *networking_v1.Ingress) bool

TLSRequired returns true if the ingress.kubernetes.io/force-ssl-redirect annotation is present and set to true.

func TLSVersion ¶ added in v1.26.0

func TLSVersion(version, defaultVal string) string

TLSVersion returns the TLS protocol version specified by an ingress annotation or default if non present.

func ValidForKind ¶

func ValidForKind(kind, key string) bool

ValidForKind checks if a particular annotation is valid for a given Kind.

func WebsocketRoutes ¶

func WebsocketRoutes(i *networking_v1.Ingress) map[string]bool

WebsocketRoutes retrieves the details of routes that should have websockets enabled from the associated websocket-routes annotation.