2.12.3. Ingress Operator の Gateway API を使い始める

手順

1. GatewayClass オブジェクトを作成します。

   1. 次の情報が含まれる YAML ファイル openshift-default.yaml を作成します。

      GatewayClass CR の例

      apiVersion: gateway.networking.k8s.io/v1
      kind: GatewayClass
      metadata:
        name: openshift-default
      spec:
        controllerName: openshift.io/gateway-controller/v1

      • controllerName: コントローラー名。

        重要

        Ingress Operator がこれを管理するには、コントローラー名が表示されているとおりである必要があります。このフィールドを他の値に設定すると、Ingress Operator は GatewayClass オブジェクトと、それに関連付けられたすべての Gateway、GRPCRoute、および HTTPRoute オブジェクトを無視します。コントローラー名は OpenShift Container Platform の Gateway API の実装に関連付けられており、許可されるコントローラー名は openshift.io/gateway-controller/v1 のみです。

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

      $ oc create -f openshift-default.yaml

      出力例

      gatewayclass.gateway.networking.k8s.io/openshift-default created

      GatewayClass リソースの作成中に、Ingress Operator は Red Hat OpenShift Service Mesh の軽量バージョン、Istio カスタムリソース、および openshift-ingress namespace に新しいデプロイメントをインストールします。

   3. オプション: 新しいデプロイメントである istiod-openshift-gateway が準備完了で利用可能であることを確認します。

      $ oc get deployment -n openshift-ingress

      出力例

      NAME                       READY   UP-TO-DATE   AVAILABLE   AGE
      istiod-openshift-gateway   1/1     1            1           55s
      router-default             2/2     2            2           6h4m

2. 次のコマンドを実行してシークレットを作成します。

   $ oc -n openshift-ingress create secret tls gwapi-wildcard --cert=wildcard.crt --key=wildcard.key

3. 次のコマンドを実行して、Ingress Operator のドメインを取得します。

   $ DOMAIN=$(oc get ingresses.config/cluster -o jsonpath={.spec.domain})

4. Gateway オブジェクトを作成します。

   1. 次の情報が含まれる YAML ファイル example-gateway.yaml を作成します。

      ゲートウェイ CR の例

      apiVersion: gateway.networking.k8s.io/v1
      kind: Gateway
      metadata:
        name: example-gateway
        namespace: openshift-ingress
      spec:
        gatewayClassName: openshift-default
        listeners:
        - name: https
          hostname: "*.gwapi.${DOMAIN}"
          port: 443
          protocol: HTTPS
          tls:
            mode: Terminate
            certificateRefs:
            - name: gwapi-wildcard
          allowedRoutes:
            namespaces:
              from: All

      ここでは、以下のようになります。

      metadata.namespace

      Gateway オブジェクトは、openshift-ingress namespace に作成する必要があります。

      gatewayClassName

      Gateway オブジェクトは、以前に作成された GatewayClass オブジェクトの名前を参照する必要があります。

      リスナー名

      HTTPS リスナーは、クラスタードメインのサブドメインに一致する HTTPS 要求をリッスンします。このリスナーを使用し、Gateway API HTTPRoute リソースを使用してアプリケーションへの Ingress を設定します。

      リスナーホスト名

      ホスト名は、Ingress Operator ドメインのサブドメインである必要があります。ドメインを使用する場合、リスナーはそのドメイン内のすべてのトラフィックを処理しようとします。

      tls.name

      以前に作成されたシークレットの名前。

   2. 次のコマンドを実行して、リソースを適用します。

      $ oc apply -f example-gateway.yaml

   3. オプション: Gateway オブジェクトを作成すると、Red Hat OpenShift Service Mesh は同じ名前のデプロイメントとサービスを自動的にプロビジョニングします。以下のコマンドを実行して、これを確認します。

      • デプロイメントを確認するには、次のコマンドを実行します。

        $ oc get deployment -n openshift-ingress example-gateway-openshift-default

        出力例

        NAME                                 READY   UP-TO-DATE   AVAILABLE   AGE
        example-gateway-openshift-default    1/1     1            1           25s

      • サービスを確認するには、次のコマンドを実行します。

        $ oc get service -n openshift-ingress example-gateway-openshift-default

        出力例

        NAME                                TYPE           CLUSTER-IP   EXTERNAL-IP         PORT(S)      AGE
        example-gateway-openshift-default   LoadBalancer   10.1.2.3     <external_ipname>   <port_info>  47s

   4. オプション: Ingress Operator は、リスナーからのホスト名を使用して DNSRecord CR を自動的に作成し、ラベル gateway.networking.k8s.io/gateway-name=example-gateway を追加します。次のコマンドを実行して、DNS レコードのステータスを確認します。

      $ oc -n openshift-ingress get dnsrecord -l gateway.networking.k8s.io/gateway-name=example-gateway -o yaml

      出力例

      kind: DNSRecord
        ...
      status:
        ...
        zones:
        - conditions:
          - message: The DNS provider succeeded in ensuring the record
            reason: ProviderSuccess
            status: "True"
            type: Published
          dnsZone:
            tags:
              ...
        - conditions:
          - message: The DNS provider succeeded in ensuring the record
            reason: ProviderSuccess
            status: "True"
            type: Published
          dnsZone:
            id: ...

5. すでに作成済みの namespace と example-app/example-app というアプリケーションにリクエストを送信する HTTPRoute リソースを作成します。

   1. 次の情報が含まれる YAML ファイル example-route.yaml を作成します。

      HTTP ルート CR の例

      apiVersion: gateway.networking.k8s.io/v1
      kind: HTTPRoute
      metadata:
        name: example-route
        namespace: example-app-ns
      spec:
        parentRefs:
        - name: example-gateway
          namespace: openshift-ingress
        hostnames: ["example.gwapi.${DOMAIN}"]
        rules:
        - backendRefs:
          - name: example-app 

      1

      
            port: 8443

      ここでは、以下のようになります。

      metadata.namespace

      アプリケーションをデプロイする namespace。

      spec.parentRefs

      このフィールドは、以前に設定した Gateway オブジェクトを指している必要があります。

      spec.hostnames

      ホスト名は、Gateway オブジェクトで指定されたホスト名と一致する必要があります。この場合、リスナーはワイルドカードホスト名を使用します。

      ルール.バックエンド参照

      このフィールドは、サービスを指すバックエンド参照を指定します。

      ルール名

      アプリケーションの Service の名前。

   2. 次のコマンドを実行して、リソースを適用します。

      $ oc apply -f example-route.yaml

      出力例

      httproute.gateway.networking.k8s.io/example-route created

検証

1. 次のコマンドを実行して、Gateway オブジェクトがデプロイされ、状態が Programmed であることを確認します。

   $ oc wait -n openshift-ingress --for=condition=Programmed gateways.gateway.networking.k8s.io example-gateway

   出力例

   gateway.gateway.networking.k8s.io/example-gateway condition met

2. 設定された HTTPRoute オブジェクトのホスト名にリクエストを送信します。

   $ curl -I --cacert <local cert file> https://example.gwapi.${DOMAIN}:443