types

Documentation

Index

• Constants
• Variables

Constants

const (
	TCPConfigTCPService     = "config-tcp-service"
	TCPTCPServiceLogFormat  = "tcp-service-log-format"
	TCPTCPServicePort       = "tcp-service-port"
	TCPTCPServiceProxyProto = "tcp-service-proxy-protocol"
)

TCP Service Annotations

const (
	HostAcmePreferredChain     = "acme-preferred-chain"
	HostAppRoot                = "app-root"
	HostAuthTLSErrorPage       = "auth-tls-error-page"
	HostAuthTLSSecret          = "auth-tls-secret"
	HostAuthTLSStrict          = "auth-tls-strict"
	HostAuthTLSVerifyClient    = "auth-tls-verify-client"
	HostCertSigner             = "cert-signer"
	HostRedirectFrom           = "redirect-from"
	HostRedirectFromRegex      = "redirect-from-regex"
	HostServerAlias            = "server-alias"
	HostServerAliasRegex       = "server-alias-regex"
	HostSSLAlwaysAddHTTPS      = "ssl-always-add-https"
	HostSSLCiphers             = "ssl-ciphers"
	HostSSLCipherSuites        = "ssl-cipher-suites"
	HostSSLOptionsHost         = "ssl-options-host"
	HostSSLPassthrough         = "ssl-passthrough"
	HostSSLPassthroughHTTPPort = "ssl-passthrough-http-port"
	HostTLSALPN                = "tls-alpn"
	HostVarNamespace           = "var-namespace"
)

Host Annotations

