Menu Close

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 のインストール時に、Operator は選択された namespace で実行されます。ただし、API Designer をサービスとして利用可能にするには、OpenShift 管理者として、または開発者が API Designer のインスタンスを作成する必要があります。API Designer サービスによって、API Designer Web コンソールにアクセスするための URL が提供されます。

前提条件

  • OpenShift クラスターの管理者権限を持っている必要があります。
  • registry.redhat.io への認証が設定されている。

手順

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

    1. Update Channel には fuse-console-7.10.x を選択します。
    2. Installation mode では、クラスターの namespace のリストから namespace (プロジェクト) を 1 つ選択します。
    3. Approval Strategy では、Automatic または Manual を選択し、API Designer Operator の更新が OpenShift によってどのように対処されるかを設定します。

      • Automatic (自動)更新を選択した場合、新しいバージョンの API Designer Operator が使用できるようになると、人的な介入なしに、OpenShift Operator Lifecycle Manager(OLM)によって、API Designer の実行中のインスタンスが自動的にアップグレードされます。
      • Manual (手動) 更新を選択した場合、Operator の新しいバージョンが使用できるようになると、OLM によって更新リクエストが作成されます。クラスター管理者は、更新リクエストを手動で承認して、API Designer Operator を新しいバージョンに更新する必要があります。
  7. Install をクリックして、指定の namespace (プロジェクト) で API Designer Operator を使用できるようにします。
  8. API Designer がプロジェクトにインストールされていることを確認するには、Operators をクリックした後、Installed Operators をクリックし、リストにある Red Hat Integration - 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 プロジェクトに追加するための手順は、『Designing APIs』を参照してください。

前提条件

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

手順

  1. OpenShift Web コンソールで、Operators をクリックした後、Installed Operators をクリックします。
  2. Name 列で、Red Hat Integration - API Designer をクリックします。
  3. Provided APIsCreate instance をクリックします。

    API Designer インスタンスの最小限の開始テンプレートがあるデフォルトのフォームが開かれます。デフォルト値を使用するか、任意でデフォルト値を編集します。

  4. Create をクリックし、新しい apicurito-service を作成します。OpenShift は、新しい API Designer サービスの Pod、サービス、およびその他のコンポーネントを起動します。
  5. API Designer サービスが使用できることを確認するには、以下を実行します。

    1. Operators をクリックした後、Installed Operators をクリックします。
    2. Provided APIs 列で Apicurito CRD をクリックします。

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

  6. API Designer を開くには、以下を実行します。

    1. Networking > Routes を選択します。
    2. 正しいプロジェクトが選択されていることを確認してください。
    3. apicurito-service-ui 行の Location 列で、URL をクリックします。

      API Designer Web コンソールは、新しいブラウザータブで開きます。