ALB Ingress Controller 設定

VPC環境で利用できます。

ALB Ingress Controllerを用いて Kubernetes Ingressを Load Balancerと連携し、トラフィックをルーティングできます。

Kubernetesシステムで Ingressが作成されると ALB Ingress Controllerは Ingressに設定された値を活用して Load Balancerインスタンスを作成します。インスタンスが作成されると、Ingress Ruleで設定した Serviceのノードポートをポート値として使用し、ターゲットグループを作成してインスタンスに登録します。

ALB Ingress Controllerのインストール

クラスタに ALB Ingress Controllerをインストールして準備する方法は、次の通りです。

1. 以下のリージョンに該当するコマンドを実行し、ALB Ingress Controllerをインストールします。

   参考

   ハイパーバイザが KVMであるクラスタは ALB Ingress Controllerを基本的に含めているため、別途インストールせずにすぐ使用できます。

   • kube-systemの名前空間に alb-ingress-controllerが作成され、必要な ServiceAccount、ClusterRole、ClusterRoleBinding、IngressClassが一緒に作成されます。

   • 韓国

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

     • Kubernetes 1.19バージョン未満の場合、 https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/v0.3.1/docs/install/pub/install.yamlをインストールします。

   • シンガポール

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

     • Kubernetes 1.19バージョン未満の場合、 https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/v0.3.1/docs/install/pub-sg/install.yamlをインストールします。

   • 日本

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

     • Kubernetes 1.19バージョン未満の場合、 https://raw.githubusercontent.com/NaverCloudPlatform/nks-alb-ingress-controller/v0.3.1/docs/install/pub-jp/install.yamlをインストールします。

2. ALB Ingress Controllerが正常に Runningステータスであることを確認します。

kubectl --kubeconfig=$KUBE_CONFIG get pods -n kube-system -l app.kubernetes.io/name=alb-ingress-controller

3. Ingressのリソースに spec.ingressClassName: albフィールドを追加します。
   • Kubernetes 1.19 バージョン未満の場合、kubernetes.io/ingress.class: albのアノテーションを追加します。

ALB Ingress Controllerの設定とアノテーション

ALB Ingress Controllerの基本設定

ALB Ingress Controllerのデフォルト設定は、次の通りです。

• Service type: NodePort
  • Ingressを通じて公開する Serviceはすべて NodePort typeで作成する必要があります。
• Default Rule
  • マッチングされる Ruleがない場合に適用される Ruleで、spec.defaultBackendに設定できます。
  • 別途の ruleと use-annotationは設定できず、設定しなかった場合は80ポートに設定されたデフォルトのターゲットグループが作成されます。
• Rule Priority
  • Ingressで定義した Ruleの順序に沿って優先順位が決まります。トップにある Ruleの優先順位が1に設定されます。

ALB Ingress Controllerのアノテーション

Kubernetes Ingressと Serviceオブジェクトに、アノテーションを使用して設定を変更できます。

以下の表を参照して必要なアノテーションを使用します。ALB Ingress Controllerのアノテーションはすべて alb.ingress.kubernetes.io/で始まります。

• alb.ingress.kubernetes.io/actions.${actionName}: actions モデルに合わせて JSON形式の stringで作成し、Listener Ruleの追加機能を設定できます。Ingressに設定された Ruleの service.nameを使用する ${actionName}に設定し、service.port.nameを use-annotationに設定するとアノテーションが適用されます。

• alb.ingress.kubernetes.io/conditions.${conditionName}: conditions モデルに適した JSON形式の stringで作成し、Ingressで定義された Host、Path条件以外に他の条件を追加で設定できます。当該条件は、Ingress Ruleで ${conditionName}と一致する serviceNameを持つ Serviceに適用されます。

マルチゾーン Subnet IDを指定

マルチゾーンクラスタで ALBを作成する場合、各ゾーンのロードバランサ専用 Subnet IDを alb.ingress.kubernetes.io/subnet-id アノテーションに入力できます。マルチゾーンクラスタで Subnet IDを指定する場合、以下の内容をご参照ください。

• 2つ以上を入力する場合、コンマ(,)で区切ります。
• 各ゾーンごとにロードバランサ専用サブネットは、1つのみ指定できます。
• 同じゾーンに属する Subnet IDを2つ以上入力すると、ALB作成に失敗します。
• subnet-id 値は ALBを作成する場合のみ適用されます。作成された ALBのサブネットを変更するには、ALBを再度作成します。
• マルチゾーンサブネットを指定する場合、パブリック IPアドレスを指定して割り当てられません。

metadata:
  annotations:
    alb.ingress.kubernetes.io/subnet-id: "123456,234567"

ロードバランサ管理を一時停止

lb.ncloud.naver.com/pause: "true"は Kubernetes 1.36以上の KVMクラスタで使用できる一時停止オプションです。この値が設定されると、コントローラの spec/provider reconcileが一時停止されます。

サンプルコード

ALB Ingress Controllerの詳細なユースケースは、ALB Ingress Controller のユースケースをご参照ください。