Documentation
¶
Index ¶
- Constants
- func CompatAnnotation(o metav1.ObjectMetaAccessor, key string) string
- func HTTPAllowed(i *v1beta1.Ingress) bool
- func IngressClass(o metav1.ObjectMetaAccessor) string
- func IsKnown(key string) bool
- func MatchesIngressClass(o metav1.ObjectMetaAccessor, ic string) bool
- func MaxConnections(o metav1.ObjectMetaAccessor) uint32
- func MaxPendingRequests(o metav1.ObjectMetaAccessor) uint32
- func MaxRequests(o metav1.ObjectMetaAccessor) uint32
- func MaxRetries(o metav1.ObjectMetaAccessor) uint32
- func MinTLSVersion(version string) envoy_api_v2_auth.TlsParameters_TlsProtocol
- func NumRetries(i *v1beta1.Ingress) uint32
- func ParseUpstreamProtocols(m map[string]string) map[string]string
- func PerTryTimeout(i *v1beta1.Ingress) timeout.Setting
- func TLSRequired(i *v1beta1.Ingress) bool
- func ValidForKind(kind string, key string) bool
- func WebsocketRoutes(i *v1beta1.Ingress) map[string]bool
Constants ¶
const DEFAULT_INGRESS_CLASS = "contour"
DEFAULT_INGRESS_CLASS is the Contour default.
Variables ¶
This section is empty.
Functions ¶
func CompatAnnotation ¶
func CompatAnnotation(o metav1.ObjectMetaAccessor, key string) string
CompatAnnotation checks the Object for the given annotation, first with the "projectcontour.io/" prefix, and then with the "contour.heptio.com/" prefix if that is not found.
func HTTPAllowed ¶
HTTPAllowed returns true unless the kubernetes.io/ingress.allow-http annotation is present and set to false.
func IngressClass ¶
func IngressClass(o metav1.ObjectMetaAccessor) string
IngressClass returns the first matching ingress class for the following annotations: 1. projectcontour.io/ingress.class 2. contour.heptio.com/ingress.class 3. kubernetes.io/ingress.class
func MatchesIngressClass ¶
func MatchesIngressClass(o metav1.ObjectMetaAccessor, ic string) bool
MatchesIngressClass checks that the passed object has an ingress class that matches either the passed ingress-class string, or DEFAULT_INGRESS_CLASS if it's empty.
func MaxConnections ¶
func MaxConnections(o metav1.ObjectMetaAccessor) uint32
MaxConnections returns the value of the first matching max-connections annotation for the following annotations: 1. projectcontour.io/max-connections 2. contour.heptio.com/max-connections
'0' is returned if the annotation is absent or unparseable.
func MaxPendingRequests ¶
func MaxPendingRequests(o metav1.ObjectMetaAccessor) uint32
MaxPendingRequests returns the value of the first matching max-pending-requests annotation for the following annotations: 1. projectcontour.io/max-pending-requests 2. contour.heptio.com/max-pending-requests
'0' is returned if the annotation is absent or unparseable.
func MaxRequests ¶
func MaxRequests(o metav1.ObjectMetaAccessor) uint32
MaxRequests returns the value of the first matching max-requests annotation for the following annotations: 1. projectcontour.io/max-requests 2. contour.heptio.com/max-requests
'0' is returned if the annotation is absent or unparseable.
func MaxRetries ¶
func MaxRetries(o metav1.ObjectMetaAccessor) uint32
MaxRetries returns the value of the first matching max-retries annotation for the following annotations: 1. projectcontour.io/max-retries 2. contour.heptio.com/max-retries
'0' is returned if the annotation is absent or unparseable.
func MinTLSVersion ¶ added in v1.6.0
func MinTLSVersion(version string) envoy_api_v2_auth.TlsParameters_TlsProtocol
MinTLSVersion returns the TLS protocol version specified by an ingress annotation or default if non present.
func NumRetries ¶
NumRetries returns the number of retries specified by the "contour.heptio.com/num-retries" or "projectcontour.io/num-retries" annotation.
func ParseUpstreamProtocols ¶
ParseUpstreamProtocols parses the annotations map for contour.heptio.com/upstream-protocol.{protocol} and projectcontour.io/upstream-protocol.{protocol} annotations. 'protocol' identifies which protocol must be used in the upstream.
func PerTryTimeout ¶
PerTryTimeout returns the duration envoy will wait per retry cycle.
func TLSRequired ¶
TLSRequired returns true if the ingress.kubernetes.io/force-ssl-redirect annotation is present and set to true.
func ValidForKind ¶
ValidForKind checks if a particular annotation is valid for a given Kind.
Types ¶
This section is empty.