Menu Close

第2章 Fuse Online 環境の設定変更

オンサイトで Fuse Online を OpenShift Container Platform (OCP) にインストールした後、Fuse Online 環境の設定を変更することができます。

詳細は以下のトピックを参照してください。

2.1. インストール後に変更可能な Fuse Online の設定

オンサイトで Fuse Online を OpenShift Container Platform (OCP) にインストールした後、機能を有効または無効にしたり、設定を変更することができます。以下の表は、変更可能な機能および設定、変更の影響、および変更手順の記載場所を表しています。

syndesis カスタムリソースへの変更によって syndesis-server が再度デプロイされた場合、新しいサーバーデプロイメントが OpenShift によって作成されます。新しいサーバーの準備が整うまで、最大 1 - 2 分ほどかかります。準備が整うまで Fuse Online コンソールを使用することはできません。新しいサーバーのデプロイ中も、稼働中のインテグレーションは稼働し続けます。新しいデプロイメントの準備が整ったら、新しいサーバーによってインテグレーションの状態がロードされます。syndesis-server Pod の状態が Running であれば Fuse Online コンソールを使用することができます。Fuse Online コンソールを更新すると、インテグレーション、コネクション、メッセージ、および稼働時間の値が表示されます。

重要

Data Virtualization はテクノロジープレビューの機能です。テクノロジープレビューの機能は、Red Hat の実稼働環境のサービスレベルアグリーメント (SLA) ではサポートされず、機能的に完全ではないことがあります。Red Hat では、これらについて実稼働環境での使用を推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストやフィードバックの提供を可能にするために提供されます。Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、https://access.redhat.com/ja/support/offerings/techpreview を参照してください。

機能/設定変更の影響詳細

3scale の検出

syndesis-server の再デプロイ。

3scale で API の検出を有効化する Fuse Online の設定

バックアップ

バックアップジョブを syndesis-operator に追加します。

Fuse Online 環境のバックアップ

Data Virtualization
(テクノロジープレビュー)

新しい syndesis-dv Pod を作成し、Fuse Online コンソールを更新します。

Fuse Online の設定に使用するカスタムリソース属性の説明

監視

新しい OpenShift リソースをインストールします。

Prometheus を使用した OCP での Fuse Online インテグレーションの監視

パブリック Fuse Online REST API エンドポイント

syndesis-public-oauthproxy Pod を作成します。

外部ツールによって使用される Fuse Online パブリック REST API の公開

インテグレーションをテストするための Todo アプリケーションの例

新しい todo Pod を作成します。

OCP で稼働している Fuse Online 環境へのサンプルアプリケーションの追加

外部 Maven リポジトリーの指定

syndesis-server を再デプロイします。

Fuse Online の設定に使用するカスタムリソース属性の説明

Fuse Online コンポーネントで使用できるメモリー

メモリーが変更されたコンポーネントを再度デプロイします。

許可される稼働中のインテグレーションの数

syndesis-server を再デプロイします。

2.2. Fuse Online の設定変更に関する一般的な手順

OCP にインストールされる Fuse Online 環境では、syndesis カスタムリソースを更新して設定を変更できます。変更を保存した後、構文が正しい場合は OpenShift によって syndesis-operator が更新されます。構文エラーがある場合は更新されません。

syndesis カスタムリソースの編集中、構文が正しい無効な設定を指定しないようにしてください。構文が正しい設定が無効であっても、更新された syndesis カスタムリソースが syndesis-operator によって使用されます。無効な設定を指定した場合、OpenShift の更新後でのみ判明します。更新中、OpenShift では無効な設定が削除されます。

前提条件

  • オンサイトで OCP に Fuse Online がインストールされている必要があります。
  • oc クライアントツールがインストール済みであり、Fuse Online がインストールされている OCP クラスターに接続されている必要があります。
  • Fuse Online の設定を変更するプロジェクトで Fuse Online をインストールする権限が必要です。
  • Fuse Online の設定に使用するカスタムリソース属性の説明」を読み、インストール後に変更可能な設定と、syndesis カスタムリソースを更新して設定変更を行う方法について理解する必要があります。

