Annotations - AWS Load Balancer Controller (original) (raw)

Ingress annotations¶

You can add annotations to kubernetes Ingress and Service objects to customize their behavior.

• Annotation keys and values can only be strings. Advanced format should be encoded as below:
  • boolean: 'true'
  • integer: '42'
  • stringList: s1,s2,s3
  • stringMap: k1=v1,k2=v2
  • json: 'jsonContent'
• Annotations applied to Service have higher priority over annotations applied to Ingress. Location column below indicates where that annotation can be applied to.
• Annotations that configures LoadBalancer / Listener behaviors have different merge behavior when IngressGroup feature is been used. MergeBehavior column below indicates how such annotation will be merged.
  • Exclusive: such annotation should only be specified on a single Ingress within IngressGroup or specified with same value across all Ingresses within IngressGroup.
  • Merge: such annotation can be specified on all Ingresses within IngressGroup, and will be merged together.

EKS Auto Mode users

If you are using EKS Auto Mode, please see theEKS Auto Mode documentationfor key differences between the load balancing capability of EKS Auto Mode and the open source load balancer controller.

IngressGroup¶

IngressGroup feature enables you to group multiple Ingress resources together. The controller will automatically merge Ingress rules for all Ingresses within IngressGroup and support them with a single ALB. In addition, most annotations defined on an Ingress only apply to the paths defined by that Ingress.

By default, Ingresses don't belong to any IngressGroup, and we treat it as a "implicit IngressGroup" consisting of the Ingress itself.

• alb.ingress.kubernetes.io/group.name specifies the group name that this Ingress belongs to.
  • Ingresses with same group.name annotation will form an "explicit IngressGroup".
  • groupName must consist of lower case alphanumeric characters, - or ., and must start and end with an alphanumeric character.
  • groupName must be no more than 63 character.
    Security Risk
    IngressGroup feature should only be used when all Kubernetes users with RBAC permission to create/modify Ingress resources are within trust boundary.
    If you turn your Ingress to belong a "explicit IngressGroup" by adding group.name annotation, other Kubernetes users may create/modify their Ingresses to belong to the same IngressGroup, and can thus add more rules or overwrite existing rules with higher priority to the ALB for your Ingress.
    We'll add more fine-grained access-control in future versions.
    Rename behavior
    The ALB for an IngressGroup is found by searching for an AWS tag ingress.k8s.aws/stack tag with the name of the IngressGroup as its value. For an implicit IngressGroup, the value is namespace/ingressname.
    When the groupName of an IngressGroup for an Ingress is changed, the Ingress will be moved to a new IngressGroup and be supported by the ALB for the new IngressGroup. If the ALB for the new IngressGroup doesn't exist, a new ALB will be created.
    If an IngressGroup no longer contains any Ingresses, the ALB for that IngressGroup will be deleted and any deletion protection of that ALB will be ignored.
    Example
    alb.ingress.kubernetes.io/group.name: my-team.awesome-group
• alb.ingress.kubernetes.io/group.order specifies the order across all Ingresses within IngressGroup.
  • You can explicitly denote the order using a number between -1000 and 1000
  • The smaller the order, the rule will be evaluated first. All Ingresses without an explicit order setting get order value as 0
  • Rules with the same order are sorted lexicographically by the Ingress’s namespace/name.
    Example
    alb.ingress.kubernetes.io/group.order: '10'

Traffic Listening¶

Traffic Listening can be controlled with the following annotations:

• alb.ingress.kubernetes.io/listen-ports specifies the ports that ALB listens on.
  Merge Behavior
  listen-ports is merged across all Ingresses in IngressGroup.
  • You can define different listen-ports per Ingress, Ingress rules will only impact the ports defined for that Ingress.
  • If same listen-port is defined by multiple Ingress within IngressGroup, Ingress rules will be merged with respect to their group order within IngressGroup.
    Default
  • defaults to '[{"HTTP": 80}]' or '[{"HTTPS": 443}]' depending on whether certificate-arn is specified.
    You may not have duplicate load balancer ports defined.
    Example
    alb.ingress.kubernetes.io/listen-ports: '[{"HTTP": 80}, {"HTTPS": 443}, {"HTTP": 8080}, {"HTTPS": 8443}]'
• alb.ingress.kubernetes.io/ssl-redirect enables SSLRedirect and specifies the SSL port that redirects to.
  Merge Behavior
  ssl-redirect is exclusive across all Ingresses in IngressGroup.
  • Once defined on a single Ingress, it impacts every Ingress within IngressGroup.
  • Once enabled SSLRedirect, every HTTP listener will be configured with a default action which redirects to HTTPS, other rules will be ignored.
  • The SSL port that redirects to must exists on LoadBalancer. See alb.ingress.kubernetes.io/listen-ports for the listen ports configuration.
    Example
    alb.ingress.kubernetes.io/ssl-redirect: '443'
• alb.ingress.kubernetes.io/ip-address-type specifies the IP address type of ALB.
  Example
  alb.ingress.kubernetes.io/ip-address-type: ipv4
