annotations

Documentation

Overview

Package annotations contains all annotations that supported by cilium ingress controller along with some sensible defaults.

Index

• Constants
• func GetAnnotationForceHTTPSEnabled(ingress *networkingv1.Ingress) *bool
• func GetAnnotationHostListenerPort(ingress *networkingv1.Ingress) (*uint32, error)
• func GetAnnotationIngressLoadbalancerMode(ingress *networkingv1.Ingress) string
• func GetAnnotationInsecureNodePort(ingress *networkingv1.Ingress) (*uint32, error)
• func GetAnnotationLoadBalancerClass(ingress *networkingv1.Ingress) *string
• func GetAnnotationRequestTimeout(ingress *networkingv1.Ingress) (*time.Duration, error)
• func GetAnnotationSecureNodePort(ingress *networkingv1.Ingress) (*uint32, error)
• func GetAnnotationServiceExternalTrafficPolicy(ingress *networkingv1.Ingress) (string, error)
• func GetAnnotationServiceType(ingress *networkingv1.Ingress) string
• func GetAnnotationTLSPassthroughEnabled(ingress *networkingv1.Ingress) bool

Constants

const (
	LBModeAnnotation                       = annotation.IngressPrefix + "/loadbalancer-mode"
	LBClassAnnotation                      = annotation.IngressPrefix + "/loadbalancer-class"
	ServiceTypeAnnotation                  = annotation.IngressPrefix + "/service-type"
	ServiceExternalTrafficPolicyAnnotation = annotation.IngressPrefix + "/service-external-traffic-policy"
	InsecureNodePortAnnotation             = annotation.IngressPrefix + "/insecure-node-port"
	SecureNodePortAnnotation               = annotation.IngressPrefix + "/secure-node-port"
	HostListenerPortAnnotation             = annotation.IngressPrefix + "/host-listener-port"
	TLSPassthroughAnnotation               = annotation.IngressPrefix + "/tls-passthrough"
	ForceHTTPSAnnotation                   = annotation.IngressPrefix + "/force-https"
	RequestTimeoutAnnotation               = annotation.IngressPrefix + "/request-timeout"

	LBModeAnnotationAlias           = annotation.Prefix + ".ingress" + "/loadbalancer-mode"
	ServiceTypeAnnotationAlias      = annotation.Prefix + ".ingress" + "/service-type"
	InsecureNodePortAnnotationAlias = annotation.Prefix + ".ingress" + "/insecure-node-port"
	SecureNodePortAnnotationAlias   = annotation.Prefix + ".ingress" + "/secure-node-port"
	TLSPassthroughAnnotationAlias   = annotation.Prefix + ".ingress" + "/tls-passthrough"
)

const (
	LoadbalancerModeDedicated = "dedicated"
	LoadbalancerModeShared    = "shared"
)

Functions

func GetAnnotationForceHTTPSEnabled

func GetAnnotationForceHTTPSEnabled(ingress *networkingv1.Ingress) *bool

GetAnnotationEnforceHTTPSEnabled retrieves the EnforceHTTPS annotation's value. This uses a string rather than a bool because the empty string means "unset". In this case this matters because if the value is unset, it can be overridden by the global config option `--enforce-ingress-https`.

If the annotation is set, will override the global config option in all cases.

Note that `enabled`, `disabled` and `true` or `false` style values (as understood by strconv.ParseBool() ) will work. The annotation being present but set to any other value will result in returning the empty string (as in, the same as if unset).

If the annotation is unset, this returns `nil`.

The only valid values are: - &true - the annotation is present and set to a truthy value - &false - the annovation is present and set to a false value - nil - the annotatation is not present

func GetAnnotationHostListenerPort

func GetAnnotationHostListenerPort(ingress *networkingv1.Ingress) (*uint32, error)

GetAnnotationHostListenerPort returns the host listener port for the ingress if possible.

func GetAnnotationIngressLoadbalancerMode

func GetAnnotationIngressLoadbalancerMode(ingress *networkingv1.Ingress) string

GetAnnotationIngressLoadbalancerMode returns the loadbalancer mode for the ingress if possible.

func GetAnnotationInsecureNodePort

func GetAnnotationInsecureNodePort(ingress *networkingv1.Ingress) (*uint32, error)

GetAnnotationInsecureNodePort returns the insecure node port for the ingress if possible.

func GetAnnotationLoadBalancerClass

func GetAnnotationLoadBalancerClass(ingress *networkingv1.Ingress) *string

GetAnnotationLoadBalancerClass returns the loadbalancer class from the ingress if possible. Defaults to nil

func GetAnnotationRequestTimeout

func GetAnnotationRequestTimeout(ingress *networkingv1.Ingress) (*time.Duration, error)

GetAnnotationRequestTimeout retrieves the RequestTimeout annotation's value.

func GetAnnotationSecureNodePort

func GetAnnotationSecureNodePort(ingress *networkingv1.Ingress) (*uint32, error)

GetAnnotationSecureNodePort returns the secure node port for the ingress if possible.

func GetAnnotationServiceExternalTrafficPolicy

func GetAnnotationServiceExternalTrafficPolicy(ingress *networkingv1.Ingress) (string, error)

GetAnnotationServiceExternalTrafficPolicy returns the service externalTrafficPolicy for the ingress.

func GetAnnotationServiceType

func GetAnnotationServiceType(ingress *networkingv1.Ingress) string

GetAnnotationServiceType returns the service type for the ingress if possible. Defaults to LoadBalancer

func GetAnnotationTLSPassthroughEnabled

func GetAnnotationTLSPassthroughEnabled(ingress *networkingv1.Ingress) bool