手順

  1. Fuse Online をインストールする権限を持つアカウントで OpenShift にログインします。以下に例を示します。

    oc login -u developer -p developer

  2. 設定を変更する Fuse Online 環境を実行している OpenShift プロジェクトに切り替えます。以下に例を示します。

    oc project my-fuse-online-project

  3. 任意手順:誤った内容を更新および保存した場合に備え、syndesis カスタムリソースに現在の設定のバックアップコピーを作成します。たとえば、以下のコマンドを実行すると、バックアップが syndesis_app_backup.yml ファイルに保存されます。

    oc get syndesis app -o yaml > syndesis_app_backup.yml

  4. 以下のコマンドを実行して、エディターで syndesis カスタムリソースを開きます。

    oc edit syndesis

  5. syndesis カスタムリソースを編集します。
  6. リソースを保存します。
  7. 2 - 3 分間待ち、syndesis-operatorsyndesis カスタムリソースへの更新を使用できることを確認します。

    1. 以下のコマンドを実行して、syndesis カスタムリソースの内容を表示します。

      oc describe syndesis/app

    2. 内容を確認します。

      syndesis カスタムリソースに必要な設定が含まれていない場合は、これを再度編集して有効な設定を指定します。

結果

syndesis カスタムリソースのほとんどの変更によって syndesis-operator がトリガーされ、Fuse Online (syndesis-server) が再デプロイされます。よって、OpenShift によって新しいサーバーデプロイメントが作成されます。新しいサーバーの準備が整うまで、最大 1 - 2 分ほどかかります。準備が整うまで Fuse Online コンソールを使用することはできません。新しいサーバーのデプロイ中も、稼働中のインテグレーションは稼働し続けます。新しいデプロイメントの準備が整ったら、新しいサーバーによってインテグレーションの状態がロードされます。以下の場合に、Fuse Online コンソールを再度使用できます。

  • syndesis-serverPod の状態が Running である場合。
  • Fuse Online コンソールを更新すると、インテグレーション、コネクション、メッセージ、および稼働時間の値が表示される場合。

syndesis カスタムリソースの変更によっては、Fuse Online 設定が更新されても syndesis-server の再デプロイメントは必要ないものがあります。以下に例を示します。

  • syndesis カスタムリソースを更新してバックアップを指定する場合、バックアップジョブが利用可能になるまで数秒かかります。
  • Fuse Online 設定を更新して Data Virtualization を有効にするには、Fuse Online コンソールのユーザーインターフェースを更新し、Data Virtualization Pod をデプロイする必要があります。通常、コンソールの更新には最大 10 秒かかりますが、Data Virtualization Pod のデプロイにかかる時間は多数の要因によって異なります。Fuse Online 環境で Data Virtualization が有効になっていることを確認するには、以下を行います。

    1. Fuse Online コンソールの左側のパネルで Data をクリックします。
    2. Data Virtualizations ページで、データビューを追加できるはずです。

各設定変更の影響については「インストール後に変更可能な Fuse Online の設定」を参照してください。

2.3. 3scale で API の検出を無効化する Fuse Online の設定

API プロバイダーインテグレーションを作成する場合、Red Hat 3scale でそのインテグレーションの API の検出を有効することがあります。デフォルトの動作では、API は 3scale の自動検出の対象になりません。検出を有効にするには、3scale ユーザーインターフェースの URL を指定する必要があります。

Fuse Online をインストールする前に 3scale で API の検出を有効にするよう Fuse Online を設定するには「Fuse Online の設定に使用するカスタムリソース属性の説明」を参照してください。

インストール後に syndesis カスタムリソースを更新すると、検出を有効にすることができます。本トピックでは、この手順を説明します。検出を有効にすると、リソースの更新時に接続されている OpenShift プロジェクトのみに適用されます。

3scale サービス検出を有効にすると、以下のようになります。

  • デフォルトの動作として、3scale は API プロバイダーインテグレーションをパブリッシュします。3scale が API プロバイダーインテグレーションをパブリッシュする場合は、以下のとおりです。

    • Fuse Online は、稼働している API プロバイダーインテグレーションの外部 URL を提供しません。
    • API には 3scale からのみアクセスできます。エンドポイントを公開するために 3scale の設定が必要です。詳細は、Red Hat 3scale API Management『Admin Portal Guide』の「Service Discovery」 を参照してください。
  • API プロバイダーインテグレーションの作成者は、そのインテグレーションの 3scale 検出を無効にすることができます。つまり、各 API プロバイダーインテグレーション作成者は、そのインテグレーションの API を検出可能にするかどうかを選択できます。