• alb.ingress.kubernetes.io/customer-owned-ipv4-pool specifies the customer-owned IPv4 address pool for ALB on Outpost.
  This annotation should be treated as immutable. To remove or change coIPv4Pool, you need to recreate Ingress.
  Example
  alb.ingress.kubernetes.io/customer-owned-ipv4-pool: ipv4pool-coip-xxxxxxxx

Traffic Routing¶

Traffic Routing can be controlled with following annotations:

• alb.ingress.kubernetes.io/load-balancer-name specifies the custom name to use for the load balancer. Name longer than 32 characters will be treated as an error.
  Merge Behavior
  name is exclusive across all Ingresses in an IngressGroup.
  • Once defined on a single Ingress, it impacts every Ingress within the IngressGroup.
    Annotation Behavior
  • This annotation takes effect only during the creation of the Ingress. If the Ingress already exists, the change will not be applied until the Ingress is deleted and recreated.
    Example
    alb.ingress.kubernetes.io/load-balancer-name: custom-name
• alb.ingress.kubernetes.io/target-type specifies how to route traffic to pods. You can choose between instance and ip:
  • instance mode will route traffic to all ec2 instances within cluster on NodePort opened for your service.
    service must be of type "NodePort" or "LoadBalancer" to use instance mode
  • ip mode will route traffic directly to the pod IP.
    ip mode is required for sticky sessions to work with Application Load Balancers. The Service type does not matter, when using ip mode.
    Example
    alb.ingress.kubernetes.io/target-type: instance
• alb.ingress.kubernetes.io/target-node-labels specifies which nodes to include in the target group registration for instance target type.
  Example
  alb.ingress.kubernetes.io/target-node-labels: label1=value1, label2=value2
• alb.ingress.kubernetes.io/backend-protocol specifies the protocol used when route traffic to pods.
  Example
  alb.ingress.kubernetes.io/backend-protocol: HTTPS
• alb.ingress.kubernetes.io/backend-protocol-version specifies the application protocol used to route traffic to pods. Only valid when HTTP or HTTPS is used as the backend protocol.
  Example
  • HTTP2
    alb.ingress.kubernetes.io/backend-protocol-version: HTTP2
  • GRPC
    alb.ingress.kubernetes.io/backend-protocol-version: GRPC
• alb.ingress.kubernetes.io/subnets specifies the Availability Zones that the ALB will route traffic to. See Load Balancer subnets for more details.
  You must specify at least two subnets in different AZs unless utilizing the outpost locale, in which case a single subnet suffices. Either subnetID or subnetName(Name tag on subnets) can be used.
  You must not mix subnets from different locales: availability-zone, local-zone, wavelength-zone, outpost.
  Tip
  You can enable subnet auto discovery to avoid specifying this annotation on every Ingress. See Subnet Discovery for instructions.
  Example
  alb.ingress.kubernetes.io/subnets: subnet-xxxx, mySubnet
• alb.ingress.kubernetes.io/ipam-ipv4-pool-id Specifies the IPv4 IPAM Pool ID which will be used by your load balancer to assign IP addresses.

!!!note "" The chosen IPAM pool is always the prioritized source when assigning public IPv4 addresses. If there are no more assignable IP addresses in the IPAM pool, AWS managed IPv4 addresses are assigned.

!!!tip To remove an IPAM pool associated to your ALB, remove the annotation from your ingress.

!!!example

alb.ingress.kubernetes.io/ipam-ipv4-pool-id: ipam-pool-0f995c17c00375b48

• alb.ingress.kubernetes.io/actions.${action-name} Provides a method for configuring custom actions on a listener, such as Redirect Actions.
  The action-name in the annotation must match the serviceName in the Ingress rules, and servicePort must be use-annotation.
  use ARN in forward Action
  ARN can be used in forward action(both simplified schema and advanced schema), it must be an targetGroup created outside of k8s, typically an targetGroup for legacy application.
  use ServiceName/ServicePort in forward Action
  ServiceName/ServicePort can be used in forward action(advanced schema only).
  Auth related annotations on Service object will only be respected if a single TargetGroup in is used.
  Example
  • response-503: return fixed 503 response
  • redirect-to-eks: redirect to an external url
  • forward-single-tg: forward to a single targetGroup [simplified schema]
  • forward-multiple-tg: forward to multiple targetGroups with different weights and stickiness config [advanced schema]
    `apiVersion: networking.k8s.io/v1
    kind: Ingress
    metadata:
    namespace: default
    name: ingress
    annotations:
    alb.ingress.kubernetes.io/scheme: internet-facing
    alb.ingress.kubernetes.io/actions.response-503: >
    {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"503","messageBody":"503 error text"}}
    alb.ingress.kubernetes.io/actions.redirect-to-eks: >
    {"type":"redirect","redirectConfig":{"host":"aws.amazon.com","path":"/eks/","port":"443","protocol":"HTTPS","query":"k=v","statusCode":"HTTP_302"}}
    alb.ingress.kubernetes.io/actions.forward-single-tg: >
    {"type":"forward","targetGroupARN": "arn-of-your-target-group"}
    alb.ingress.kubernetes.io/actions.forward-multiple-tg: >
    {"type":"forward","forwardConfig":{"targetGroups":[{"serviceName":"service-1","servicePort":"http","weight":20},{"serviceName":"service-2","servicePort":80,"weight":20},{"targetGroupARN":"arn-of-your-non-k8s-target-group","weight":60}],"targetGroupStickinessConfig":{"enabled":true,"durationSeconds":200}}}

spec:
ingressClassName: alb
rules:
- http:
paths:
- path: /503
pathType: Exact
backend:
service:
name: response-503
port:
name: use-annotation
- path: /eks
pathType: Exact
backend:
service:
name: redirect-to-eks
port:
name: use-annotation
- path: /path1
pathType: Exact
backend:
service:
name: forward-single-tg
port:
name: use-annotation
- path: /path2
pathType: Exact
backend:
service:
name: forward-multiple-tg
port:
name: use-annotation
`

