Documentation
¶
Index ¶
- func ContourAnnotation(o metav1.Object, key string) string
- func HTTPAllowed(i *networking_v1.Ingress) bool
- func IngressClass(o metav1.Object) string
- func IsKnown(key string) bool
- func MaxConnections(o metav1.Object) uint32
- func MaxPendingRequests(o metav1.Object) uint32
- func MaxRequests(o metav1.Object) uint32
- func MaxRetries(o metav1.Object) uint32
- func NumRetries(i *networking_v1.Ingress) uint32
- func ParseUpstreamProtocols(m map[string]string) map[string]string
- func PerTryTimeout(i *networking_v1.Ingress) (timeout.Setting, error)
- func TLSCertNamespace(i *networking_v1.Ingress) string
- func TLSRequired(i *networking_v1.Ingress) bool
- func TLSVersion(version string, defaultVal string) string
- func ValidForKind(kind string, key string) bool
- func WebsocketRoutes(i *networking_v1.Ingress) map[string]bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContourAnnotation ¶ added in v1.11.0
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 ¶
IngressClass returns the first matching ingress class for the following annotations: 1. projectcontour.io/ingress.class 2. kubernetes.io/ingress.class
func MaxConnections ¶
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 ¶
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 ¶
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 ¶
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 ¶
ParseUpstreamProtocols parses the annotations map for projectcontour.io/upstream-protocol.{protocol} annotations. 'protocol' identifies which protocol must be used in the upstream.
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
TLSVersion returns the TLS protocol version specified by an ingress annotation or default if non present.
func ValidForKind ¶
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.
Types ¶
This section is empty.
Source Files