第8章 3scale での Kafka Bridge の使用

手順

1. 3scale API Management を OpenShift クラスターにデプロイします。

   1. 新規プロジェクトを作成するか、または既存プロジェクトを使用します。

      oc new-project my-project \
          --description="description" --display-name="display_name"

   2. 3scale をデプロイします。

      「3scale のインストール」 ガイドに記載の情報に従い、テンプレートまたは Operator を使用して OpenShift に 3scale をデプロイします。

      どの方法を使用する場合も、WILDCARD_DOMAIN パラメーターが OpenShift クラスターのドメインに設定されていることを確認してください。

      3scale 管理ポータルにアクセスするために表示される URL およびクレデンシャルを書き留めておきます。

2. 3scale が Kafka Bridge サービスを検出するように承認を付与します。

   oc adm policy add-cluster-role-to-user view system:serviceaccount:my-project:amp

3. 3scale が OpenShift コンソールまたは CLI から Openshift クラスターに正常にデプロイされたことを確認します。

   以下に例を示します。

   oc get deployment 3scale-operator

4. 3scale toolbox を設定します。

   1. 『Operating 3scale』 に記載の情報を使用して、3scale toolbox をインストールします。

   2. 3scale と対話できるように環境変数を設定します。

      export REMOTE_NAME=strimzi-kafka-bridge 1
      export SYSTEM_NAME=strimzi_http_bridge_for_apache_kafka 2
      export TENANT=strimzi-kafka-bridge-admin 3
      export PORTAL_ENDPOINT=$TENANT.3scale.net 4
      export TOKEN=3scale access token 5

      1

      REMOTE_NAME は、3scale 管理ポータルのリモートアドレスに割り当てられた名前です。

      2

      SYSTEM_NAME は、3scale toolbox で OpenAPI 仕様をインポートして作成される 3scale サービス/API の名前です。

      3

      TENANT は、3scale 管理ポータルのテナント名です (https://$TENANT.3scale.net)。

      4

      PORTAL_ENDPOINT は、3scale 管理ポータルを実行するエンドポイントです。

      5

      TOKEN は、3scale toolbox または HTTP リクエストを介して対話するために 3scale 管理ポータルによって提供されるアクセストークンです。

   3. 3scale toolbox のリモート Web アドレスを設定します。

      3scale remote add $REMOTE_NAME https://$TOKEN@$PORTAL_ENDPOINT/

      これで、toolbox を実行するたびに、3scale 管理ポータルのエンドポイントアドレスを指定する必要がなくなりました。

5. Cluster Operator デプロイメントに、3scale が Kafka Bridge サービスを検出するために必要なラベルプロパティーおよびアノテーションプロパティーがあることを確認します。

   #...
   env:
   - name: STRIMZI_CUSTOM_KAFKA_BRIDGE_SERVICE_LABELS
       value: |
       discovery.3scale.net=true
   - name: STRIMZI_CUSTOM_KAFKA_BRIDGE_SERVICE_ANNOTATIONS
       value: |
       discovery.3scale.net/scheme=http
       discovery.3scale.net/port=8080
       discovery.3scale.net/path=/
       discovery.3scale.net/description-path=/openapi
   #...

   これらのプロパティーがない場合は、OpenShift コンソールからプロパティーを追加するか、Cluster Operator および Kafka Bridge を再デプロイします。

6. 3scale で Kafka Bridge API サービスを検出します。

   1. 3scale をデプロイしたときに提供されたクレデンシャルを使用して、3scale 管理ポータルにログインします。
   2. 3scale 管理ポータルから、New API Import from OpenShiftに移動します。ここで、Kafka Bridge サービスが表示されます。

   3. Create Service をクリックします。

      ページを更新して Kafka Bridge サービスを表示することが必要な場合もあります。

      ここで、サービスの設定をインポートする必要があります。エディターからインポートしますが、ポータルを開いたまま正常にインポートされたことを確認します。

7. OpenAPI 仕様 (JSON ファイル) の Host フィールドを編集して、Kafka Bridge サービスのベース URL を使用します。

   以下に例を示します。

   "host": "my-bridge-bridge-service.my-project.svc.cluster.local:8080"

   host URL に以下が正しく含まれることを確認します。

   • Kafka Bridge 名 (my-bridge)
   • プロジェクト名 (my-project)
   • Kafka Bridge のポート (8080)

8. 3scale toolbox を使用して、更新された OpenAPI 仕様をインポートします。

   3scale import openapi -k -d $REMOTE_NAME openapiv2.json -t myproject-my-bridge-bridge-service

9. サービスの Header Modification および Routing ポリシー (JSON ファイル) をインポートします。

   1. 3scale で作成したサービスの ID を特定します。

      ここでは、`jq` ユーティリティー を使用します。

      export SERVICE_ID=$(curl -k -s -X GET "https://$PORTAL_ENDPOINT/admin/api/services.json?access_token=$TOKEN" | jq ".services[] | select(.service.system_name | contains(\"$SYSTEM_NAME\")) | .service.id")

      ポリシーをインポートするときにこの ID が必要です。

   2. ポリシーをインポートします。

      curl -k -X PUT "https://$PORTAL_ENDPOINT/admin/api/services/$SERVICE_ID/proxy/policies.json" --data "access_token=$TOKEN" --data-urlencode policies_config@policies_config.json

10. 3scale 管理ポータルから、Integration Configuration に移動し、Kafka Bridge サービスのエンドポイントとポリシーが読み込まれていることを確認します。
11. アプリケーションプランを作成するために、Applications Create Application Plan に移動します。

12. アプリケーションを作成するために、Audience Developer Applications Create Application に移動します。

    認証のユーザーキーを取得するためにアプリケーションが必要になります。

13. 実稼働環境用の手順: 実稼働環境のゲートウェイで API を利用可能にするには、設定をプロモートします。

    3scale proxy-config promote $REMOTE_NAME $SERVICE_ID

14. API テストツールを使用して、コンシューマーの作成に呼び出しを使用する APIcast ゲートウェイと、アプリケーションに作成されたユーザーキーで、Kafka Bridge にアクセスできることを検証します。

    以下に例を示します。

    https//my-project-my-bridge-bridge-service-3scale-apicast-staging.example.com:443/consumers/my-group?user_key=3dfc188650101010ecd7fdc56098ce95

    Kafka Bridge からペイロードが返されれば、コンシューマーが正常に作成されています。

    {
      "instance_id": "consumer1",
      "base uri": "https//my-project-my-bridge-bridge-service-3scale-apicast-staging.example.com:443/consumers/my-group/instances/consumer1"
    }

    ベース URI は、クライアントが以降のリクエストで使用するアドレスです。