• alb.ingress.kubernetes.io/conditions.${conditions-name} Provides a method for specifying routing conditions in addition to original host/path condition on Ingress spec.
  The conditions-name in the annotation must match the serviceName in the Ingress rules. It can be a either real serviceName or an annotation based action name when servicePort is use-annotation.
  limitations
  General ALB limitations applies:
  1. Each rule can optionally include up to one of each of the following conditions: host-header, http-request-method, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string.
  2. You can specify up to three match evaluations per condition.
  3. You can specify up to five match evaluations per rule.
     Refer ALB documentation for more details.
     Example
  • rule-path1:
    * Host is www.example.com OR anno.example.com
    * Path is /path1
  • rule-path2:
    * Host is www.example.com
    * Path is /path2 OR /anno/path2
  • rule-path3:
    * Host is www.example.com
    * Path is /path3
    * Http header HeaderName is HeaderValue1 OR HeaderValue2
  • rule-path4:
    * Host is www.example.com
    * Path is /path4
    * Http request method is GET OR HEAD
  • rule-path5:
    * Host is www.example.com
    * Path is /path5
    * Query string is paramA:valueA1 OR paramA:valueA2
  • rule-path6:
    * Host is www.example.com
    * Path is /path6
    * Source IP is192.168.0.0/16 OR 172.16.0.0/16
  • rule-path7:
    * Host is www.example.com
    * Path is /path7
    * Http header HeaderName is HeaderValue
    * Query string is paramA:valueA
    * Query string is paramB:valueB

apiVersion: networking.k8s.io/v1 kind: Ingress metadata: namespace: default name: ingress annotations: alb.ingress.kubernetes.io/scheme: internet-facing alb.ingress.kubernetes.io/actions.rule-path1: > {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"200","messageBody":"Host is www.example.com OR anno.example.com"}} alb.ingress.kubernetes.io/conditions.rule-path1: > [{"field":"host-header","hostHeaderConfig":{"values":["anno.example.com"]}}] alb.ingress.kubernetes.io/actions.rule-path2: > {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"200","messageBody":"Path is /path2 OR /anno/path2"}} alb.ingress.kubernetes.io/conditions.rule-path2: > [{"field":"path-pattern","pathPatternConfig":{"values":["/anno/path2"]}}] alb.ingress.kubernetes.io/actions.rule-path3: > {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"200","messageBody":"Http header HeaderName is HeaderValue1 OR HeaderValue2"}} alb.ingress.kubernetes.io/conditions.rule-path3: > [{"field":"http-header","httpHeaderConfig":{"httpHeaderName": "HeaderName", "values":["HeaderValue1", "HeaderValue2"]}}] alb.ingress.kubernetes.io/actions.rule-path4: > {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"200","messageBody":"Http request method is GET OR HEAD"}} alb.ingress.kubernetes.io/conditions.rule-path4: > [{"field":"http-request-method","httpRequestMethodConfig":{"Values":["GET", "HEAD"]}}] alb.ingress.kubernetes.io/actions.rule-path5: > {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"200","messageBody":"Query string is paramA:valueA1 OR paramA:valueA2"}} alb.ingress.kubernetes.io/conditions.rule-path5: > [{"field":"query-string","queryStringConfig":{"values":[{"key":"paramA","value":"valueA1"},{"key":"paramA","value":"valueA2"}]}}] alb.ingress.kubernetes.io/actions.rule-path6: > {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"200","messageBody":"Source IP is 192.168.0.0/16 OR 172.16.0.0/16"}} alb.ingress.kubernetes.io/conditions.rule-path6: > [{"field":"source-ip","sourceIpConfig":{"values":["192.168.0.0/16", "172.16.0.0/16"]}}] alb.ingress.kubernetes.io/actions.rule-path7: > {"type":"fixed-response","fixedResponseConfig":{"contentType":"text/plain","statusCode":"200","messageBody":"multiple conditions applies"}} alb.ingress.kubernetes.io/conditions.rule-path7: > [{"field":"http-header","httpHeaderConfig":{"httpHeaderName": "HeaderName", "values":["HeaderValue"]}},{"field":"query-string","queryStringConfig":{"values":[{"key":"paramA","value":"valueA"}]}},{"field":"query-string","queryStringConfig":{"values":[{"key":"paramB","value":"valueB"}]}}] spec: ingressClassName: alb rules: - host: www.example.com http: paths: - path: /path1 pathType: Exact backend: service: name: rule-path1 port: name: use-annotation - path: /path2 pathType: Exact backend: service: name: rule-path2 port: name: use-annotation - path: /path3 pathType: Exact backend: service: name: rule-path3 port: name: use-annotation - path: /path4 pathType: Exact backend: service: name: rule-path4 port: name: use-annotation - path: /path5 pathType: Exact backend: service: name: rule-path5 port: name: use-annotation - path: /path6 pathType: Exact backend: service: name: rule-path6 port: name: use-annotation - path: /path7 pathType: Exact backend: service: name: rule-path7 port: name: use-annotation
Note
If you are using alb.ingress.kubernetes.io/target-group-attributes with stickiness.enabled=true, you should add TargetGroupStickinessConfig under alb.ingress.kubernetes.io/actions.weighted-routing
Example
apiVersion: networking.k8s.io/v1 kind: Ingress metadata: namespace: default name: ingress annotations: alb.ingress.kubernetes.io/scheme: internet-facing alb.ingress.kubernetes.io/target-type: ip alb.ingress.kubernetes.io/target-group-attributes: stickiness.enabled=true,stickiness.lb_cookie.duration_seconds=60 alb.ingress.kubernetes.io/actions.weighted-routing: | { "type":"forward", "forwardConfig":{ "targetGroups":[ { "serviceName":"service-1", "servicePort":"80", "weight":50 }, { "serviceName":"service-2", "servicePort":"80", "weight":50 } ], "TargetGroupStickinessConfig": { "Enabled": true, "DurationSeconds": 120 } } } spec: ingressClassName: alb rules: - host: www.example.com http: paths: - path: / pathType: Prefix backend: service: name: weighted-routing port: name: use-annotation