前提条件

  • オンサイトで OCP に Fuse Online がインストールされている必要があります。
  • oc クライアントツールがインストール済みであり、Fuse Online がインストールされている OCP クラスターに接続されている必要があります。
  • API の検出を有効にするプロジェクトで Fuse Online をインストールするパーミッションが必要です。

手順

  1. Fuse Online をインストールする権限を持つアカウントで OpenShift にログインします。以下に例を示します。

    oc login -u developer -p developer

  2. Fuse Online が稼働している OpenShift プロジェクトに切り替えます。このプロジェクトのみで検出を有効にします。以下に例を示します。

    oc project my-fuse-online-project

  3. syndesis カスタムリソースを編集します。

    1. 以下のコマンドを実行します。通常、エディターでリソースが開かれます。

      oc edit syndesis

    2. 3scale ユーザーインターフェースの URL に managementUrlFor3scale を設定し、リソースを編集します。結果は以下のようになります。

      spec:
        components:
          server:
            features:
              managementUrlFor3scale: https://3scale-admin.apps.mycluster.com
    3. リソースを保存します。
  4. 任意手順:切り替え先のプロジェクトで検出が有効になっていることを確認するには、以下のコマンドを実行します。

    oc describe dc/syndesis-server

    検出が有効な場合、OPENSHIFT_MANAGEMENT_URL_FOR3SCALE 環境変数がカスタムリソースで指定した URL に設定されていることがこのコマンドで出力されます。

結果

syndesis カスタムリソースに対するこの変更により、Fuse Online のインストールを担う syndesis-operatorsyndesis-server を再デプロイするようトリガーされます。切り替え先の OpenShift プロジェクトでは、新しいデフォルト動作として API が 3scale で検出の対象となります。

syndesis-server DeploymentConfig オブジェクトを編集して、OPENSHIFT_MANAGEMENT_URL_FOR3SCALE 環境変数を設定しないでください。syndesis-operator によって変更が元に戻るため、設定できません。syndesis-operator によって、Fuse Online は常に syndesis カスタムリソースのみに従ってデプロイされます。

2.4. 3scale で API の検出を無効化する Fuse Online の設定

API の 3scale 検出を有効化する Fuse Online の設定」で説明されている手順に従っている場合、各 API プロバイダーインテグレーションの作成者は、そのインテグレーションの API が検出可能かどうかを選択できます。場合によっては、インテグレーション API が 3scale では検出できないデフォルトの動作を再設定する必要になることがあります。たとえば、Fuse Online で API プロバイダーを編集およびテストする場合などです。このような場合、managementUrlFor3scale キーと値を指定する行がコメントアウトされるように Fuse Online の syndesis カスタムリソースを更新します。これにより、3scale による検出が無効になります。その後、検出可能な API でパブリッシュされた API プロバイダーインテグレーションを再パブリッシュします。

前提条件

  • オンサイトで OCP に Fuse Online がインストールされている必要があります。
  • 検出を無効にするプロジェクトで Fuse Online をインストールするパーミッションが必要です。
  • oc クライアントツールがインストール済みであり、Fuse Online がインストールされている OCP クラスターに接続されている必要があります。
  • 3scale 検出は、「API の 3scale 検出を有効化する Fuse Online の設定」で説明されているように OpenShift プロジェクトで有効にされている必要があります

