package
0.0.0-20250304062824-53a89fc29d30
Repository: https://github.com/azure/application-gateway-kubernetes-ingress.git
Documentation: pkg.go.dev

# Functions

BackendHostName override hostname.
BackendPathPrefix override path.
BackendProtocol provides value for protocol to be used with the backend.
ConnectionDrainingTimeout provides value for draining timeout for backends.
GetAppGwSslCertificate refer to appgw installed certificate.
GetAppGwSslProfile refer to appgw installed certificate.
GetAppGwTrustedRootCertificate refer to appgw installed root certificate.
GetHostNameExtensions from a given ingress.
GetRequestRoutingRulePriority gets the request routing rule priority.
HealthProbeHostName probe hostname override.
HealthProbeInterval probe interval.
HealthProbePath probe path override.
HealthProbePort probe port override.
HealthProbeStatusCodes probe status codes.
HealthProbeTimeout probe timeout.
HealthProbeUnhealthyThreshold probe threshold.
IngressClass returns ingress class annotation value if set.
IsConnectionDraining provides whether connection draining is enabled or not.
IsCookieBasedAffinity provides value to enable/disable cookie based affinity for client connection.
IsCookieBasedAffinityDistinctName provides value to enable/disable distinct cookie name based affinity for client connection.
IsSslRedirect for HTTP end points.
IngressClass returns istio ingress class annotation value if set.
OverrideFrontendPort determines whether to use a custom Frontend port.
RequestTimeout provides value for request timeout on the backend connection.
RewriteRuleSet name.
RewriteRuleSetCustomResource name.
UsePrivateIP determines whether to use private IP with the ingress.
WAFPolicy override path.

# Constants

AppGwSslCertificate indicates the name of ssl certificate installed by AppGw.
AppGwSslProfile indicates the name of the ssl profile installed by AppGw.
AppGwTrustedRootCertificate indicates the names of trusted root certificates Multiple root certificates separated by comma, e.g.
ApplicationGatewayPrefix defines the prefix for all keys associated with Application Gateway Ingress controller.
BackendHostNameKey defines the key for Host which should be used as when making a connection to the backend.
BackendPathPrefixKey defines the key for Path which should be used as a prefix for all HTTP requests.
BackendProtocolKey defines the key to determine whether to use private ip with the ingress.
ConnectionDrainingKey defines the key to enable/disable connection draining.
ConnectionDrainingTimeoutKey defines the drain timeout for the backends.
CookieBasedAffinityDistinctNameKey defines the key to enable/disable distinct cookie names per backend for client connection.
CookieBasedAffinityKey defines the key to enable/disable cookie based affinity for client connection.
FirewallPolicy is the key part of a key/value Ingress annotation.
HealthProbeHostKey defines the key for Host which should be used as a target for health probe.
HealthProbeIntervalKey defines the probe interval in seconds.
HealthProbePathKey defines the key for URL path which should be used as a target for health probe.
HealthProbePortKey defines the key for port that should be used as a target for health probe.
HealthProbeStatusCodesKey defines status codes returned by the probe to be interpreted as healty service.
HealthProbeTimeoutKey defines the probe timeout in seconds.
HealthProbeUnhealthyThresholdKey defines threshold for marking backend server as unhealthy.
HostNameExtensionKey defines the key to add multiple hostnames to ingress rules including wildcard hostnames annotation will be appgw.ingress.kubernetes.io/hostname-extension : "hostname1, hostname2" The extended hostnames will be appended to ingress host for a rule if specified.
HTTP is enum for http protocol.
HTTPS is enum for https protocol.
IngressClassKey defines the key of the annotation which needs to be set in order to specify that this is an ingress resource meant for the application gateway ingress controller.
IstioGatewayKey defines the key of the annotation which needs to be set in order to specify that this is a gateway meant for the application gateway ingress controller.
OverrideFrontendPortKey defines the key to define a custom fronend port.
RequestRoutingRulePriority indicates the priority of the Request Routing Rules.
RequestTimeoutKey defines the request timeout to the backend.
RewriteRuleSetCustomResourceKey indicates the name of the rule set CRD to use for header CRD and URL Config.
RewriteRuleSetKey indicates the name of the rule set to overwrite HTTP headers.
SslRedirectKey defines the key for defining with SSL redirect should be turned on for an HTTP endpoint.
UsePrivateIPKey defines the key to determine whether to use private ip with the ingress.

# Variables

ProtocolEnumLookup is a reverse map of the EventType enums; used for logging purposes.

# Type aliases

ProtocolEnum is the type for protocol.