Container Compute Service:ALB Ingress の高度な設定

ドメイン名に基づくリクエストの転送

次の手順を実行して、ドメイン名を持つ Ingress とドメイン名のない Ingress を作成し、それらの Ingress を使用してリクエストを転送します。

URL パスに基づくリクエストの転送

3 つの一致方法の例を次に示します。

ヘルスチェックの設定

次のアノテーションを使用して、ALB Ingress のヘルスチェックを設定できます。 次の YAML テンプレートは、ヘルスチェックが有効になっている Ingress を作成する方法の例を示しています。

次の YAML テンプレートは、ヘルスチェックが有効になっている Ingress を作成する方法の例を示しています。

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: cafe-ingress
  annotations:
    alb.ingress.kubernetes.io/healthcheck-enabled: "true"
    alb.ingress.kubernetes.io/healthcheck-path: "/"
    alb.ingress.kubernetes.io/healthcheck-protocol: "HTTP"
    alb.ingress.kubernetes.io/healthcheck-method: "HEAD"
    alb.ingress.kubernetes.io/healthcheck-httpcode: "http_2xx"
    alb.ingress.kubernetes.io/healthcheck-timeout-seconds: "5"
    alb.ingress.kubernetes.io/healthcheck-interval-seconds: "2"
    alb.ingress.kubernetes.io/healthy-threshold-count: "3"
    alb.ingress.kubernetes.io/unhealthy-threshold-count: "3"
spec:
  ingressClassName: alb
  rules:
  - http:
      paths:
      # コンテキストパスを設定します。
      - path: /tea
        backend:
          service:
            name: tea-svc
            port:
              number: 80
      # コンテキストパスを設定します。
      - path: /coffee
        backend:
          service:
            name: coffee-svc
            port:
              number: 80

HTTP リクエストから HTTPS リクエストへのリダイレクトの設定

ALB Ingress で alb.ingress.kubernetes.io/ssl-redirect: "true" アノテーションを設定して、HTTP リクエストを HTTPS ポート 443 にリダイレクトできます。

例:

apiVersion: v1
kind: Service
metadata:
  name: demo-service-ssl
  namespace: default
spec:
  ports:
    - name: port1
      port: 80
      protocol: TCP
      targetPort: 8080
  selector:
    app: demo-ssl
  sessionAffinity: None
  type: ClusterIP
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: demo-ssl
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: demo-ssl
  template:
    metadata:
      labels:
        app: demo-ssl
    spec:
      containers:
        - image: registry.cn-hangzhou.aliyuncs.com/alb-sample/cafe:v1
          imagePullPolicy: IfNotPresent
          name: demo-ssl
          ports:
            - containerPort: 8080
              protocol: TCP
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    alb.ingress.kubernetes.io/ssl-redirect: "true"
  name: demo-ssl
  namespace: default
spec:
  ingressClassName: alb
  tls:
  - hosts:
    - ssl.alb.ingress.top
  rules:
    - host: ssl.alb.ingress.top
      http:
        paths:
          - backend:
              service:
                name: demo-service-ssl
                port: 
                  number: 80
            path: /
            pathType: Prefix

バックエンドプロトコルとして HTTPS または gRPC を設定する

ALB は、バックエンドプロトコルとして HTTPS と gRPC をサポートしています。 ALB Ingress のバックエンドプロトコルを設定するには、alb.ingress.kubernetes.io/backend-protocol: "grpc" または alb.ingress.kubernetes.io/backend-protocol: "https" アノテーションを設定するだけです。 Ingress を使用して gRPC サービスを転送するには、対応するドメイン名に SSL 証明書があり、TLS プロトコルを使用している必要があります。 次の例は、gRPC プロトコルのサンプル構成を示しています。

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    alb.ingress.kubernetes.io/backend-protocol: "grpc"
  name: lxd-grpc-ingress
spec:
  ingressClassName: alb
  tls:
  - hosts:
    - demo.alb.ingress.top
  rules:
  - host: demo.alb.ingress.top
    http:
      paths:  
      - path: /
        pathType: Prefix
        backend:
          service:
            name: grpc-demo-svc
            port:
              number: 9080

正規表現の設定

カスタム転送条件を設定するには、path フィールドに正規表現を記述します。 次の例は、サンプル構成を示しています。

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
   alb.ingress.kubernetes.io/use-regex: "true" # path フィールドで正規表現をサポートします。
   alb.ingress.kubernetes.io/conditions.service-a: | # アノテーションで指定された Service はクラスター内に存在する Service である必要があり、Service 名は rule フィールドの backend の Service 名と同じである必要があります。
     [{
       "type": "Path",
       "pathConfig": {
           "values": [
              "~*^/pathvalue1", # 正規表現は正規表現フラグ ~ * に従う必要があります。
              "/pathvalue2" # 完全一致の場合、パスの前に ~ * を追加する必要はありません。
           ]
       }
      }]
  name: ingress-example
