3scale API Management を Streams for Apache Kafka Bridge とともに使用

手順

1. Red Hat 3Scale のドキュメント の説明に従って 3scale API Management をセットアップします。

   1. 3scale Operator を使用して、3scale API Manager と APIcast をインストールします。

      API Manager をデプロイする前に、APIManager カスタムリソースの wildcardDomain プロパティーを OpenShift クラスターのドメインと一致するように更新します。

      ドメインは、3scale 管理ポータルにアクセスするための URL (http[s]://<authentication_token>@3scale-admin.<cluster_domain>) で使用されます。

   2. APIManager カスタムリソースのステータスを確認して、3scale のデプロイメントを確認します。

2. Kafka Bridge を検出する権限を 3scale API Manager に付与します。

   oc adm policy add-cluster-role-to-user view system:serviceaccount:<my_bridge_namespace>:amp

   Copy to Clipboard Toggle word wrap

   このコマンドは、指定した namespace (<my_bridge_namespace>) の Kafka Bridge リソースへの読み取りアクセス (view) を、API Manager (amp) に付与します。

3. Cluster Operator デプロイメントに 3scale 検出に必要なラベルとアノテーションがあることを確認します。

   #...
   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/v3
   #...

   Copy to Clipboard Toggle word wrap

   Kafka Bridge で OpenAPI v2 のサポートが非推奨になると、/openapi エンドポイントは OpenAPI v3 を表すようになります。その時点で、/openapi/v3 エンドポイントは削除される予定です。

   必要に応じて、OpenShift コンソールからこれらのプロパティーを更新するか、Cluster Operator と Kafka Bridge を再デプロイします。

4. Red Hat 3Scale のドキュメント の説明に従って、3scale 管理ポータルで OpenShift から Kafka Bridge API サービスをインポートします。

5. OpenAPI 仕様 (JSON ファイル) に、Kafka Bridge サービスのベース URL を参照する servers プロパティーを追加します。

   Kafka Bridge サービス URL への参照の例

   {
       "openapi": "3.0.0",
       "info": {
         "title": "Kafka Bridge API Reference",
         "description": "The Kafka Bridge provides a REST API
           for integrating HTTP based client applications with
           a Kafka cluster. You can use the API to create and
           manage consumers and send and receive records over
           HTTP rather than the native Kafka protocol. ",
           "version": "0.1.0"
       },
       "servers": [
         {
           "url": "https://my-bridge-bridge-service.my-project.svc.cluster.local:8080"
         }
       ],
       "paths": {

   Copy to Clipboard Toggle word wrap

   servers の URL に以下が含まれていることを確認してください。

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

6. OpenAPI カスタムリソースを作成して、Kafka Bridge OpenAPI 仕様をインポートします。

   OpenAPI カスタムリソースを作成すると、3scale Operator によって、サービス ID を含む 3scale Product カスタムリソースが自動的に作成されます。

7. Kafka Bridge ルーティングポリシー (policies_config.json) をインポートして、Product カスタムリソースを更新します。
8. 3scale 管理ポータルから、Kafka Bridge サービスのエンドポイントとポリシーがロードされていることを確認します。

9. Product カスタムリソースを更新して、アプリケーションプランとアプリケーションを設定します。

   認証用のユーザーキーを取得するにはアプリケーションが必要です。

10. (実稼働環境の場合) ProxyConfigPromote カスタムリソースを作成して、プロダクトの APIcast 設定をプロモートします。

11. コンシューマー作成呼び出しとアプリケーション用に生成されたユーザーキーを使用して、APIcast ゲートウェイ経由で Kafka Bridge への API アクセスを確認します。

    以下に例を示します。

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

    Copy to Clipboard Toggle word wrap

    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"
    }

    Copy to Clipboard Toggle word wrap

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