Ingress と負荷分散

手順

1. 次のコマンドを実行して、hello-openshift というプロジェクトを作成します。

   $ oc new-project hello-openshift

   Copy to Clipboard Toggle word wrap

2. 以下のコマンドを実行してプロジェクトに Pod を作成します。

   $ oc create -f https://raw.githubusercontent.com/openshift/origin/master/examples/hello-openshift/hello-pod.json

   Copy to Clipboard Toggle word wrap

3. 以下のコマンドを実行して、hello-openshift というサービスを作成します。

   $ oc expose pod/hello-openshift

   Copy to Clipboard Toggle word wrap

4. 次のコマンドを実行して、hello-openshift アプリケーションに対して、セキュアではないルートを作成します。

   $ oc expose svc hello-openshift

   Copy to Clipboard Toggle word wrap

手順

1. 次のコマンドを実行して、hello-openshift というプロジェクトを作成します。

   $ oc new-project hello-openshift

   Copy to Clipboard Toggle word wrap

2. 以下のコマンドを実行してプロジェクトに Pod を作成します。

   $ oc create -f https://raw.githubusercontent.com/openshift/origin/master/examples/hello-openshift/hello-pod.json

   Copy to Clipboard Toggle word wrap

3. 以下のコマンドを実行して、hello-openshift というサービスを作成します。

   $ oc expose pod/hello-openshift

   Copy to Clipboard Toggle word wrap

4. hello-openshift-route.yaml というルート定義を作成します。

   シャーディング用に作成したルートの YAML 定義

   apiVersion: route.openshift.io/v1
   kind: Route
   metadata:
     labels:
       type: sharded 

   1

   
     name: hello-openshift-edge
     namespace: hello-openshift
   spec:
     subdomain: hello-openshift 

   2

   
     tls:
       termination: edge
     to:
       kind: Service
       name: hello-openshift

   Copy to Clipboard Toggle word wrap

   1

   ラベルキーとそれに対応するラベル値の両方が、Ingress Controller で指定されたものと一致する必要があります。この例では、Ingress Controller にはラベルキーと値 type: sharded があります。

   2

   ルートは、subdomain フィールドの値を使用して公開されます。subdomain フィールドを指定するときは、ホスト名を未設定のままにしておく必要があります。host フィールドと subdomain フィールドの両方を指定すると、ルートは host フィールドの値を使用し、subdomain フィールドを無視します。

5. 次のコマンドを実行し、hello-openshift-route.yaml を使用して hello-openshift アプリケーションへのルートを作成します。

   $ oc -n hello-openshift create -f hello-openshift-route.yaml

   Copy to Clipboard Toggle word wrap

手順

1. oc annotate コマンドを使用して、ルートにタイムアウトを追加します。

   $ oc annotate route <route_name> \
       --overwrite haproxy.router.openshift.io/timeout=<timeout><time_unit> 

   1

   Copy to Clipboard Toggle word wrap

   1

   サポートされる時間単位は、マイクロ秒 (us)、ミリ秒 (ms)、秒 (s)、分 (m)、時間 (h)、または日 (d) です。

   以下の例では、2 秒のタイムアウトを myroute という名前のルートに設定します。

   $ oc annotate route myroute --overwrite haproxy.router.openshift.io/timeout=2s

   Copy to Clipboard Toggle word wrap

手順

