手順

1. 3scale 用の OpenShift OAuth クライアントを作成します。詳細は、OpenShift の認証に関するドキュメント を参照してください。以下の例で、<provide-a-client-secret> を生成するシークレットに、<3scale-master-domain-route> を 3scale マスター管理ポータルにアクセスするための URL に、それぞれ置き換えます。

       $ oc project default
       $ cat <<-EOF | oc create -f -
       kind: OAuthClient
       apiVersion: v1
       metadata:
        name: 3scale
       secret: "<provide-a-client-secret>"
       redirectURIs:
        - "<3scale-master-domain-route>"
       grantMethod: prompt
       EOF

2. 3scale サービスディスカバリーの設定ファイルを開きます。

       $ oc project <3scale-project>
       $ oc edit configmap system

3. 以下のように設定します。

       service_discovery.yml:
         production:
           enabled: true
           authentication_method: oauth
           oauth_server_type: builtin
           client_id: '3scale'
           client_secret: '<choose-a-client-secret>'

4. ユーザーが適切なアクセス権限を持ち、検出可能なサービスが含まれるクラスタープロジェクトを表示できるようにしてください。

   <user> で表される管理ユーザーに、検出されるサービスが含まれる <namespace> プロジェクトを表示する権限を付与するには、以下のコマンドを使用します。

   oc adm policy add-role-to-user view <user> -n <namespace>

5. configmap を変更したら、system-app および system-sidekiq Pod を再デプロイし、変更を適用する必要があります。

   oc rollout latest dc/system-app
   oc rollout latest dc/system-sidekiq

6. ロールアウトのステータスを表示し、読み込みが完了したことを確認します。

   oc rollout status dc/system-app
   oc rollout status dc/system-sidekiq

手順

1. Red Hat OAuth サーバー (Keycloak) に、3scale 用の OAuth クライアントを作成します。

   注記

   クライアント設定で、OpenShift がアカウントをリンクすることができるように、username が preferred_username にマッピングされていることを確認します。

2. 3scale サービスディスカバリーの設定を編集します。

       $ oc project <3scale-project>
       $ oc edit configmap system

3. 以下のように設定されていることを確認します。ここで、<the-client-secret-from-Keycloak> は、OAuth クライアントの作成時に Keycloak が自動生成した値です。

       service_discovery.yml:
         production:
           enabled: true
           authentication_method: oauth
           oauth_server_type: rh_sso
           client_id: '3scale'
           client_secret: '<the-client-secret-from-Keycloak>'

4. ユーザーが適切なアクセス権限を持ち、検出可能なサービスが含まれるクラスタープロジェクトを表示できるようにしてください。

   たとえば、<user> に <namespace> プロジェクトを表示する権限を付与するには、以下のコマンドを使用します。

   oc adm policy add-role-to-user view <user> -n <namespace>

5. configmap を変更したら、system-app および system-sidekiq Pod を再デプロイし、変更を適用する必要があります。

手順

1. 3scale プロジェクトをアクティブなプロジェクトにします。

      $ oc project <3scale-project>

2. エディターで 3scale サービスディスカバリーの設定を開きます。

      $ oc edit configmap system

3. 以下のように設定されていることを確認します。

   service_discovery.yml:
      production:
         enabled: <%= cluster_token_file_exists = File.exists?(cluster_token_file_path = '/var/run/secrets/kubernetes.io/serviceaccount/token') %>
         bearer_token: "<%= File.read(cluster_token_file_path) if cluster_token_file_exists %>"
         authentication_method: service_account

4. 以下のいずれかのオプションに従って、3scale デプロイメントの amp サービスアカウントに、検出可能なサービスが含まれるプロジェクトを表示するための適切な権限を付与します。

   • Fuse Online プロジェクトに切り替え、view cluster level パーミッションを持つ 3scale デプロイメントの amp サービスアカウントを付与します。

     oc project <fuseonline project>
     
     oc adm policy add-cluster-role-to-user view system:serviceaccount:<3scale-project>:amp

   • 『Developer Guide』の「Service Accounts」で説明するように、より厳しいポリシーを適用する。

手順

1. New API をクリックします。新規の API ページが開きます。

   デフォルトでは、API Designer は OpenAPI 3 仕様を使用します。OpenAPI 2 仕様を使用する場合は、New API ボタンの横にある矢印をクリックし、OpenAPI 2 を選択します。

   注記

   OpenAPI 2 仕様に基づいて API を開く場合、API Designer の Convert to OpenAPI 3 オプションを使用して、API が OpenAPI 3 仕様に準拠するよう変換することができます。

