2.3. OpenShift 4.x への API Designer のインストール

Red Hat Fuse on OpenShift では、REST API の設計に使用できる Web ベースの API デザイナーツールである API Designer が提供されます。API Designer Operator を使用すると、OpenShift Container Platform 4.x で API Designer を簡単にインストールおよびアップグレードできます。

OpenShift 管理者として、API Designer Operator を OpenShift プロジェクト (namespace) にインストールします。Operator はインストール後に、選択された namespace で実行されます。しかし、API Designer をサービスとして使用できるようにするには、OpenShift 管理者または開発者が API Designer のインスタンスを作成する必要があります。API Designer サービスによって、API Designer Web コンソールにアクセスするための URL が提供されます。

前提条件

  • OpenShift クラスターの管理者権限を持っている必要があります。
  • Red Hat コンテナーレジストリーへの認証が設定されている必要があります。

手順

  1. OpenShift 4.x サーバーを起動します。
  2. Web ブラウザーで OpenShift コンソールに移動します。ご自分のクレデンシャルでコンソールにログインします。
  3. Operators をクリックした後、OperatorHub をクリックします。
  4. 検索フィールドに API Designer と入力します。
  5. API Designer カードをクリックします。API Designer Operator のインストールページが表示されます。

  6. Install をクリックします。Install Operator ページが表示されます。

    1. Installation mode では、クラスターの namespace のリストから namespace (プロジェクト) を 1 つ選択します。

    2. Approval Strategy では、Automatic または Manual を選択し、API Designer Operator の更新が OpenShift によってどのように対処されるかを設定します。

      • Automatic (自動) 更新を選択した場合、新しいバージョンの API Designer Operator が使用できるようになると、人的な介入なしで OpenShfit Operator Lifecycle Manager (OLM) によって、API Designer の稼働中のインスタンスが自動的にアップグレードされます。
      • Manual (手動) 更新を選択した場合、Operator の新しいバージョンが使用できるようになると、OLM によって更新リクエストが作成されます。クラスター管理者は、更新リクエストを手動で承認して、API Designer Operator を新しいバージョンに更新する必要があります。
  7. Install をクリックして、指定の namespace (プロジェクト) で API Designer Operator を使用できるようにします。
  8. API Designer がプロジェクトにインストールされていることを確認するには、Operators をクリックした後、Installed Operators をクリックし、リストに API Designer があることを確認します。

次のステップ

API Designer Operator のインストール後、API Designer のインスタンスを作成し、API Designer をサービスとして OpenShift プロジェクトに追加する必要があります。このタスクを実行する方法は 2 つあります。

2.3.1. API Designer をサービスとして OpenShift 4.x プロジェクトに追加

API Designer Operator を OpenShift 4.x プロジェクトにインストールした後、OpenShift 開発者はこれをサービスとして OpenShift プロジェクトに追加できます。開発者が API Designer Web コンソールへアクセスするために使用する URL は API Designer サービスによって提供されます。

注記

OpenShift 開発者が API Designer をサービスとして OpenShift 4.x プロジェクトに追加するための手順は、API の設計 を参照してください。

前提条件

  • OpenShift クラスターの管理者権限を持っている必要があります。
  • API Designer Operator は現在の OpenShift プロジェクトにインストールされます。

手順

  1. OpenShift Web コンソールで、Operators をクリックした後、Installed Operators をクリックします。
  2. Name 列で、API Designer をクリックします。

  3. Provided APIs の Create Instance をクリックします。

    API Designer インスタンスの最小限の開始テンプレートがあるデフォルトのフォームが開かれます。

  4. デフォルト値を使用するか、任意で以下の値を編集します。

    • size: API Designer インスタンスの Pod の数。

      デフォルトは、API Designer の管理に特化したロジックが含まれる 2 つの新規リソースタイプの 2 つの Pod になります。

    • image: API Designer イメージ。このイメージを変更すると、API Designer Operator はクラスターで自動的にアップグレードされます。
  5. Create をクリックし、新しい apicurito-service を作成します。OpenShift は、新しい API Designer サービスの Pod、サービス、およびその他のコンポーネントを起動します。

  6. API Designer サービスが使用できることを確認するには、以下を実行します。

    1. Operators をクリックした後、Installed Operators をクリックします。

    2. Provided APIs 列で Apicurito CRD をクリックします。

      Operator Details ページに、apicurito-service のリストが表示されます。

  7. API Designer の URL を取得するには、以下を行います。

    1. Networking > Routes をクリックします。
    2. 正しいプロジェクトが選択されていることを確認してください。
    3. apicurito-service-ui 行で、Location 列にある API Designer Web コンソールの URL を見つけます。

2.3.2. OpenShift 4.x での API Designer のアップグレード

Red Hat OpenShift 4.x では、Red Hat Fuse Operator などの Operator の更新が処理されます。詳細は、OpenShift ドキュメントの Operator を参照してください。

また、Operator の更新によってアプリケーションのアップグレードがトリガーされる可能性があります。アプリケーションのアップグレードの実行方法は、アプリケーションの設定によって異なります。

API Designer アプリケーションでは、API Designer Operator をアップグレードすると、OpenShift によってクラスターの API Designer アプリケーションもアップグレードされます。

2.3.3. API Designer のメータリングラベル

OpenShift の Metering Operator を使用すると、インストールされた API Designer Operator、UI コンポーネント、およびコードジェネレーターを分析し、Red Hat サブスクリプションに準拠しているかどうかを判断することができます。詳細は OpenShift のメータリング を参照してください。

以下の表は、API Designer のメータリングラベルを示しています。

表2.1 API Designer のメータリングラベル

ラベル使用できる値

com.company

Red_Hat

rht.prod_name

Red_Hat_Integration

rht.prod_ver

7.8

rht.comp

Fuse

rht.comp_ver

7.8

rht.subcomp

fuse-apicurito

apicurito-service-ui

apicurito-service-generator

rht.subcomp_t

infrastructure

例

  • API Designer Operator の例: 

    apicurito-operator
com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.8
rht.comp: Fuse
rht.comp_ver: 7.8
rht.subcomp: fuse-apicurito
rht.subcomp_t: infrastructure

  • API Designer UI コンポーネントの例: 

    com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.8
rht.comp: Fuse
rht.comp_ver: 7.8
rht.subcomp: apicurito-service-ui
rht.subcomp_t: infrastructure

  • API Designer Generator コンポーネントの例: 

    com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.8
rht.comp: Fuse
rht.comp_ver: 7.8
rht.subcomp: apicurito-service-generator
rht.subcomp_t: infrastructure

2.3.4. 制限された環境で API Designer をインストールする場合の注意事項

制限された環境でインストールされる OpenShift クラスターは、デフォルトでは Red Hat が提供する OperatorHub ソースにアクセスできません。これは、OperatorHub ソースのリモートソースに完全なインターネット接続が必要であるためです。このような環境で API Designer Operator をインストールするには、以下の前提条件を満たす必要があります。

  • Operator Lifecycle Manager (OLM) のデフォルトのリモート OperatorHub ソースを無効にします。
  • 完全なインターネットアクセスのあるワークステーションを使用して、OperatorHub コンテンツのローカルミラーを作成します。
  • OLM を、デフォルトのリモートソースからではなくローカルソースから Operator をインストールし、管理するように設定します。

詳細は、OpenShift ドキュメントの ネットワークが制限された環境での Operator Lifecycle Manager の使用 を参照してください。OperatorHub のローカルミラーを作成したら、次のステップを実行できます。