spec:
  ingressClassName: alb
  rules:
   - http:
      paths:
      - path: /test
        pathType: Prefix
        backend:
          service:
            name: service-a
            port:
              number: 88

書き換えルールの設定

ALB は書き換え機能をサポートしています。 ALB Ingress でこの機能を設定するには、alb.ingress.kubernetes.io/rewrite-target: /path/${2} アノテーションを追加します。 次のルールが適用されます。

• rewrite-target アノテーションでは、${number} 形式の変数を、pathType が Prefix に設定されている path で設定する必要があります。

• デフォルトでは、* や ? などの正規表現記号を path フィールドで使用することはできません。 正規表現記号を使用するには、rewrite-target アノテーションを設定する必要があります。

• path は / で始まる必要があります。

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    alb.ingress.kubernetes.io/use-regex: "true" # path フィールドで正規表現をサポートします。
    alb.ingress.kubernetes.io/rewrite-target: /path/${2} # 正規表現に一致する変数が連結されて、元のパスを上書きするパスが形成されます。
  name: rewrite-ingress
spec:
  ingressClassName: alb
  rules:
  - host: demo.alb.ingress.top
    http:
      paths:
      - path: /something(/|$)(.*)
        pathType: Prefix
        backend:
          service:
            name: rewrite-svc
            port:
              number: 9080

カスタムリスニングポートの設定

ALB Ingress では、カスタムリスニングポートを設定できます。 これにより、ポート 80 と 443 を同時に介してサービスを公開できます。

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: cafe-ingress
  annotations:
   alb.ingress.kubernetes.io/listen-ports: '[{"HTTP": 80},{"HTTPS": 443}]'
spec:
  ingressClassName: alb
  tls:
  - hosts:
    - demo.alb.ingress.top
  rules:
  - host: demo.alb.ingress.top
    http:
      paths:
      - path: /tea
        pathType: ImplementationSpecific
        backend:
          service:
            name: tea-svc
            port:
              number: 80

転送ルールの優先度の設定

Ingress の namespace/name を変更したくない場合は、次の Ingress アノテーションを設定して、転送ルールの優先度を定義できます。

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: cafe-ingress
  annotations:
   alb.ingress.kubernetes.io/order: "2"
spec:
  ingressClassName: alb
  rules:
  - host: demo.alb.ingress.top
    http:
      paths:
      - path: /tea
        pathType: ImplementationSpecific
        backend:
          service:
            name: tea-svc
            port:
              number: 80

アノテーションを使用した段階的リリースの実行

ALB は複雑なルーティング機能を提供し、ヘッダー、Cookie、および重みに基づくカナリアリリースをサポートします。 アノテーションを設定することで、カナリアリリースを実装できます。 カナリアリリースを有効にするには、alb.ingress.kubernetes.io/canary: "true" アノテーションを設定する必要があります。 さまざまなアノテーションを使用して、さまざまなカナリアリリース機能を実装できます。

• alb.ingress.kubernetes.io/canary-by-header および alb.ingress.kubernetes.io/canary-by-header-value: このルールはリクエストヘッダーの値を指定し、alb.ingress.kubernetes.io/canary-by-header と一緒に使用する必要があります。

  • リクエストの header と header-value が設定値と一致する場合、リクエストは段階的リリースサービスエンドポイントに割り当てられます。

  • 他の header 値の場合、header は無視され、リクエストトラフィックは段階的リリースの優先度に基づいて、他のルールによって設定された段階的リリースサービスに割り当てられます。

  リクエストヘッダーが location: hz の場合、リクエストはカナリアリリースサービスにルーティングされます。 他のヘッダーを持つリクエストは、カナリアリリースの重みに基づいてルーティングされます。 次の例は、サンプル構成を示しています。

  apiVersion: networking.k8s.io/v1
  kind: Ingress
  metadata:
    annotations:
      alb.ingress.kubernetes.io/order: "1"
      alb.ingress.kubernetes.io/canary: "true"
      alb.ingress.kubernetes.io/canary-by-header: "location"
      alb.ingress.kubernetes.io/canary-by-header-value: "hz"
    name: demo-canary
    namespace: default
  spec:
    ingressClassName: alb
    rules:
      - http:
          paths:
            - backend:
                service:
                  name: demo-service-hello
                  port: 
                    number: 80
              path: /hello
              pathType: ImplementationSpecific