const (
	BackAffinity               = "affinity"
	BackAgentCheckAddr         = "agent-check-addr"
	BackAgentCheckInterval     = "agent-check-interval"
	BackAgentCheckPort         = "agent-check-port"
	BackAgentCheckSend         = "agent-check-send"
	BackAllowlistSourceRange   = "allowlist-source-range"
	BackAllowlistSourceHeader  = "allowlist-source-header"
	BackAssignBackendServerID  = "assign-backend-server-id"
	BackAuthExternalPlacement  = "auth-external-placement"
	BackAuthHeadersFail        = "auth-headers-fail"
	BackAuthHeadersRequest     = "auth-headers-request"
	BackAuthHeadersSucceed     = "auth-headers-succeed"
	BackAuthMethod             = "auth-method"
	BackAuthRealm              = "auth-realm"
	BackAuthSecret             = "auth-secret"
	BackAuthSignin             = "auth-signin"
	BackAuthTLSCertHeader      = "auth-tls-cert-header"
	BackAuthURL                = "auth-url"
	BackBackendCheckInterval   = "backend-check-interval"
	BackBackendProtocol        = "backend-protocol"
	BackBackendServerNaming    = "backend-server-naming"
	BackBackendServerSlotsInc  = "backend-server-slots-increment"
	BackBalanceAlgorithm       = "balance-algorithm"
	BackBlueGreenBalance       = "blue-green-balance"
	BackBlueGreenCookie        = "blue-green-cookie"
	BackBlueGreenDeploy        = "blue-green-deploy"
	BackBlueGreenHeader        = "blue-green-header"
	BackBlueGreenMode          = "blue-green-mode"
	BackConfigBackend          = "config-backend"
	BackCorsAllowCredentials   = "cors-allow-credentials"
	BackCorsAllowHeaders       = "cors-allow-headers"
	BackCorsAllowMethods       = "cors-allow-methods"
	BackCorsAllowOrigin        = "cors-allow-origin"
	BackCorsAllowOriginRegex   = "cors-allow-origin-regex"
	BackCorsEnable             = "cors-enable"
	BackCorsExposeHeaders      = "cors-expose-headers"
	BackCorsMaxAge             = "cors-max-age"
	BackDenylistSourceRange    = "denylist-source-range"
	BackDynamicScaling         = "dynamic-scaling"
	BackHeaders                = "headers"
	BackHealthCheckAddr        = "health-check-addr"
	BackHealthCheckFallCount   = "health-check-fall-count"
	BackHealthCheckInterval    = "health-check-interval"
	BackHealthCheckPort        = "health-check-port"
	BackHealthCheckRiseCount   = "health-check-rise-count"
	BackHealthCheckURI         = "health-check-uri"
	BackHSTS                   = "hsts"
	BackHSTSIncludeSubdomains  = "hsts-include-subdomains"
	BackHSTSMaxAge             = "hsts-max-age"
	BackHSTSPreload            = "hsts-preload"
	BackHTTPHeaderMatch        = "http-header-match"
	BackHTTPHeaderMatchRegex   = "http-header-match-regex"
	BackInitialWeight          = "initial-weight"
	BackLimitConnections       = "limit-connections"
	BackLimitRPS               = "limit-rps"
	BackLimitWhitelist         = "limit-whitelist"
	BackMaxconnServer          = "maxconn-server"
	BackMaxQueueServer         = "maxqueue-server"
	BackOAuth                  = "oauth"
	BackOAuthHeaders           = "oauth-headers"
	BackOAuthURIPrefix         = "oauth-uri-prefix"
	BackPathType               = "path-type"
	BackProxyBodySize          = "proxy-body-size"
	BackProxyProtocol          = "proxy-protocol"
	BackRedirectTo             = "redirect-to"
	BackRewriteTarget          = "rewrite-target"
	BackSlotsMinFree           = "slots-min-free"
	BackSecureBackends         = "secure-backends"
	BackSecureCrtSecret        = "secure-crt-secret"
	BackSecureSNI              = "secure-sni"
	BackSecureVerifyCASecret   = "secure-verify-ca-secret"
	BackSecureVerifyHostname   = "secure-verify-hostname"
	BackServiceUpstream        = "service-upstream"
	BackSessionCookieDomain    = "session-cookie-domain"
	BackSessionCookieDynamic   = "session-cookie-dynamic"
	BackSessionCookieKeywords  = "session-cookie-keywords"
	BackSessionCookieName      = "session-cookie-name"
	BackSessionCookiePreserve  = "session-cookie-preserve"
	BackSessionCookieSameSite  = "session-cookie-same-site"
	BackSessionCookieShared    = "session-cookie-shared"
	BackSessionCookieStrategy  = "session-cookie-strategy"
	BackSessionCookieValue     = "session-cookie-value-strategy"
	BackSourceAddressIntf      = "source-address-intf"
	BackSSLCipherSuitesBackend = "ssl-cipher-suites-backend"
	BackSSLCiphersBackend      = "ssl-ciphers-backend"
	BackSSLFingerprintLower    = "ssl-fingerprint-lower"
	BackSSLFingerprintSha2Bits = "ssl-fingerprint-sha2-bits"
	BackSSLOptionsBackend      = "ssl-options-backend"
	BackSSLRedirect            = "ssl-redirect"
	BackTimeoutConnect         = "timeout-connect"
	BackTimeoutHTTPRequest     = "timeout-http-request"
	BackTimeoutKeepAlive       = "timeout-keep-alive"
	BackTimeoutQueue           = "timeout-queue"
	BackTimeoutServer          = "timeout-server"
	BackTimeoutServerFin       = "timeout-server-fin"
	BackTimeoutTunnel          = "timeout-tunnel"
	BackUseResolver            = "use-resolver"
	BackWAF                    = "waf"
	BackWAFMode                = "waf-mode"
	BackWhitelistSourceRange   = "whitelist-source-range"
)

Backend Annotations