1. ルート定義を作成し、app-example-route.yaml というファイルに保存します。

   HTTP ヘッダーディレクティブを使用して作成されたルートの YAML 定義

   apiVersion: route.openshift.io/v1
   kind: Route
   # ...
   spec:
     host: app.example.com
     tls:
       termination: edge
     to:
       kind: Service
       name: app-example
     httpHeaders:
       actions: 

   1

   
         response: 

   2

   
         - name: Content-Location 

   3

   
           action:
             type: Set 

   4

   
             set:
               value: /lang/en-us 

   5

   Copy to Clipboard Toggle word wrap

   1

   HTTP ヘッダーに対して実行するアクションのリスト。

   2

   変更するヘッダーのタイプ。この場合は、応答ヘッダーです。

   3

   変更するヘッダーの名前。設定または削除できる使用可能なヘッダーのリストは、HTTP ヘッダーの設定 を参照してください。

   4

   ヘッダーに対して実行されるアクションのタイプ。このフィールドには、Set または Delete の値を指定できます。

   5

   HTTP ヘッダーの設定時は、値 を指定する必要があります。値は、そのヘッダーで使用可能なディレクティブのリストからの文字列 (例: DENY) にすることも、HAProxy の動的値構文を使用して解釈される動的値にすることもできます。この場合、値はコンテンツの相対位置に設定されます。

2. 新しく作成したルート定義を使用して、既存の Web アプリケーションへのルートを作成します。

   $ oc -n app-example create -f app-example-route.yaml

   Copy to Clipboard Toggle word wrap

1. デフォルトでは、ルーターは 5 秒ごとにリロードされ、最初から Pod 間の接続のバランスがリセットされます。その結果、roundrobin 状態はリロード間で保持されません。このアルゴリズムは、Pod のコンピューティング能力とストレージ容量がほぼ同じである場合に最適に機能します。たとえば、CI/CD パイプラインの使用により、アプリケーションまたはサービスのエンドポイントが継続的に変更される場合、結果的にバランスが不均一になる可能性があります。その場合は別のアルゴリズムを使用します。

2. 許可リストの IP アドレスと CIDR 範囲の数が 61 を超えると、それらは別のファイルに書き込まれます。これは haproxy.config ファイルから参照されます。このファイルは、/var/lib/haproxy/router/allowlists フォルダーに保存されます。

   注記

   アドレスが許可リストに書き込まれることを確認するには、CIDR 範囲の完全なリストが Ingress Controller 設定ファイルに記載されていることを確認します。etcd オブジェクトサイズ制限は、ルートアノテーションのサイズを制限します。このため、許可リストに追加できる IP アドレスと CIDR 範囲の最大数のしきい値が作成されます。

手順

1. OpenShift Container Platform コンソールで Ingress オブジェクトを定義するか、oc create コマンドを実行します。

   Ingress の YAML 定義

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     name: frontend
     annotations:
       route.openshift.io/termination: "reencrypt" 

   1

   
       route.openshift.io/destination-ca-certificate-secret: secret-ca-cert 

   2

   
   spec:
     rules:
     - host: www.example.com 

   3

   
       http:
         paths:
         - backend:
             service:
               name: frontend
               port:
                 number: 443
           path: /
           pathType: Prefix
     tls:
     - hosts:
       - www.example.com
       secretName: example-com-tls-certificate

   Copy to Clipboard Toggle word wrap

   1

   route.openshift.io/termination アノテーションは、Route の spec.tls.termination フィールドを設定するために使用できます。Ingress にはこのフィールドがありません。許可される値は edge、passthrough、および reencrypt です。その他のすべての値は警告なしに無視されます。アノテーション値が設定されていない場合は、edge がデフォルトルートになります。デフォルトのエッジルートを実装するには、TLS 証明書の詳細をテンプレートファイルで定義する必要があります。

   3

   Ingress オブジェクトを操作する場合、ルートを操作する場合とは異なり、明示的なホスト名を指定する必要があります。<host_name>.<cluster_ingress_domain> 構文 (apps.openshiftdemos.com など) を使用して、*.<cluster_ingress_domain> ワイルドカード DNS レコードとクラスターのサービング証明書を利用できます。それ以外の場合は、選択したホスト名の DNS レコードがあることを確認する必要があります。

   1. route.openshift.io/termination アノテーションで passthrough の値を指定する場合は、仕様で path を '' に設定し、pathType を ImplementationSpecific に設定します。

        spec:
          rules:
          - host: www.example.com
            http:
              paths:
              - path: ''
                pathType: ImplementationSpecific
                backend:
                  service:
                    name: frontend
                    port:
                      number: 443

      Copy to Clipboard Toggle word wrap

      $ oc apply -f ingress.yaml

      Copy to Clipboard Toggle word wrap

   2

   route.openshift.io/destination-ca-certificate-secret を Ingress オブジェクトで使用して、カスタム宛先証明書 (CA) でルートを定義できます。アノテーションは、生成されたルートに挿入される kubernetes シークレット secret-ca-cert を参照します。

   1. Ingress オブジェクトから宛先 CA を使用してルートオブジェクトを指定するには、シークレットの data.tls.crt 指定子に PEM エンコード形式の証明書を使用して kubernetes.io/tls または Opaque タイプのシークレットを作成する必要があります。