Access control¶

Access control for LoadBalancer can be controlled with following annotations:

• alb.ingress.kubernetes.io/scheme specifies whether your LoadBalancer will be internet facing. See Load balancer scheme in the AWS documentation for more details.
  Example
  alb.ingress.kubernetes.io/scheme: internal
• alb.ingress.kubernetes.io/inbound-cidrs specifies the CIDRs that are allowed to access LoadBalancer.
  Merge Behavior
  inbound-cidrs is merged across all Ingresses in IngressGroup, but is exclusive per listen-port.
  • the inbound-cidrs will only impact the ports defined for that Ingress.
  • if same listen-port is defined by multiple Ingress within IngressGroup, inbound-cidrs should only be defined on one of the Ingress.
    Default
  • 0.0.0.0/0 will be used if the IPAddressType is "ipv4"
  • 0.0.0.0/0 and ::/0 will be used if the IPAddressType is "dualstack"
    this annotation will be ignored if alb.ingress.kubernetes.io/security-groups is specified.
    Example
    alb.ingress.kubernetes.io/inbound-cidrs: 10.0.0.0/24
• alb.ingress.kubernetes.io/security-group-prefix-lists specifies the managed prefix lists that are allowed to access LoadBalancer.
  Merge Behavior
  security-group-prefix-lists is merged across all Ingresses in IngressGroup, but is exclusive per listen-port.
  • the security-group-prefix-lists will only impact the ports defined for that Ingress.
  • if same listen-port is defined by multiple Ingress within IngressGroup, security-group-prefix-lists should only be defined on one of the Ingress.
    This annotation will be ignored if alb.ingress.kubernetes.io/security-groups is specified.
    If you'd like to use this annotation, make sure your security group rule quota is enough. If you'd like to know how the managed prefix list affects your quota, see the reference in the AWS documentation for more details.
    If you only use this annotation without inbound-cidrs, the controller managed security group would ignore the inbound-cidrs default settings.
    Example
    alb.ingress.kubernetes.io/security-group-prefix-lists: pl-000000, pl-111111
• alb.ingress.kubernetes.io/security-groups specifies the securityGroups you want to attach to LoadBalancer.
  When this annotation is not present, the controller will automatically create one security group, the security group will be attached to the LoadBalancer and allow access from inbound-cidrs and security-group-prefix-lists to the listen-ports. Also, the securityGroups for Node/Pod will be modified to allow inbound traffic from this securityGroup.
  If you specify this annotation, you need to configure the security groups on your Node/Pod to allow inbound traffic from the load balancer. You could also set the manage-backend-security-group-rules if you want the controller to manage the access rules.
  Both name or ID of securityGroups are supported. Name matches a Name tag, not the groupName attribute.
  Example
  alb.ingress.kubernetes.io/security-groups: sg-xxxx, nameOfSg1, nameOfSg2
• alb.ingress.kubernetes.io/manage-backend-security-group-rules specifies whether you want the controller to configure security group rules on Node/Pod for traffic access when you specify security-groups.
  This annotation applies only in case you specify the security groups via security-groups annotation. If set to true, controller attaches an additional shared backend security group to your load balancer. This backend security group is used in the Node/Pod security group rules.
  Example
  alb.ingress.kubernetes.io/manage-backend-security-group-rules: "true"