const (
	GlobalAcmeEmails                   = "acme-emails"
	GlobalAcmeEndpoint                 = "acme-endpoint"
	GlobalAcmeExpiring                 = "acme-expiring"
	GlobalAcmeShared                   = "acme-shared"
	GlobalAcmeTermsAgreed              = "acme-terms-agreed"
	GlobalAuthLogFormat                = "auth-log-format"
	GlobalAuthProxy                    = "auth-proxy"
	GlobalBindFrontingProxy            = "bind-fronting-proxy"
	GlobalBindHTTP                     = "bind-http"
	GlobalBindHTTPS                    = "bind-https"
	GlobalBindIPAddrHealthz            = "bind-ip-addr-healthz"
	GlobalBindIPAddrHTTP               = "bind-ip-addr-http"
	GlobalBindIPAddrPrometheus         = "bind-ip-addr-prometheus"
	GlobalBindIPAddrStats              = "bind-ip-addr-stats"
	GlobalBindIPAddrTCP                = "bind-ip-addr-tcp"
	GlobalCloseSessionsDuration        = "close-sessions-duration"
	GlobalConfigDefaults               = "config-defaults"
	GlobalConfigFrontend               = "config-frontend"
	GlobalConfigFrontendEarly          = "config-frontend-early"
	GlobalConfigFrontendLate           = "config-frontend-late"
	GlobalConfigGlobal                 = "config-global"
	GlobalConfigProxy                  = "config-proxy"
	GlobalConfigSections               = "config-sections"
	GlobalConfigTCP                    = "config-tcp"
	GlobalCookieKey                    = "cookie-key"
	GlobalCPUMap                       = "cpu-map"
	GlobalCrossNamespaceSecretsCA      = "cross-namespace-secrets-ca"
	GlobalCrossNamespaceSecretsCrt     = "cross-namespace-secrets-crt"
	GlobalCrossNamespaceSecretsPasswd  = "cross-namespace-secrets-passwd"
	GlobalCrossNamespaceServices       = "cross-namespace-services"
	GlobalDefaultBackendRedirect       = "default-backend-redirect"
	GlobalDefaultBackendRedirectCode   = "default-backend-redirect-code"
	GlobalDNSAcceptedPayloadSize       = "dns-accepted-payload-size"
	GlobalDNSClusterDomain             = "dns-cluster-domain"
	GlobalDNSHoldObsolete              = "dns-hold-obsolete"
	GlobalDNSHoldValid                 = "dns-hold-valid"
	GlobalDNSResolvers                 = "dns-resolvers"
	GlobalDNSTimeoutRetry              = "dns-timeout-retry"
	GlobalDrainSupport                 = "drain-support"
	GlobalDrainSupportRedispatch       = "drain-support-redispatch"
	GlobalExternalHasLua               = "external-has-lua"
	GlobalForwardfor                   = "forwardfor"
	GlobalFrontingProxyPort            = "fronting-proxy-port"
	GlobalGroupname                    = "groupname"
	GlobalHealthzPort                  = "healthz-port"
	GlobalHTTPLogFormat                = "http-log-format"
	GlobalHTTPPort                     = "http-port"
	GlobalHTTPResponse200              = "http-response-200"
	GlobalHTTPResponse400              = "http-response-400"
	GlobalHTTPResponse401              = "http-response-401"
	GlobalHTTPResponse403              = "http-response-403"
	GlobalHTTPResponse404              = "http-response-404"
	GlobalHTTPResponse405              = "http-response-405"
	GlobalHTTPResponse407              = "http-response-407"
	GlobalHTTPResponse408              = "http-response-408"
	GlobalHTTPResponse410              = "http-response-410"
	GlobalHTTPResponse413              = "http-response-413"
	GlobalHTTPResponse421              = "http-response-421"
	GlobalHTTPResponse425              = "http-response-425"
	GlobalHTTPResponse429              = "http-response-429"
	GlobalHTTPResponse495              = "http-response-495"
	GlobalHTTPResponse496              = "http-response-496"
	GlobalHTTPResponse500              = "http-response-500"
	GlobalHTTPResponse501              = "http-response-501"
	GlobalHTTPResponse502              = "http-response-502"
	GlobalHTTPResponse503              = "http-response-503"
	GlobalHTTPResponse504              = "http-response-504"
	GlobalHTTPResponsePrometheusRoot   = "http-response-prometheus-root"
	GlobalHTTPSLogFormat               = "https-log-format"
	GlobalHTTPSPort                    = "https-port"
	GlobalHTTPStoHTTPPort              = "https-to-http-port"
	GlobalLoadServerState              = "load-server-state"
	GlobalMasterExitOnFailure          = "master-exit-on-failure"
	GlobalMaxConnections               = "max-connections"
	GlobalModsecurityArgs              = "modsecurity-args"
	GlobalModsecurityEndpoints         = "modsecurity-endpoints"
	GlobalModsecurityTimeoutConnect    = "modsecurity-timeout-connect"
	GlobalModsecurityTimeoutHello      = "modsecurity-timeout-hello"
	GlobalModsecurityTimeoutIdle       = "modsecurity-timeout-idle"
	GlobalModsecurityTimeoutProcessing = "modsecurity-timeout-processing"
	GlobalModsecurityTimeoutServer     = "modsecurity-timeout-server"
	GlobalModsecurityUseCoraza         = "modsecurity-use-coraza"
	GlobalNbprocBalance                = "nbproc-balance"
	GlobalNbprocSSL                    = "nbproc-ssl"
	GlobalNbthread                     = "nbthread"
	GlobalNoTLSRedirectLocations       = "no-tls-redirect-locations"
	GlobalOriginalForwardedForHdr      = "original-forwarded-for-hdr"
	GlobalPathTypeOrder                = "path-type-order"
	GlobalPrometheusPort               = "prometheus-port"
	GlobalRealIPHdr                    = "real-ip-hdr"
	GlobalRedirectFromCode             = "redirect-from-code"
	GlobalRedirectToCode               = "redirect-to-code"
	GlobalSSLDHDefaultMaxSize          = "ssl-dh-default-max-size"
	GlobalSSLDHParam                   = "ssl-dh-param"
	GlobalSSLEngine                    = "ssl-engine"
	GlobalSSLHeadersPrefix             = "ssl-headers-prefix"
	GlobalSSLModeAsync                 = "ssl-mode-async"
	GlobalSSLOptions                   = "ssl-options"
	GlobalSSLRedirectCode              = "ssl-redirect-code"
	GlobalStatsAuth                    = "stats-auth"
	GlobalStatsPort                    = "stats-port"
	GlobalStatsProxyProtocol           = "stats-proxy-protocol"
	GlobalStatsSSLCert                 = "stats-ssl-cert"
	GlobalStrictHost                   = "strict-host"
	GlobalSyslogEndpoint               = "syslog-endpoint"
	GlobalSyslogFormat                 = "syslog-format"
	GlobalSyslogLength                 = "syslog-length"
	GlobalSyslogTag                    = "syslog-tag"
	GlobalTCPLogFormat                 = "tcp-log-format"
	GlobalTimeoutClient                = "timeout-client"
	GlobalTimeoutClientFin             = "timeout-client-fin"
	GlobalTimeoutStop                  = "timeout-stop"
	GlobalUseChroot                    = "use-chroot"
	GlobalUseCPUMap                    = "use-cpu-map"
	GlobalUseForwardedProto            = "use-forwarded-proto"
	GlobalUseHAProxyUser               = "use-haproxy-user"
	GlobalUseHTX                       = "use-htx"
	GlobalUseProxyProtocol             = "use-proxy-protocol"
	GlobalUsername                     = "username"
	GlobalWorkerMaxReloads             = "worker-max-reloads"
)