手順

  1. Fuse Online をインストールする権限を持つアカウントで OpenShift にログインします。以下に例を示します。

    oc login -u developer -p developer

  2. 3scale の検出が有効になっている OpenShift プロジェクトに切り替えます。以下に例を示します。

    oc project my-fuse-online-project

  3. syndesis カスタムリソースを編集します。

    1. 以下のコマンドを実行します。通常、エディターでリソースが開かれます。

      oc edit syndesis

    2. managementUrlFor3scale キーおよび値を指定する行の最初にハッシュ記号 (#) を挿入して、リソースを編集します。これにより、行がコメントになり、検出が無効になります。結果は以下のようになります。

      spec:
        components:
          server:
            features:
            #  managementUrlFor3scale: https://3scale-admin.apps.mycluster.com
    3. リソースを保存します。

      これにより、syndesis カスタムリソースが更新されます。この更新により、OPENSHIFT_MANAGEMENT_URL_FOR3SCALE 環境変数が削除されます。syndesis カスタムリソースに対するこの変更により、Fuse Online のインストールを担う syndesis-operatorsyndesis-server を再デプロイするようトリガーされます。新しいデフォルト動作では、API が 3scale で検出の対象ではなくなります。

    syndesis-server DeploymentConfig オブジェクトを編集して、OPENSHIFT_MANAGEMENT_URL_FOR3SCALE 環境変数の設定を削除しないでください。syndesis-operator によって変更が元に戻るため、設定できません。syndesis-operator によって、Fuse Online は常に syndesis カスタムリソースのみに従ってデプロイされます。

  4. 先ほど検出を無効化したプロジェクトで作成された API プロバイダーインテグレーションで、検出が有効化されていたものがあれば、そのインテグレーションを再パブリッシュします。

    言い換えると、API プロバイダーインテグレーションが作成されたプロジェクトの検出が有効であるときに、そのインテグレーションの API の検出を無効にした場合は、この API プロバイダーインテグレーションを再パブリッシュする必要はありません。

結果

関連する OpenShift プロジェクトで作成された API プロバイダーインテグレーションの API が 3scale で検出できなくなります。

Fuse Online が関連するプロジェクトにある API プロバイダーインテグレーションをパブリッシュ (または再パブリッシュ) する場合、Fuse Online は API プロバイダーインテグレーションの操作を呼び出すための外部 URL を提供します。

2.5. OCP で稼働している Fuse Online 環境へのサンプルアプリケーションの追加

新しいユーザーが Fuse Online でのインテグレーションの作成方法を学べるよう、Fuse Online 環境にサンプルアプリケーションを追加することができます。To Do アプリケーションは、AMQ to REST API サンプルインテグレーションが想定どおりに機能することをユーザーが確認できるようにします。

Fuse Online を設定して、Fuse Online をインストールする前に ToDo アプリケーションを取得する場合は「Fuse Online の設定に使用するカスタムリソース属性の説明」を参照してください。

または、Fuse Online 環境に ToDo アプリケーションを追加せずに、サンプルアプリケーションが含まれる Fuse Online 評価環境 をリクエストすることもできます。新しいユーザーは「Fuse Online サンプルインテグレーションのチュートリアル」の手順にしたがって、サンプルインテグレーションを作成できます。

前提条件

  • オンサイトで OCP に Fuse Online がインストールされ、稼働している必要があります。
  • oc クライアントツールがインストール済みであり、Fuse Online がインストールされている OCP クラスターに接続されている必要があります。
  • クラスター管理者権限を持つユーザーは、該当ユーザーがクラスターでアクセス権限を持つプロジェクトに Fuse Online をインストールするための権限を付与済みである必要があります。
  • ユーザー名とパスワードを知っている Red Hat Developer のアカウントが必要です。https://developers.redhat.com に対して認証できるよう、インストールスクリプトによってこれらのクレデンシャルが要求されます。アカウントの作成に関する詳細は、「Red Hat レジストリーへのアクセスおよびその設定」を参照してください。

手順

  1. Fuse Online をインストールする権限を持つアカウントで OpenShift にログインします。以下に例を示します。

    oc login -u developer -p developer

  2. Fuse Online が稼働しているプロジェクトに切り替えます。以下に例を示します。

    oc project my-fuse-online-project

  3. syndesis カスタムリソースを編集します。

    1. 以下のコマンドを実行します。通常、エディターでリソースが開かれます。

      oc edit syndesis

    2. 以下の行がリソースにあることを確認します。必要に応じて編集します。

      spec:
        addons:
          todo:
            enabled: true
    3. リソースを保存します。

      この変更を syndesis カスタムリソースに保存すると、新しい todo Pod の作成が syndesis-operator によって引き起こされます。

次のステップ

AMQ to REST API サンプルインテグレーションの実装 を行って、Todo アプリケーションを使用します。