• alb.ingress.kubernetes.io/canary-by-cookie: Cookie に基づいてトラフィックを分割します。

  • cookie の値が always に設定されている場合、リクエストトラフィックは段階的リリースサービスエンドポイントに割り当てられます。

  • cookie の値が never に設定されている場合、リクエストトラフィックは段階的リリースサービスエンドポイントに割り当てられません。

  説明

  Cookie ベースのカナリアリリースは、always と never の値のみをサポートします。 カスタム値はサポートされていません。

  リクエスト Cookie が demo=always の場合、リクエストはカナリアリリースサービスにルーティングされます。 次の例は、サンプル構成を示しています。

  apiVersion: networking.k8s.io/v1
  kind: Ingress
  metadata:
    annotations:
      alb.ingress.kubernetes.io/order: "2"
      alb.ingress.kubernetes.io/canary: "true"
      alb.ingress.kubernetes.io/canary-by-cookie: "demo"
    name: demo-canary-cookie
    namespace: default
  spec:
    ingressClassName: alb
    rules:
      - http:
          paths:
            - backend:
                service:
                  name: demo-service-hello
                  port: 
                    number: 80
              path: /hello
              pathType: ImplementationSpecific

• alb.ingress.kubernetes.io/canary-weight: カナリアサービスにルーティングされるリクエストの割合を指定します。 値は 0～100 の整数である必要があります。

  次の例では、新しいアプリケーションバージョンにルーティングされるリクエストの割合が 50% に設定されています。

  apiVersion: networking.k8s.io/v1
  kind: Ingress
  metadata:
    annotations:
      alb.ingress.kubernetes.io/order: "3"
      alb.ingress.kubernetes.io/canary: "true"
      alb.ingress.kubernetes.io/canary-weight: "50"
    name: demo-canary-weight
    namespace: default
  spec:
    ingressClassName: alb
    rules:
      - http:
          paths:
            - backend:
                service:
                  name: demo-service-hello
                  port: 
                    number: 80
              path: /hello
              pathType: ImplementationSpecific

アノテーションを使用したセッション維持の設定

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: cafe-ingress-v3
  annotations:
    alb.ingress.kubernetes.io/sticky-session: "true"
    alb.ingress.kubernetes.io/sticky-session-type: "Insert"
    alb.ingress.kubernetes.io/cookie-timeout: "1800"
spec:
  ingressClassName: alb
  rules:
  - http:
      paths:
      # コンテキストパスを設定します。
      - path: /tea2
        backend:
          service:
            name: tea-svc
            port: 
             number: 80
      # コンテキストパスを設定します。
       - path: /coffee2
         backend:
           service:
              name: coffee-svc
              port: 
               number: 80

バックエンドサーバーグループの負荷分散アルゴリズムの指定

ALB Ingress では、Ingress アノテーション alb.ingress.kubernetes.io/backend-scheduler を設定することで、サーバーグループの負荷分散アルゴリズムを指定できます。 次の例は、サンプル構成を示しています。 デフォルトでは、クラスターのバージョンは 1.19 以降である必要があります。

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: cafe-ingress
  annotations:
    alb.ingress.kubernetes.io/backend-scheduler: "uch" # 必要に応じて uch を wrr、sch、または wlc に置き換えます。
    alb.ingress.kubernetes.io/backend-scheduler-uch-value: "test" # このパラメーターは、負荷分散アルゴリズムが uch の場合にのみ必要です。 スケジューリングアルゴリズムが wrr、sch、または wlc の場合は、このパラメーターを設定する必要はありません。
  name: cafe-ingress
spec:
  ingressClassName: alb
  rules:
  - host: demo.alb.ingress.top
    http:
      paths:
      - path: /tea
        pathType: ImplementationSpecific
        backend:
          service:
            name: tea-svc
            port:
              number: 80

CORS の設定

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: alb-ingress
  annotations:
    alb.ingress.kubernetes.io/enable-cors: "true"
    alb.ingress.kubernetes.io/cors-expose-headers: ""
    alb.ingress.kubernetes.io/cors-allow-methods: "GET,POST"
    alb.ingress.kubernetes.io/cors-allow-credentials: "true"
    alb.ingress.kubernetes.io/cors-max-age: "600"

spec:
  ingressClassName: alb
  rules:
  - host: demo.alb.ingress.top
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: cloud-nodeport
            port:
              number: 80

バックエンドの持続的接続

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: alb-ingress
  annotations:
    alb.ingress.kubernetes.io/backend-keepalive: "true"
spec:
  ingressClassName: alb
  rules:
  - host: demo.alb.ingress.top
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: cloud-nodeport
            port:
              number: 80

QPS スロットリングの設定

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: cafe-ingress
  annotations:
    alb.ingress.kubernetes.io/traffic-limit-qps: "50"
spec:
  ingressClassName: alb
  rules:
   - host: demo.alb.ingress.top
     http:
      paths:
      - path: /tea
        pathType: ImplementationSpecific
        backend:
          service:
            name: tea-svc
            port:
              number: 80
      - path: /coffee
        pathType: ImplementationSpecific
        backend:
          service:
            name: coffee-svc
            port:
              number: 80