2. ルートを一覧表示します。

   $ oc get routes

   Copy to Clipboard Toggle word wrap

   結果には、frontend- で始まる名前の自動生成ルートが含まれます。

   NAME             HOST/PORT         PATH    SERVICES    PORT    TERMINATION          WILDCARD
   frontend-gnztq   www.example.com           frontend    443     reencrypt/Redirect   None

   Copy to Clipboard Toggle word wrap

   このルートを検査すると、以下のようになります。

   自動生成されるルートの YAML 定義

   apiVersion: route.openshift.io/v1
   kind: Route
   metadata:
     name: frontend-gnztq
     ownerReferences:
     - apiVersion: networking.k8s.io/v1
       controller: true
       kind: Ingress
       name: frontend
       uid: 4e6c59cc-704d-4f44-b390-617d879033b6
   spec:
     host: www.example.com
     path: /
     port:
       targetPort: https
     tls:
       certificate: |
         -----BEGIN CERTIFICATE-----
         [...]
         -----END CERTIFICATE-----
       insecureEdgeTerminationPolicy: Redirect
       key: |
         -----BEGIN RSA PRIVATE KEY-----
         [...]
         -----END RSA PRIVATE KEY-----
       termination: reencrypt
       destinationCACertificate: |
         -----BEGIN CERTIFICATE-----
         [...]
         -----END CERTIFICATE-----
     to:
       kind: Service
       name: frontend

   Copy to Clipboard Toggle word wrap

手順

1. Ingress オブジェクトの YAML ファイルを作成します。この例では、ファイルの名前は example-ingress.yaml です。

   Ingress オブジェクトの YAML 定義

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     name: frontend
     ...
   spec:
     rules:
       ...
     tls:
     - {} 

   1

   Copy to Clipboard Toggle word wrap

   1

   この正確な構文を使用して、カスタム証明書を指定せずに TLS を指定します。

2. 次のコマンドを実行して、Ingress オブジェクトを作成します。

   $ oc create -f example-ingress.yaml

   Copy to Clipboard Toggle word wrap

手順

1. 次のコマンドを入力して、宛先 CA 証明書のシークレットを作成します。

   $ oc create secret generic dest-ca-cert --from-file=tls.crt=<file_path>

   Copy to Clipboard Toggle word wrap

   以下に例を示します。

   $ oc -n test-ns create secret generic dest-ca-cert --from-file=tls.crt=tls.crt

   Copy to Clipboard Toggle word wrap

   出力例

   secret/dest-ca-cert created

   Copy to Clipboard Toggle word wrap

2. route.openshift.io/destination-ca-certificate-secret を Ingress アノテーションに追加します。

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     name: frontend
     annotations:
       route.openshift.io/termination: "reencrypt"
       route.openshift.io/destination-ca-certificate-secret: secret-ca-cert 

   1

   
   ...

   Copy to Clipboard Toggle word wrap

   1

   アノテーションは kubernetes シークレットを参照します。

