Set ALB Ingress Controller

Available in VPC

You can route traffic by connecting Kubernetes Ingress with Load Balancer through ALB Ingress Controller.

When Ingress is created in the Kubernetes system, ALB Ingress Controller uses the values set at Ingress to create a Load Balancer instance. When an instance is created, the Ingress Rule uses the set service's node port as the port value to create a target group and register it to the instance.

Install ALB Ingress Controller

The following describes how to install the ALB Ingress Controller in the cluster and prepare it:

1. Install the ALB Ingress Controller by executing the command corresponding to the following region:

   Note

   If the cluster’s hypervisor is KVM, you can use ALB Ingress Controller without installation since it is included by default.

   • alb-ingress-controller is created in the kube-system namespace, and necessary ServiceAccount, ClusterRole, ClusterRoleBinding, and IngressClass are created together.

   • Korea

     kubectl --kubeconfig=$KUBE_CONFIG apply -f https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/main/docs/install/pub/install.yaml
     

     • If the version is older than Kubernetes 1.19, install https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/v0.3.1/docs/install/pub/install.yaml.

   • Singapore

     kubectl --kubeconfig=$KUBE_CONFIG apply -f https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/main/docs/install/pub-sg/install.yaml
     

     • If the version is older than Kubernetes 1.19, install https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/v0.3.1/docs/install/pub-sg/install.yaml.

   • Japan

     kubectl --kubeconfig=$KUBE_CONFIG apply -f https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/main/docs/install/pub-jp/install.yaml
     

     • If the version is older than Kubernetes 1.19, install https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/v0.3.1/docs/install/pub-jp/install.yaml.

2. Add the spec.ingressClassName: alb field to the resources of Ingress.

   • If the version is older than Kubernetes 1.19, add the kubernetes.io/ingress.class: alb annotation.

ALB Ingress Controller setting and annotation

Default ALB Ingress Controller setting

The following describes the default setting of the ALB Ingress Controller:

• Service type: NodePort
  All servers to be exposed through Ingress should be created as NodePort type.
• Default Rule
  The Default Rule is applied when there is no matching rule, and it can be set in spec.defaultBackend.
  You cannot configure rules and use-annotations separately, and a default target group set to Port 80 will be created if not set.
• Rule Priority
  Priority is determined according to the order of rules defined in Ingress. The topmost rule's priority will be set to 1.

ALB Ingress Controller annotation

You can use annotations in Kubernetes Ingresses and service objects to change settings.

Use the required annotations while referring to the following table: All annotations of the ALB Ingress Controller start with alb.ingress.kubernetes.io/.

• alb.ingress.kubernetes.io/actions.${actionName}: additional functions of the Listener Rule can be set by writing a string in the JSON format according to the actions model. Set the service.name of the rule set to the Ingress you want to use as ${actionName} and set service.port.name as use-annotation to have the annotation applied.

• alb.ingress.kubernetes.io/conditions.${conditionName}: in addition to the Host and Path conditions defined in Ingress, other conditions can be additionally set by writing a string in the JSON format according to the conditions model. These conditions will be applied to the service with the serviceName that matches the ${conditionName} in Ingress Rule.

Example codes

For more detailed example of ALB Ingress Controller, see ALB Ingress Controller use cases.