Global config

const (
	ExtraTLSAcme = "kubernetes.io/tls-acme"
)

Extra Annotations

Variables

var (
	// AnnHost ...
	AnnHost = map[string]struct{}{
		HostAcmePreferredChain:     {},
		HostAppRoot:                {},
		HostAuthTLSErrorPage:       {},
		HostAuthTLSSecret:          {},
		HostAuthTLSStrict:          {},
		HostAuthTLSVerifyClient:    {},
		HostCertSigner:             {},
		HostServerAlias:            {},
		HostRedirectFrom:           {},
		HostRedirectFromRegex:      {},
		HostServerAliasRegex:       {},
		HostSSLAlwaysAddHTTPS:      {},
		HostSSLCiphers:             {},
		HostSSLCipherSuites:        {},
		HostSSLOptionsHost:         {},
		HostSSLPassthrough:         {},
		HostSSLPassthroughHTTPPort: {},
		HostTLSALPN:                {},
		HostVarNamespace:           {},
	}

	// AnnDuo is the list of annotations that should be added
	// on both host and backend annotations list.
	// TODO: merge tcp, host and backend config keys into a single list?
	AnnDuo = map[string]struct{}{
		BackAuthExternalPlacement: {},
		BackAuthHeadersFail:       {},
		BackAuthHeadersRequest:    {},
		BackAuthHeadersSucceed:    {},
		BackAuthMethod:            {},
		BackAuthSignin:            {},
		BackAuthURL:               {},
	}
)

var (
	// AnnTCP ...
	AnnTCP = map[string]struct{}{
		TCPConfigTCPService:     {},
		TCPTCPServiceLogFormat:  {},
		TCPTCPServicePort:       {},
		TCPTCPServiceProxyProto: {},
	}
)