annotations

package

v1.15.5 Latest Latest Go to latest Published: May 10, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cilium/cilium

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Index ¶

Constants
func GetAnnotationIngressLoadbalancerMode(ingress *networkingv1.Ingress) string
func GetAnnotationInsecureNodePort(ingress *networkingv1.Ingress) (*uint32, error)
func GetAnnotationSecureNodePort(ingress *networkingv1.Ingress) (*uint32, error)
func GetAnnotationServiceType(ingress *networkingv1.Ingress) string
func GetAnnotationTCPKeepAliveEnabled(ingress *networkingv1.Ingress) int64
func GetAnnotationTCPKeepAliveIdle(ingress *networkingv1.Ingress) int64
func GetAnnotationTCPKeepAliveProbeInterval(ingress *networkingv1.Ingress) int64
func GetAnnotationTCPKeepAliveProbeMaxFailures(ingress *networkingv1.Ingress) int64
func GetAnnotationTLSPassthroughEnabled(ingress *networkingv1.Ingress) bool
func GetAnnotationWebsocketEnabled(ingress *networkingv1.Ingress) int64

Constants ¶

View Source

const (
	LBModeAnnotation           = annotation.IngressPrefix + "/loadbalancer-mode"
	ServiceTypeAnnotation      = annotation.IngressPrefix + "/service-type"
	InsecureNodePortAnnotation = annotation.IngressPrefix + "/insecure-node-port"
	SecureNodePortAnnotation   = annotation.IngressPrefix + "/secure-node-port"
	TLSPassthroughAnnotation   = annotation.IngressPrefix + "/tls-passthrough"

	TCPKeepAliveEnabledAnnotation          = annotation.IngressPrefix + "/tcp-keep-alive"
	TCPKeepAliveIdleAnnotation             = annotation.IngressPrefix + "/tcp-keep-alive-idle"
	TCPKeepAliveProbeIntervalAnnotation    = annotation.IngressPrefix + "/tcp-keep-alive-probe-interval"
	TCPKeepAliveProbeMaxFailuresAnnotation = annotation.IngressPrefix + "/tcp-keep-alive-probe-max-failures"
	WebsocketEnabledAnnotation             = annotation.IngressPrefix + "/websocket"

	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"

	TCPKeepAliveEnabledAnnotationAlias          = annotation.Prefix + "/tcp-keep-alive"
	TCPKeepAliveIdleAnnotationAlias             = annotation.Prefix + "/tcp-keep-alive-idle"
	TCPKeepAliveProbeIntervalAnnotationAlias    = annotation.Prefix + "/tcp-keep-alive-probe-interval"
	TCPKeepAliveProbeMaxFailuresAnnotationAlias = annotation.Prefix + "/tcp-keep-alive-probe-max-failures"
	WebsocketEnabledAnnotationAlias             = annotation.Prefix + "/websocket"
)

View Source

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

Variables ¶

This section is empty.

Functions ¶

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 GetAnnotationSecureNodePort ¶

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

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

func GetAnnotationServiceType ¶

func GetAnnotationServiceType(ingress *networkingv1.Ingress) string

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

func GetAnnotationTCPKeepAliveEnabled ¶

func GetAnnotationTCPKeepAliveEnabled(ingress *networkingv1.Ingress) int64

GetAnnotationTCPKeepAliveEnabled returns 1 if enabled (default), 0 if disabled

func GetAnnotationTCPKeepAliveIdle ¶

func GetAnnotationTCPKeepAliveIdle(ingress *networkingv1.Ingress) int64

GetAnnotationTCPKeepAliveIdle returns the time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes. Defaults to 10s. Related references:

https://man7.org/linux/man-pages/man7/tcp.7.html

func GetAnnotationTCPKeepAliveProbeInterval ¶

func GetAnnotationTCPKeepAliveProbeInterval(ingress *networkingv1.Ingress) int64

GetAnnotationTCPKeepAliveProbeInterval returns the time (in seconds) between individual keepalive probes. Defaults to 5s. Related references:

https://man7.org/linux/man-pages/man7/tcp.7.html

func GetAnnotationTCPKeepAliveProbeMaxFailures ¶

func GetAnnotationTCPKeepAliveProbeMaxFailures(ingress *networkingv1.Ingress) int64

GetAnnotationTCPKeepAliveProbeMaxFailures returns the maximum number of keepalive probes TCP should send before dropping the connection. Defaults to 10. Related references:

https://man7.org/linux/man-pages/man7/tcp.7.html

func GetAnnotationTLSPassthroughEnabled ¶ added in v1.15.0

func GetAnnotationTLSPassthroughEnabled(ingress *networkingv1.Ingress) bool

func GetAnnotationWebsocketEnabled ¶

func GetAnnotationWebsocketEnabled(ingress *networkingv1.Ingress) int64

GetAnnotationWebsocketEnabled returns 1 if enabled (default), 0 if disabled

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL