8.3. サービスの検出

3scale を使用した管理のために、OpenAPI Specification (OAS、Swagger 仕様とも呼ばれる) に対応する新しい API サービスを検出することができます (該当する場合には、クラスターから検出されます)。

前提条件

  • OpenShift の管理者が、OpenShift クラスターにサービスディスカバリーを設定している。たとえば、Fuse Online API の場合、OpenShift の管理者は Fuse Online サービスの CONTROLLERS_EXPOSE_VIA3SCALE 環境変数を true に設定する必要があります。
  • 「サービスディスカバリーについて」 で説明するように、3scale の管理者が 3scale デプロイメントで Service Discovery を設定している。
  • API のサービス名およびその namespace (OpenShift プロジェクト) を把握している。
  • 3scale の管理者が、3scale ユーザーまたはサービスアカウント (設定されている認証モードによる) に、API サービスおよびその namespace を表示するのに必要な権限を付与している。詳細については、「OpenShift プロジェクトへの 3scale アクセスの承認」 を参照してください。
  • API サービスが、3scale をインストールしたクラスターと同じ OpenShift クラスターにデプロイされている。
  • 「サービスディスカバリーについて」 で説明するように、サービスディスカバリーを有効にする正しいアノテーションが API に付けられている。

手順

  1. 3scale 管理ポータルにログインします。
  2. 管理ポータルの Dashboard で、NEW API をクリックします。

  3. Import from OpenShift を選択します。

    • OAuth トークンが有効ではない場合、OpenShift プロジェクトの管理者は、3scale ユーザーの アクセスを承認 する必要があります。
  4. Namespace フィールドで、API が含まれる OpenShift プロジェクトを指定または選択します (例: fuse)。
  5. Name フィールドで、上記 namespace 内の OpenShift サービスの名前を入力または選択します (例: i-task-api)。
  6. Create Service をクリックします。
  7. 新しい API サービスが 3scale に非同期的にインポートされるのを待ちます。管理ポータル右上のセクションに、The service will be imported shortly.You will receive a notification when it is done. というメッセージが表示されます。

次のステップ

API 管理の詳細については、Red Hat 3scale API Management のドキュメント を参照してください。