3. このアノテーションで参照されているシークレットは、生成されたルートに挿入されます。

   出力例

   apiVersion: route.openshift.io/v1
   kind: Route
   metadata:
     name: frontend
     annotations:
       route.openshift.io/termination: reencrypt
       route.openshift.io/destination-ca-certificate-secret: secret-ca-cert
   spec:
   ...
     tls:
       insecureEdgeTerminationPolicy: Redirect
       termination: reencrypt
       destinationCACertificate: |
         -----BEGIN CERTIFICATE-----
         [...]
         -----END CERTIFICATE-----
   ...

   Copy to Clipboard Toggle word wrap

手順

1. Ingress Controller が、IPv4 / IPv6 を介してトラフィックをワークロードに提供するようにするには、ipFamilies フィールドおよび ipFamilyPolicy フィールドを設定して、サービス YAML ファイルを作成するか、既存のサービス YAML ファイルを変更します。以下に例を示します。

   サービス YAML ファイルの例

   apiVersion: v1
   kind: Service
   metadata:
     creationTimestamp: yyyy-mm-ddT00:00:00Z
     labels:
       name: <service_name>
       manager: kubectl-create
       operation: Update
       time: yyyy-mm-ddT00:00:00Z
     name: <service_name>
     namespace: <namespace_name>
     resourceVersion: "<resource_version_number>"
     selfLink: "/api/v1/namespaces/<namespace_name>/services/<service_name>"
     uid: <uid_number>
   spec:
     clusterIP: 172.30.0.0/16
     clusterIPs: 

   1

   
     - 172.30.0.0/16
     - <second_IP_address>
     ipFamilies: 

   2

   
     - IPv4
     - IPv6
     ipFamilyPolicy: RequireDualStack 

   3

   
     ports:
     - port: 8080
       protocol: TCP
       targetport: 8080
     selector:
       name: <namespace_name>
     sessionAffinity: None
     type: ClusterIP
   status:
     loadbalancer: {}

   Copy to Clipboard Toggle word wrap

   1

   デュアルスタックインスタンスでは、2 つの異なる clusterIPs が提供されます。

   2

   シングルスタックインスタンスの場合は、IPv4 または IPv6 と入力します。デュアルスタックインスタンスの場合は、IPv4 と IPv6 の両方を入力します。

   3

   シングルスタックインスタンスの場合は、SingleStack と入力します。デュアルスタックインスタンスの場合は、RequireDualStack と入力します。

   これらのリソースは、対応する endpoints を生成します。Ingress Controller は、endpointslices を監視するようになりました。

2. endpoints を表示するには、以下のコマンドを入力します。

   $ oc get endpoints

   Copy to Clipboard Toggle word wrap

3. endpointslices を表示するには、以下のコマンドを入力します。

   $ oc get endpointslices

   Copy to Clipboard Toggle word wrap

手順

1. 次のコマンドを実行して、シークレットと同じ namespace に role を作成し、ルーターサービスアカウントに読み取りアクセスを許可します。

   $ oc create role secret-reader --verb=get,list,watch --resource=secrets --resource-name=<secret-name> \ 

   1

   
   --namespace=<current-namespace> 

   2

   Copy to Clipboard Toggle word wrap

   1

   シークレットの実際の名前を指定します。

   2

   シークレットとルートの両方が存在する namespace を指定します。

2. 次のコマンドを実行して、シークレットと同じ namespace に rolebinding を作成し、ルーターサービスアカウントを新しく作成されたロールにバインドします。

   $ oc create rolebinding secret-reader-binding --role=secret-reader --serviceaccount=openshift-ingress:router --namespace=<current-namespace> 

   1

   Copy to Clipboard Toggle word wrap

   1

   シークレットとルートの両方が存在する namespace を指定します。