2. API 名を変更するには、以下を実行します。

   1. 名前にカーソルを合わせ、表示される編集アイコン ( ) をクリックします。
   2. 名前を編集します。たとえば、Task API を入力します。
   3. チェックマークアイコンをクリックして、名前変更を確認します。

3. 任意で以下を行います。

   • バージョン番号と説明を提供します。
   • 連絡先情報 (名前、メールアドレス、および URL) を追加します。
   • ライセンスを選択します。
   • タグを定義します。
   • サーバーを 1 つ以上定義します。
   • セキュリティースキームを設定します。
   • セキュリティー要件を指定します。

4. API のそれぞれのエンドポイントへの相対パスを定義します。フィールド名はスラッシュ (/) で開始する必要があります。

   Task Management API のサンプルでは、2 つのパスを作成します。

   • 複数のタスクのパス: /todo

   • ID 別の特定タスクのパス: /todo/{id}

     

5. 任意のパスパラメーターのタイプを指定します。

   id パラメーターのサンプルは、以下のようになります。

   1. Paths リストで、/todo/{id} をクリックします。

      id パラメーターが PATH PARAMETERS セクションに表示されます。

   2. Create をクリックします。
   3. description (説明) には、The ID of the task to find. と入力します。

   4. 「type (タイプ)」については、integer を 32-Bit integer として選択します。

      

6. Data Types セクションで、API の再利用可能なタイプを定義します。

   1. Add a data type をクリックします。
   2. Add Data Type ダイアログで名前を入力します。Task Management API のサンプルでは、Todo と入力します。

   3. 任意で、API Designer がデータタイプのスキーマの作成に使用するサンプルを指定できます。生成されるスキーマを編集できます。

      Task Management API のサンプルでは、以下の JSON 例で開始します。

      {
          "id": 1,
          "task": "my task",
          "completed": false
      }

   4. オプションで、該当するデータタイプを指定して REST リソースの作成を選択できます。

   5. Save をクリックします。サンプルを指定している場合、API Designer はそのサンプルからスキーマを生成します。

      
7. オプションで、スキーマのプロパティーを編集し、新しいプロパティーを追加できます。

8. Task Management API のサンプルの場合、タイプ string の task という名前の 1 つのプロパティーを使用して、 Task という名前の別のデータタイプを作成します。

   

9. それぞれのパスについて、操作 (GET、PUT、POST、DELETE、 OPTIONS、HEAD、または PATCH) を定義します。

   Task Management API のサンプルの場合、以下の表で説明されているように操作を定義します。

   表3.1 Task Management API 操作

   パス	操作	説明	リクエストボディー	応答
   /todo	POST	新しいタスクを作成します。	メディアタイプ: application/json データタイプ: Task	ステータスコード: 201 説明: Task created 応答ボディー: メディアタイプ: application/json データタイプ: Todo
   /todo	GET	すべてのタスクを取得します。	該当なし	ステータスコード: 200 説明: Task deleted ステータスコード: 400 説明: Task not deleted
   /todo/{id}	GET	ID 別にタスクを取得します。	該当なし	ステータスコード: 200 説明: Task found for ID 応答ボディー: メディアタイプ: application/json データタイプ: Task ステータスコード: 404 説明: No task with provided identifier found.
   /todo/{id}	UPDATE	ID 別にタスクを更新します。	リクエストボディーのタイプ: Task	ステータスコード: 200 説明: Completed ステータスコード: 400 説明: Task not updated
   /todo/{id}	DELETE	ID 別にタスクを削除します。	該当なし	ステータスコード: 200 説明: Task deleted ステータスコード: 400 説明: Task not deleted

10. 「 API Designer での検証問題の解決」の説明どおりに問題 を解決します。

手順

1. 感嘆符 (!) アイコンで示唆される問題を検索します。以下に例を示します。

   

2. 感嘆符アイコンをクリックして、問題の説明を表示します。以下に例を示します。

   

3. 問題の説明で提供される情報に基づいて、問題のある場所に移動し、修正します。

   たとえば、「Operation must have at least one response」(オペレーションには 1 つ以上の応答が必要) の問題を修正するには、GET オペレーションをクリックして開き、Add a response をクリックします。

   

   応答の説明の入力後、問題は解決され、感嘆符アイコンは表示されなくなります。

   

4. すべての問題の概要については、以下のようになります。

   1. 右上にある Issues リンクをクリックします。

      

   2. 特定の問題の Go to a problem をクリックし、その問題を解決するために問題のある場所に移動します。