Authentication¶

ALB supports authentication with Cognito or OIDC. See Authenticate Users Using an Application Load Balancer for more details.

HTTPS only

Authentication is only supported for HTTPS listeners. See TLS for configuring HTTPS listeners.

• alb.ingress.kubernetes.io/auth-type specifies the authentication type on targets.
  Example
  alb.ingress.kubernetes.io/auth-type: cognito
• alb.ingress.kubernetes.io/auth-idp-cognito specifies the cognito idp configuration.
  For Amazon Cognito Domain only
  If you are using Amazon Cognito Domain, the userPoolDomain should be set to the domain prefix(my-domain) instead of full domain(https://my-domain.auth.us-west-2.amazoncognito.com)
  Example
  alb.ingress.kubernetes.io/auth-idp-cognito: '{"userPoolARN":"arn:aws:cognito-idp:us-west-2:xxx:userpool/xxx","userPoolClientID":"my-clientID","userPoolDomain":"my-domain"}'
• alb.ingress.kubernetes.io/auth-idp-oidc specifies the oidc idp configuration.
  You need to create an secret within the same namespace as Ingress to hold your OIDC clientID and clientSecret. The format of secret is as below:
  apiVersion: v1 kind: Secret metadata: namespace: testcase name: my-k8s-secret data: clientID: base64 of your plain text clientId clientSecret: base64 of your plain text clientSecret
  Example
  alb.ingress.kubernetes.io/auth-idp-oidc: '{"issuer":"https://example.com","authorizationEndpoint":"https://authorization.example.com","tokenEndpoint":"https://token.example.com","userInfoEndpoint":"https://userinfo.example.com","secretName":"my-k8s-secret"}'
• alb.ingress.kubernetes.io/auth-on-unauthenticated-request specifies the behavior if the user is not authenticated.
  options:
  • authenticate: try authenticate with configured IDP.
  • deny: return an HTTP 401 Unauthorized error.
  • allow: allow the request to be forwarded to the target.
    Example
    alb.ingress.kubernetes.io/auth-on-unauthenticated-request: authenticate
• alb.ingress.kubernetes.io/auth-scope specifies the set of user claims to be requested from the IDP(cognito or oidc), in a space-separated list.
  options:
  • phone
  • email
  • profile
  • openid
  • aws.cognito.signin.user.admin
    Example
    alb.ingress.kubernetes.io/auth-scope: 'email openid'
• alb.ingress.kubernetes.io/auth-session-cookie specifies the name of the cookie used to maintain session information
  Example
  alb.ingress.kubernetes.io/auth-session-cookie: custom-cookie
• alb.ingress.kubernetes.io/auth-session-timeout specifies the maximum duration of the authentication session, in seconds
  Example
  alb.ingress.kubernetes.io/auth-session-timeout: '86400'

Health Check¶

Health check on target groups can be controlled with following annotations:

• alb.ingress.kubernetes.io/healthcheck-protocol specifies the protocol used when performing health check on targets.
  Example
  alb.ingress.kubernetes.io/healthcheck-protocol: HTTPS
• alb.ingress.kubernetes.io/healthcheck-port specifies the port used when performing health check on targets.
  When using target-type: instance with a service of type "NodePort", the healthcheck port can be set to traffic-port to automatically point to the correct port.
  Example
  • set the healthcheck port to the traffic port
    alb.ingress.kubernetes.io/healthcheck-port: traffic-port
  • set the healthcheck port to the NodePort(when target-type=instance) or TargetPort(when target-type=ip) of a named port
    alb.ingress.kubernetes.io/healthcheck-port: my-port
  • set the healthcheck port to 80/tcp
    alb.ingress.kubernetes.io/healthcheck-port: '80'
• alb.ingress.kubernetes.io/healthcheck-path specifies the HTTP path when performing health check on targets.
  Example
  • HTTP
    alb.ingress.kubernetes.io/healthcheck-path: /ping
  • GRPC
    alb.ingress.kubernetes.io/healthcheck-path: /package.service/method
• alb.ingress.kubernetes.io/healthcheck-interval-seconds specifies the interval(in seconds) between health check of an individual target.
  Example
  alb.ingress.kubernetes.io/healthcheck-interval-seconds: '10'
• alb.ingress.kubernetes.io/healthcheck-timeout-seconds specifies the timeout(in seconds) during which no response from a target means a failed health check
  Example
  alb.ingress.kubernetes.io/healthcheck-timeout-seconds: '8'
• alb.ingress.kubernetes.io/success-codes specifies the HTTP or gRPC status code that should be expected when doing health checks against the specified health check path.
  Example
  • use single value
    alb.ingress.kubernetes.io/success-codes: '200'
  • use multiple values
    alb.ingress.kubernetes.io/success-codes: 200,201
  • use range of value
    alb.ingress.kubernetes.io/success-codes: 200-300
  • use gRPC single value
    alb.ingress.kubernetes.io/success-codes: '0'
  • use gRPC multiple value
    alb.ingress.kubernetes.io/success-codes: 0,1
  • use gRPC range of value
    alb.ingress.kubernetes.io/success-codes: 0-5
• alb.ingress.kubernetes.io/healthy-threshold-count specifies the consecutive health checks successes required before considering an unhealthy target healthy.
  Example
  alb.ingress.kubernetes.io/healthy-threshold-count: '2'
• alb.ingress.kubernetes.io/unhealthy-threshold-count specifies the consecutive health check failures required before considering a target unhealthy.
  Example
  alb.ingress.kubernetes.io/unhealthy-threshold-count: '2'

TLS¶

TLS support can be controlled with the following annotations:

• alb.ingress.kubernetes.io/certificate-arn specifies the ARN of one or more certificate managed by AWS Certificate Manager
  The first certificate in the list will be added as the default certificate. The remaining certificates will be added to the optional SNI certificate list. If the same certificate as the default certificate is also listed again (either explicitly in the list or via annotations from other IngressGroup members), it will still be added to the SNI list as well. See SSL Certificates for more details.
  Certificate Discovery
  TLS certificates for ALB Listeners can be automatically discovered with hostnames from Ingress resources. See Certificate Discovery for instructions.
  Example
  • single certificate
    alb.ingress.kubernetes.io/certificate-arn: arn:aws:acm:us-west-2:xxxxx:certificate/xxxxxxx
  • multiple certificates
    alb.ingress.kubernetes.io/certificate-arn: arn:aws:acm:us-west-2:xxxxx:certificate/cert1,arn:aws:acm:us-west-2:xxxxx:certificate/cert2,arn:aws:acm:us-west-2:xxxxx:certificate/cert3
• alb.ingress.kubernetes.io/ssl-policy specifies the Security Policy that should be assigned to the ALB, allowing you to control the protocol and ciphers.
  Example
  alb.ingress.kubernetes.io/ssl-policy: ELBSecurityPolicy-TLS-1-1-2017-01
• alb.ingress.kubernetes.io/mutual-authentication specifies the mutual authentication configuration that should be assigned to the Application Load Balancer secure listener ports. See Mutual authentication with TLS in the AWS documentation for more details.
  Note
  • This annotation is not applicable for Outposts, Local Zones or Wavelength zones.
  • "Configuration Options"
    * port: listen port
    * Must be a HTTPS port specified by listen-ports.
    * mode: "off" (default) | "passthrough" | "verify"
    * verify mode requires an existing trust store resource.
    * See Create a trust store in the AWS documentation for more details.
    * trustStore: ARN (arn:aws:elasticloadbalancing:trustStoreArn) | Name (my-trust-store)
    * Both ARN and Name of trustStore are supported values.
    * trustStore is required when mode is verify.
    * ignoreClientCertificateExpiry : true | false (default)
    * advertiseTrustStoreCaNames : "on" | "off" (default)
  • Once the Mutual Authentication is set, to turn it off, you will have to explicitly pass in this annotation with mode : "off".
    Example
  • listen-ports specifies four HTTPS ports: 80, 443, 8080, 8443
  • listener HTTPS:80 will be set to passthrough mode
  • listener HTTPS:443 will be set to verify mode, associated with trust store arn arn:aws:elasticloadbalancing:trustStoreArn and have ignoreClientCertificateExpiry set to true
  • listeners HTTPS:8080 and HTTPS:8443 remain in the default mode off.
    `alb.ingress.kubernetes.io/listen-ports: '[{"HTTPS": 80}, {"HTTPS": 443}, {"HTTPS": 8080}, {"HTTPS": 8443}]'
    alb.ingress.kubernetes.io/mutual-authentication: '[{"port": 80, "mode": "passthrough"},
    {"port": 443, "mode": "verify", "trustStore": "arn:aws:elasticloadbalancing:trustStoreArn", "ignoreClientCertificateExpiry" : true}]'

  `
  Note
  To avoid conflict errors in IngressGroup, this annotation should only be specified on a single Ingress within IngressGroup or specified with same value across all Ingresses within IngressGroup.
  Trust stores limit per Application Load Balancer
  A maximum of two different trust stores can be associated among listeners on the same ingress. See Quotas for your Application Load Balancers in the AWS documentation for more details.

Custom attributes¶

Custom attributes to LoadBalancers and TargetGroups can be controlled with following annotations:

• alb.ingress.kubernetes.io/load-balancer-attributes specifies Load Balancer Attributes that should be applied to the ALB.
  Only attributes defined in the annotation will be updated. To unset any AWS defaults(e.g. Disabling access logs after having them enabled once), the values need to be explicitly set to the original values(access_logs.s3.enabled=false) and omitting them is not sufficient.
  • If deletion_protection.enabled=true is in annotation, the controller will not be able to delete the ALB during reconciliation. Once the attribute gets edited to deletion_protection.enabled=false during reconciliation, the deployer will force delete the resource.
  • Please note, if the deletion protection is not enabled via annotation (e.g. via AWS console), the controller still deletes the underlying resource.
    Example
  • enable access log to s3
    alb.ingress.kubernetes.io/load-balancer-attributes: access_logs.s3.enabled=true,access_logs.s3.bucket=my-access-log-bucket,access_logs.s3.prefix=my-app
  • enable deletion protection
    alb.ingress.kubernetes.io/load-balancer-attributes: deletion_protection.enabled=true
  • enable invalid header fields removal
    alb.ingress.kubernetes.io/load-balancer-attributes: routing.http.drop_invalid_header_fields.enabled=true
  • enable http2 support
    alb.ingress.kubernetes.io/load-balancer-attributes: routing.http2.enabled=true
  • set idle_timeout delay to 600 seconds
    alb.ingress.kubernetes.io/load-balancer-attributes: idle_timeout.timeout_seconds=600
  • set client_keep_alive to 3600 seconds
    alb.ingress.kubernetes.io/load-balancer-attributes: client_keep_alive.seconds=3600
  • enable connection logs
    alb.ingress.kubernetes.io/load-balancer-attributes: connection_logs.s3.enabled=true,connection_logs.s3.bucket=my-connection-log-bucket,connection_logs.s3.prefix=my-app
  • alb.ingress.kubernetes.io/target-group-attributes specifies Target Group Attributes which should be applied to Target Groups.
    Example
  • set the slow start duration to 30 seconds (available range is 30-900 seconds)
    alb.ingress.kubernetes.io/target-group-attributes: slow_start.duration_seconds=30
  • set the deregistration delay to 30 seconds (available range is 0-3600 seconds)
    alb.ingress.kubernetes.io/target-group-attributes: deregistration_delay.timeout_seconds=30
  • enable sticky sessions (requires alb.ingress.kubernetes.io/target-type be set to ip)
    alb.ingress.kubernetes.io/target-group-attributes: stickiness.enabled=true,stickiness.lb_cookie.duration_seconds=60 alb.ingress.kubernetes.io/target-type: ip
  • set load balancing algorithm to least outstanding requests
    alb.ingress.kubernetes.io/target-group-attributes: load_balancing.algorithm.type=least_outstanding_requests
  • enable Automated Target Weights(ATW) on HTTP/HTTPS target groups to increase application availability. Set your load balancing algorithm to weighted random and turn on anomaly mitigation (recommended)
    alb.ingress.kubernetes.io/target-group-attributes: load_balancing.algorithm.type=weighted_random,load_balancing.algorithm.anomaly_mitigation=on
• alb.ingress.kubernetes.io/multi-cluster-target-group Allows you to share the created Target Group ARN with other Load Balancer Controller managed clusters.
  This feature does not offer any Deletion Protection. Deleting the resource will still delete the Target Group. If you need to support Target Groups shared with multiple clusters, it's recommended to use an out-of-band Target Group that is not managed by a Load Balancer Controller.
  • It is not recommended to change this value frequently, if ever. The recommended way to set this value is on creation of the service or ingress.
    Example
    alb.ingress.kubernetes.io/multi-cluster-target-group: "true"
• alb.ingress.kubernetes.io/listener-attributes.${Protocol}-${Port} specifies Listener Attributes which should be applied to listener.
  Example
  • Server header enablement attribute
    alb.ingress.kubernetes.io/listener-attributes.HTTP-80: routing.http.response.server.enabled=true

The AWS Load Balancer Controller automatically applies following tags to the AWS resources (ALB/TargetGroups/SecurityGroups/Listener/ListenerRule) it creates:

• elbv2.k8s.aws/cluster: ${clusterName}
• ingress.k8s.aws/stack: ${stackID}
• ingress.k8s.aws/resource: ${resourceID}

In addition, you can use annotations to specify additional tags

• alb.ingress.kubernetes.io/tags specifies additional tags that will be applied to AWS resources created. In case of target group, the controller will merge the tags from the ingress and the backend service giving precedence to the values specified on the service when there is conflict.
  Example
  alb.ingress.kubernetes.io/tags: Environment=dev,Team=test

Capacity Unit Reservation¶

Load balancer capacity unit reservation can be configured via following annotations:

• alb.ingress.kubernetes.io/minimum-load-balancer-capacity specifies theCapacity Unit Reservation to be configured.
  Example
  • set the capacity unit reservation to 1000
    alb.ingress.kubernetes.io/minimum-load-balancer-capacity: CapacityUnits=1000
  • reset the capacity unit reservation
    alb.ingress.kubernetes.io/minimum-load-balancer-capacity: CapacityUnits=0
    Notes
  • If you specify this annotation, but remove it later, the capacity unit reservation is not reset. You need to reset the capacity by setting the capacity units to zero as show in the example above.
  • If users do not want the controller to manage the capacity unit reservation on load balancer, they can disable the feature by setting controller command line feature gate flag --feature-gates=LBCapacityReservation=true

Addons¶

• alb.ingress.kubernetes.io/waf-acl-id specifies the identifier for the Amazon WAF Classic web ACL.
  Only Regional WAF Classic is supported.
  When this annotation is absent or empty, the controller will keep LoadBalancer WAF Classic settings unchanged. To disable WAF Classic, explicitly set the annotation value to 'none'.
  Example
  • enable WAF Classicalb.ingress.kubernetes.io/waf-acl-id: 499e8b99-6671-4614-a86d-adb1810b7fbe
  • disable WAF Classicalb.ingress.kubernetes.io/waf-acl-id: none
• alb.ingress.kubernetes.io/wafv2-acl-arn specifies ARN for the Amazon WAFv2 web ACL.
  Only Regional WAFv2 is supported.
  When this annotation is absent or empty, the controller will keep LoadBalancer WAFv2 settings unchanged. To disable WAFv2, explicitly set the annotation value to 'none'.
  To get the WAFv2 Web ACL ARN from the Console, click the gear icon in the upper right and enable the ARN column.
  Example
  • enable WAFv2alb.ingress.kubernetes.io/wafv2-acl-arn: arn:aws:wafv2:us-west-2:xxxxx:regional/webacl/xxxxxxx/3ab78708-85b0-49d3-b4e1-7a9615a6613b
  • disable WAFV2alb.ingress.kubernetes.io/wafv2-acl-arn: none
• alb.ingress.kubernetes.io/shield-advanced-protection turns on / off the AWS Shield Advanced protection for the load balancer.
  When this annotation is absent, the controller will keep LoadBalancer shield protection settings unchanged. To disable shield protection, explicitly set the annotation value to 'false'.
  Example
  • enable shield protectionalb.ingress.kubernetes.io/shield-advanced-protection: 'true'
  • disable shield protectionalb.ingress.kubernetes.io/shield-advanced-protection: 'false'

Enable frontend NLB¶

When this option is set to true, the controller will automatically provision a Network Load Balancer and register the Application Load Balancer as its target. Additional annotations are available to customize the NLB configurations, including options for scheme, security groups, subnets, and health check. The ingress resource will have two status entries, one for the NLB DNS and one for the ALB DNS. This allows users to combine the benefits of NLB and ALB into a single solution, leveraging NLB features like static IP address and PrivateLink, while retaining the rich routing capabilities of ALB.

Warning

• If you need to change the ALB scheme, make sure to disable this feature first. Changing the scheme will create a new ALB, which could interfere with the current configuration.

• If you create ingress and enable the feature at once, provisioning the NLB and registering the ALB as target can take up to 3-4 mins to complete.

• alb.ingress.kubernetes.io/enable-frontend-nlb enables frontend Network Load Balancer functionality.
  Example

  • Enable frontend nlb
    alb.ingress.kubernetes.io/enable-frontend-nlb: "true"

• alb.ingress.kubernetes.io/frontend-nlb-scheme specifies the scheme for the Network Load Balancer.
  Example

  • Set NLB scheme to internet-facing
    alb.ingress.kubernetes.io/frontend-nlb-scheme: internet-facing

• alb.ingress.kubernetes.io/frontend-nlb-subnets specifies the subnets for the Network Load Balancer.
  Example

  • Specify subnets for NLB
    alb.ingress.kubernetes.io/frontend-nlb-subnets: subnet-xxxx1,subnet-xxxx2

• alb.ingress.kubernetes.io/frontend-nlb-security-groups specifies the security groups for the Network Load Balancer.
  Example

  • Specify security groups for NLB
    alb.ingress.kubernetes.io/frontend-nlb-security-groups: sg-xxxx1,sg-xxxx2

• alb.ingress.kubernetes.io/frontend-nlb-listener-port-mapping specifies the port mapping configuration for the Network Load Balancer listeners.
  Default

  • The port defaults to match the ALB listener port, based on whether alb.ingress.kubernetes.io/listen-ports(#listen-ports) is specified.
    Example
  • Forward TCP traffic from NLB:80 to ALB:443
    alb.ingress.kubernetes.io/frontend-nlb-listener-port-mapping: 80=443

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-port specifies the port used for health checks.
  Example

  • Set health check port
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-port: traffic-port

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-protocol specifies the protocol used for health checks.
  Example

  • Set health check protocol
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-protocol: HTTP

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-path specifies the destination path for health checks.
  Example

  • Set health check path
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-path: /health

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-interval-seconds specifies the interval between consecutive health checks.
  Example

  • Set health check interval
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-interval-seconds: '15'

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-timeout-seconds specifies the target group health check timeout.
  Example

  • Set health check timeout
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-timeout-seconds: '5'

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-healthy-threshold-count specifies the consecutive health check successes required before a target is considered healthy.
  Example

  • Set healthy threshold count
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-healthy-threshold-count: '3'

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-unhealthy-threshold-count specifies the consecutive health check failures before a target gets marked unhealthy.
  Example

  • Set unhealthy threshold count
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-unhealthy-threshold-count: '3'

• alb.ingress.kubernetes.io/frontend-nlb-healthcheck-success-codes specifies the HTTP codes that indicate a successful health check.
  Example

  • Set success codes for health check
    alb.ingress.kubernetes.io/frontend-nlb-healthcheck-success-codes: '200'