3. 次の例を使用して、route を定義し、証明書を含むシークレットを指定する YAML ファイルを作成します。

   セキュアなルートの YAML 定義

   apiVersion: route.openshift.io/v1
   kind: Route
   metadata:
     name: myedge
     namespace: test
   spec:
     host: myedge-test.apps.example.com
     tls:
       externalCertificate:
         name: <secret-name> 

   1

   
       termination: edge
       [...]
   [...]

   Copy to Clipboard Toggle word wrap

   1

   シークレットの実際の名前を指定します。

4. 次のコマンドを実行して route リソースを作成します。

   $ oc apply -f <route.yaml> 

   1

   Copy to Clipboard Toggle word wrap

   1

   生成された YAML ファイル名を指定します。

   シークレットが存在し、証明書/キーペアがある場合、すべての前提条件が満たされていれば、ルーターは生成された証明書を提供します。

   注記

   .spec.tls.externalCertificate が指定されていないと、ルーターはデフォルトで生成された証明書を使用します。

   .spec.tls.externalCertificate フィールドを使用する場合は、.spec.tls.certificate フィールドまたは .spec.tls.key フィールドを指定することはできません。

手順

1. オプション: 現在の外部 IP 設定を表示するには、以下のコマンドを入力します。

   $ oc describe networks.config cluster

   Copy to Clipboard Toggle word wrap

2. 設定を編集するには、以下のコマンドを入力します。

   $ oc edit networks.config cluster

   Copy to Clipboard Toggle word wrap

3. 以下の例のように ExternalIP 設定を変更します。

   apiVersion: config.openshift.io/v1
   kind: Network
   metadata:
     name: cluster
   spec:
     ...
     externalIP: 

   1

   
     ...

   Copy to Clipboard Toggle word wrap

   1

   externalIP スタンザの設定を指定します。

4. 更新された ExternalIP 設定を確認するには、以下のコマンドを入力します。

   $ oc get networks.config cluster -o go-template='{{.spec.externalIP}}{{"\n"}}'

   Copy to Clipboard Toggle word wrap

手順

1. oc new-project コマンドを実行して、サービス用の新しいプロジェクトを作成します。

   $ oc new-project <project_name>

   Copy to Clipboard Toggle word wrap

2. oc new-app コマンドを使用してサービスを作成します。

   $ oc new-app nodejs:12~https://github.com/sclorg/nodejs-ex.git

   Copy to Clipboard Toggle word wrap

3. サービスが作成されたことを確認するには、以下のコマンドを実行します。

   $ oc get svc -n <project_name>

   Copy to Clipboard Toggle word wrap

   出力例

   NAME        TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
   nodejs-ex   ClusterIP   172.30.197.157   <none>        8080/TCP   70s

   Copy to Clipboard Toggle word wrap

   注記

   デフォルトで、新規サービスには外部 IP アドレスがありません。

手順

1. 公開するサービスが置かれているプロジェクトにログインします。

   $ oc project <project_name>

   Copy to Clipboard Toggle word wrap

2. oc expose service コマンドを実行して、ルートを公開します。

   $ oc expose service nodejs-ex

   Copy to Clipboard Toggle word wrap

   出力例

   route.route.openshift.io/nodejs-ex exposed

   Copy to Clipboard Toggle word wrap

3. サービスが公開されていることを確認するには、curl などのツールを使用して、クラスター外からサービスにアクセスできることを確認します。

   1. ルートのホスト名を見つけるには、次のコマンドを入力します。

      $ oc get route

      Copy to Clipboard Toggle word wrap

      出力例

      NAME        HOST/PORT                        PATH   SERVICES    PORT       TERMINATION   WILDCARD
      nodejs-ex   nodejs-ex-myproject.example.com         nodejs-ex   8080-tcp                 None

      Copy to Clipboard Toggle word wrap

   2. ホストが GET 要求に応答することを確認するには、次のコマンドを入力します。

      curl コマンドの例

      $ curl --head nodejs-ex-myproject.example.com

      Copy to Clipboard Toggle word wrap

      出力例

      HTTP/1.1 200 OK
      ...

      Copy to Clipboard Toggle word wrap