OpenShift Container Platform での Fuse Online のインストールと操作

1. Red Hat コンテナーイメージへの認証を設定する OpenShift シークレットを生成します。
2. OperatorHub からクラスターのプロジェクト (namespace) に Fuse Online Operator をインストールします。
3. 任意で、コネクションおよびインテグレーションの定義を永続化するために外部データベースを含める場合は、OpenShift シークレットを作成します。

4. Fuse Online インスタンスを OpenShift 4.x プロジェクトに追加します。

   任意で、カスタムリソースを編集して、1 つ以上のアドオン機能を有効にしたり、1 つ以上のカスタム設定を実装したりします。

5. 必要に応じて、他の開発者ユーザーに Fuse Online Web コンソールにアクセスできるようにパーミッションを付与します。

手順

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

   oc login -u developer -p developer

2. Fuse Online をインストールする Open Shift クラスターで使用可能で、以下の設定オプションの値を定義する postgreSQL データベースを作成します。

   • 接続ユーザー名
   • データベース名

   • データベースのパスワード

     次の例では、OpenShift がデフォルトで提供する PostgreSQL テンプレートの 1 つを使用しています。

     注記: 開発またはテスト目的には PostgreSQL 一時 (postgresql-ephemeral) テンプレートのみを使用します。実稼働環境の場合は、PostgreSQL (postgresql) テンプレートを使用します。

     oc new-app postgresql-ephemeral -p POSTGRESQL_USER=syndesis -p POSTGRESQL_PASSWORD=exdb-pwd -p POSTGRESQL_DATABASE=syndesisdb

     このコマンドは、URL など、Fuse Online を設定するときに必要なデータベースに関する情報を返します。

     データベースの作成については、PostgreSQL topic in the OpenShift documentation を参照してください。

3. 以下の内容を含むリソースファイル (例: my-fuse-online-secret-cr.yml) を作成して、保存します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: syndesis-global-config
     namespace: my-fuse-online-project
   type: Opaque
   stringData:
     POSTGRESQL_PASSWORD: exdb-pw

   my-fuse-online-project を、外部データベーであるスを指定する Fuse Online 環境をインストールする予定である OpenShift プロジェクトの名前に置き換えます。

   exdb-pw を手順 2 のパスワードに置き換えます。Fuse Online は、外部データベースにアクセスするためのパスワードとして使用します。stringData は、パスワードの値を base64 でエンコードされた値 (変換を行わないように) に変換することに注意してください。

   OpenShift シークレットについての詳細は シークレット を参照してください。

4. 以下のように、シークレットをクラスターに追加します。

   oc apply -f my-fuse-online-secret-cr.yml

   OpenShift クラスターでは、外部データベースを指定するカスタムリソースとインストールされた Fuse Online 環境で syndesis-global-config シークレットを利用できます。

5. シークレット (ステップ 4) の YAML ファイルで指定した my-fuse-online-project プロジェクトに Fuse Online をインストールします。

   • OCP 3.11 の場合は、Fuse Online をインストールする前にデフォルトのカスタムリソースファイルを編集 の手順にしたがいます。

   • OCP 4.6 以降の場合は、Installing the Fuse Online Operator from the OperatorHub の手順に従います。Adding a Fuse Online instance to an OpenShift 4.x project において、Fuse Online をデプロイする前にカスタムリソースを編集して、外部データベースの使用を指定します。以下に例を示します。

     apiVersion: syndesis.io/v1alpha1
     kind: Syndesis
     metadata:
       name: app
     spec:
       components:
         database:
           externalDbURL: "postgresql://syndesis-external-db:5432"
           user: db-user-name
           name: db-name

   • syndesis-external-db:5432 を外部 PostgreSQL データベースのホスト名およびポートに置き換えます。
   • db-user-name をコネクションユーザー名に置き換えます。
   • db-name をデータベースの名前に置き換えます。

1. OpenShift プロジェクト (namespace) にシークレットを作成し、Fuse Online Operator が必要なインストールテンプレートにアクセスできるように、registry.redhat.io との認証を設定します。
2. Fuse Online Operator を OpenShift プロジェクト (namespace) にインストールします。Operator はインストール後に、選択された namespace で実行されます。
3. インストールされた Operator から Fuse Online のインスタンスを作成します。デフォルト設定でインスタンスを作成するか、インスタンスのカスタムリソースを編集してインスタンスをカスタマイズすることができます。続いて、提供された URL から Fuse Online にアクセスできます。

1. クラスター管理者権限を持つユーザーが、以下を実行します。

   1. インストールスクリプトと関連ファイルをダウンロードします。
   2. OpenShift oc クライアントツールコマンドを使用して、クラスターレベルでカスタムリソース定義(CRD)を登録します。
   3. OpenShift oc クライアントツールコマンドを使用して、1 つ以上のユーザーにプロジェクトで Fuse Online をインストールする権限を付与します。

2. Fuse Online をインストールする権限が付与されたユーザーは、Fuse Online をインストールする各 OpenShift プロジェクトに対して以下を行います。

   1. デフォルトの Fuse Online 環境またはカスタマイズされた Fuse Online 環境をインストールするかどうかを決定します。カスタマイズされた Fuse Online 環境では、1 つ以上のアドオン機能を有効にすることができ、1 つ以上のカスタム設定を実装できます。
   2. インストールスクリプトと関連ファイルをダウンロードします。
   3. 任意手順:カスタマイズされた Fuse Online 環境が必要な場合は、Fuse Online ダウンロードパッケージで提供される default-cr.yml ファイルを編集します。
   4. 任意手順:コネクションおよびインテグレーション定義を永続化するための外部データベースが必要な場合は、OpenShift シークレットを作成します。
   5. インストールスクリプトを実行します。
   6. Fuse Online が稼働中であることを確認します。

手順

1. 以下の場所から Fuse Online インストールスクリプトが含まれるパッケージをダウンロードします。

   https://github.com/syndesisio/fuse-online-install/releases/tag/1.13

2. ファイルシステムの任意の場所で、ダウンロードしたアーカイブを展開します。fuse-online-install-1.13 ディレクトリーには、Fuse Online をインストールするためのスクリプトとサポートファイルが含まれます。

3. クラスター管理者権限を持つアカウントで OpenShift にログインします。以下に例を示します。

   oc login -u admin -p adminpwd

4. 以下のコマンドを実行して、このクラスターにすでに登録されているカスタムリソース定義を一覧表示し、適切に接続されたことを確認します。

   oc get crd

   エラーメッセージが表示されなければ、正しく接続されています。

5. fuse-online-install-1.13 ディレクトリーに移動して以下のコマンドを実行し、クラスターレベルでカスタムリソース定義を登録します。

   bash install_ocp.sh --setup

6. 以下のコマンドを再度実行して、登録が成功したことを確認します。

   oc get crd

   登録したカスタムリソース定義の出力一覧には、syndesis が含まれているはずです。

7. Fuse Online をインストールする各プロジェクトで、ユーザーにインストールできる権限を付与します。各プロジェクトに対して以下を行います。

   1. ユーザーが Fuse Online をインストールするプロジェクトに切り替えます。以下に例を示します。

      oc project fuse-online-project

   2. そのプロジェクトに Fuse Online をインストールする権限をユーザーに付与します。たとえば、以下のコマンドは、developer ユーザーに Fuse Online のインストール権限を付与します。このコマンドの実行後、developer ユーザーは現在のプロジェクト fuse-online-project に Fuse Online をインストールできます。

      bash install_ocp.sh --grant developer

      Fuse Online のインストール権限を割り当てる OpenShift プロジェクトごとに、上記の 2 つのコマンドを繰り返します。ユーザーは、クラスターの複数のプロジェクトに Fuse Online をインストールできます。これを有効にするには、別のプロジェクトに切り替え、以下のように同じユーザーを指定します。

      oc project another-fuse-online-project
bash install_ocp.sh --grant developer

手順

1. Fuse Online のインストールスクリプトが含まれるパッケージをダウンロードしていない場合は、以下を行います。

   1. 以下の場所からダウンロードします。

      https://github.com/syndesisio/fuse-online-install/releases/tag/1.13

   2. ファイルシステムの任意の場所で、ダウンロードしたアーカイブを展開します。fuse-online-install-1.13 ディレクトリーには、Fuse Online をインストールするためのスクリプトとサポートファイルが含まれます。

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

   oc login -u developer -p developer

3. エディターで fuse-online-install-1.13/default-cr.yml ファイルを開きます。
4. 必要な機能を有効にし、必要なパラメーターを設定するために、Default-cr.yml ファイルを編集します。指定の必要がある項目を判断するには、Fuse Online の設定に使用するカスタムリソース属性の説明 を参照してください。
5. default-cr.yml ファイルを保存します。

手順

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

   oc login -u developer -p developer

2. Fuse Online をインストールする Open Shift クラスターで使用可能で、以下の設定オプションの値を定義する postgreSQL データベースを作成します。

   • 接続ユーザー名
   • データベース名

   • データベースのパスワード

     次の例では、OpenShift がデフォルトで提供する PostgreSQL テンプレートの 1 つを使用しています。

     注記: 開発またはテスト目的には PostgreSQL 一時 (postgresql-ephemeral) テンプレートのみを使用します。実稼働環境の場合は、PostgreSQL (postgresql) テンプレートを使用します。

     oc new-app postgresql-ephemeral -p POSTGRESQL_USER=syndesis -p POSTGRESQL_PASSWORD=exdb-pwd -p POSTGRESQL_DATABASE=syndesisdb

     このコマンドは、URL など、Fuse Online を設定するときに必要なデータベースに関する情報を返します。

     データベースの作成については、PostgreSQL topic in the OpenShift documentation を参照してください。

3. 以下の内容を含むリソースファイル (例: my-fuse-online-secret-cr.yml) を作成して、保存します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: syndesis-global-config
     namespace: my-fuse-online-project
   type: Opaque
   stringData:
     POSTGRESQL_PASSWORD: exdb-pw

   my-fuse-online-project を、外部データベーであるスを指定する Fuse Online 環境をインストールする予定である OpenShift プロジェクトの名前に置き換えます。

   exdb-pw を手順 2 のパスワードに置き換えます。Fuse Online は、外部データベースにアクセスするためのパスワードとして使用します。stringData は、パスワードの値を base64 でエンコードされた値 (変換を行わないように) に変換することに注意してください。

   OpenShift シークレットについての詳細は シークレット を参照してください。

4. 以下のように、シークレットをクラスターに追加します。

   oc apply -f my-fuse-online-secret-cr.yml

   OpenShift クラスターでは、外部データベースを指定するカスタムリソースとインストールされた Fuse Online 環境で syndesis-global-config シークレットを利用できます。

5. シークレット (ステップ 4) の YAML ファイルで指定した my-fuse-online-project プロジェクトに Fuse Online をインストールします。

   • OCP 3.11 の場合は、Fuse Online をインストールする前にデフォルトのカスタムリソースファイルを編集 の手順にしたがいます。

   • OCP 4.6 以降の場合は、Installing the Fuse Online Operator from the OperatorHub の手順に従います。Adding a Fuse Online instance to an OpenShift 4.x project において、Fuse Online をデプロイする前にカスタムリソースを編集して、外部データベースの使用を指定します。以下に例を示します。

     apiVersion: syndesis.io/v1alpha1
     kind: Syndesis
     metadata:
       name: app
     spec:
       components:
         database:
           externalDbURL: "postgresql://syndesis-external-db:5432"
           user: db-user-name
           name: db-name

   • syndesis-external-db:5432 を外部 PostgreSQL データベースのホスト名およびポートに置き換えます。
   • db-user-name をコネクションユーザー名に置き換えます。
   • db-name をデータベースの名前に置き換えます。

手順

1. Fuse Online のインストールスクリプトが含まれるパッケージをダウンロードしていない場合は、以下を行います。

   1. 以下の場所からダウンロードします。

      https://github.com/syndesisio/fuse-online-install/releases/tag/1.13

   2. ファイルシステムの任意の場所で、ダウンロードしたアーカイブを展開します。fuse-online-install-1.13 ディレクトリーには、Fuse Online をインストールするためのスクリプトとサポートファイルが含まれます。

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

   oc login -u developer -p developer

3. 以下のように、Fuse Online をインストールする OpenShift プロジェクトに切り替えます。

   oc project my-fuse-online-project

   または、インストールスクリプトの実行時に --project my-fuse-online-project のように指定することもできます。

4. インストールスクリプトをダウンロードしたディレクトリーで、インストールスクリプトを実行します。

   bash install_ocp.sh

   インストールスクリプトのオプションの詳細については bash install_ocp.sh --help コマンドを実行してください。

5. Fuse Online をインストールするために syndesis-operator によって使用された syndesis カスタムリソースに、必要な内容が適切に含まれていることを確認します。

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

      oc describe syndesis/app

   2. カスタムリソースの内容を確認します。

      含まれていない更新がある場合は、カスタムリソースに構文エラーがある可能性があります。有効なカスタムリソースを定義するには、Fuse Online をアンインストールし、再インストールする必要があります。OCP プロジェクトからの Fuse Online のアンインストール を参照してください。

6. インストールに成功したことを確認します。

   1. https://openshift-route で OpenShift OAuth プロキシーログインページを表示します。

      インストールスクリプトによる OpenShift ルートの算出を選択した場合、実行の最後あたりで算出されたルートが表示されます。openshift-route をスクリプトが提供する値に置き換えます。

      default-cr.yml ファイルを編集して Fuse Online に routeHostname を指定した場合は、openshift-route を指定したルートに置き換えます。

   2. OpenShift コンソールにログインしていない場合は、ログインページが表示されます。OpenShift ユーザー名およびパスワードを入力してログインします。

   Fuse Online のホームページが、すぐに、もしくは OpenShift コンソールへのログイン後に表示されます。

手順

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/app

   注記: この手順では、エディターでカスタムリソースファイルを開き、設定する方法を説明します。この他にも、oc patch コマンドを使用して、カスタムリソースを編集することもできます。

5. 必要に応じて syndesis カスタムリソースを編集します。

6. リソースを保存します。

   編集が適用されるオブジェクトのタイプに応じて、更新により syndesis-operator がトリガーされ、リソースの保存時に Fuse Online コンポーネントを再デプロイします。

7. 2 - 3 分間待ってから、syndesis カスタムリソースが正しく更新されていることを確認します。

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

      oc describe syndesis/app

   2. 内容を確認します。

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

手順

1. 以下の構文で oc patch コマンドを使用して 許容 (Toleration) を設定します。Fuse Online インフラストラクチャーコンポーネントのデプロイメントには infraScheduling を、Fuse Online インテグレーションのデプロイメントには integrationScheduling を指定します。

   oc patch syndesis/app --type=merge -p '{"spec":{"infraScheduling"|"infraScheduling":{"tolerations":[{"key":"_value1_","operator":"_value2_","effect":"_value3_"},{"key":"_value4_","operator":"_value5_","effect":"_value6_"}]}}}'

   たとえば、以下のコマンドは、Fuse Online インフラストラクチャーコンポーネントに許容を追加します。

   oc patch syndesis/app --type=merge -p '{"spec":{"infraScheduling":{"tolerations":[{"key":"tol_1","operator":"Equal","effect":"NoSchedule"},{"key":"tol_2","operator":"Equal","value":"value2","effect":"NoSchedule"}]}}}'

2. 以下の構文で oc patch コマンドを使用して、ノードのアフィニティー を設定します。Fuse Online インフラストラクチャーコンポーネントのデプロイメントには infraScheduling を、Fuse Online インテグレーションのデプロイメントには integrationScheduling を指定します。

    oc patch syndesis/app --type=merge  -p '{"spec":{"infraScheduling"|"infraScheduling":{"affinity":{"nodeAffinity":{"preferredDuringSchedulingIgnoredDuringExecution":[{"weight":_value1_,"preference":{"matchExpressions":[{"key":"_value1_","operator":"_value2_","values":["_value3_","_value4_"]}]}}]}}}'

   たとえば、以下のコマンドは nodeAffinity を Fuse Online インフラストラクチャーコンポーネントとインテグレーションの両方に設定します。

    oc patch syndesis/app --type=merge  -p '{"spec":{"infraScheduling":{"affinity":{"nodeAffinity":{"preferredDuringSchedulingIgnoredDuringExecution":[{"weight":11,"preference":{"matchExpressions":[{"key":"_affinity","operator":"In","values":["foo","bar"]}]}}]}}},"integrationScheduling":{"affinity":{"nodeAffinity":{"preferredDuringSchedulingIgnoredDuringExecution":[{"weight":22,"preference":{"matchExpressions":[{"key":"my_affinity2","operator":"In","values":["foo","bar"]}]}}]}}}}}'

3. 設定を削除するには、以下のコマンド例のように、oc patch コマンドで remove オプションを使用します。

   • 以下のコマンド例は、Fuse Online インテグレーションの nodeAffinity から preferredDuringSchedulingIgnoredDuringExecution 設定を削除します。

     oc patch syndesis/app --type=json -p '[{"op": "remove", "path": "/spec/integrationScheduling/affinity/nodeAffinity/preferredDuringSchedulingIgnoredDuringExecution" }]'

   • 以下の例では、Fuse Online インフラストラクチャーコンポーネントから許容を削除します。

     oc patch syndesis/app --type=json -p '[{"op": "remove", "path": "/spec/infraScheduling/tolerations" }]'

手順

1. エディターでカスタムリソースを開きます。

   Fuse Online がすでにインストールされている場合は、Fuse Online の設定変更に関する一般的な手順 の手順にしたがって、カスタムリソースを開きます。

   Fuse Online がインストールされていない場合は、OCP のバージョンに応じて、以下の手順にしたがってカスタムリソースを開きます。

   • OCP 4.x の場合: Fuse Online インスタンスを OpenShift 4.x プロジェクトに追加
   • OCP 3.11 の場合: Fuse Online をインストールする前にデフォルトのカスタムリソースファイルを編集

2. syndesis-server および syndesis-meta コンポーネントの場合は、Java Options (javaOptions) パラメーターを設定し、HTTP プロキシーホストおよびポートの値を指定します。syndesis-server および syndesis-meta に同じ HTTP プロキシー値を使用します。

   以下に例を示します。

   spec:
     components:
       server:
         javaOptions:
   -Dhttp.proxyHost=10.0.0.100 -Dhttp.proxyPort=8800
   
       meta:
         javaOptions:
   -Dhttp.proxyHost=10.0.0.100 -Dhttp.proxyPort=8800

3. Fuse Online インテグレーションでは、Maven 引数 (additionalArguments) パラメーターを設定します。以下に例を示します。

   spec:
     components:
       server:
         features:
           maven:
             additionalArguments: "-Dhttp.proxy=10.0.0.100 -Dhttp.proxyPort=8800"

4. カスタムリソースを保存します。

   Fuse Online がすでにインストールされている場合、手順 2 の javaOptions の更新に応じて syndesis-server Pod が再デプロイされます。

5. HTTP プロキシーを使用する稼働中のインテグレーションを再パブリッシュします。

   1. Fuse Online で、更新するインテグレーションを選択します。
   2. Edit を選択します。
   3. Publish を選択します。

手順

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. addons:todo:enabled フィールドを true に変更して、カスタムリソースを編集します。

      spec:
        addons:
          todo:
            enabled: true

   3. リソースを保存します。

      この変更を syndesis カスタムリソースに保存すると、syndesis-operator による新しい todo Pod の作成と、syndesis-server および syndesis-db Pod の再デプロイがトリガーされます。

手順

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

   oc login -u admin -p admin-password

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

   oc project my-fuse-online-project

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

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

      oc edit syndesis

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

      components:
        server:
          features:
            auditing: true

4. リソースを保存します。

   syndesis カスタムリソースで監査機能を有効にすると、稼働中の syndesis-server 設定を再読み込みし、Fuse Online は Fuse Online コンポーネントに関連する変更のロギングを開始します。

5. Fuse Online 監査ログメッセージを表示するには、次のコマンドを入力します。

手順

1. 既存の openshift-monitoring 設定がある場合は、手順 2 に進みます。

   それ以外の場合には、ユーザーワークロードモニターリングオプションを true に設定する openshift-monitoring 設定を作成し、手順 3 に進みます。

   oc apply -f - <<EOF
   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
      enableUserWorkload: true
   EOF

2. 既存の openshift-monitoring 設定がある場合:

   1. 既存の openshift-monitoring 設定をチェックして、ユーザーワークロードモニターリング オプションが true に設定されるかどうかを判別します。

      oc get -n openshift-monitoring cm/cluster-monitoring-config -ojsonpath='{.data.config\.yaml}'

      結果が enableUserWorkload: true の場合、ユーザーワークロードモニターリング オプションは true に設定されます。ステップ 3 に進みます。

      結果に他の設定が表示される場合には、次の手順に進み、ConfigMap を編集してユーザーワークロードの監視を有効にします。

   2. 以下のようにエディターで ConfigMap ファイルを開きます。

      oc -n openshift-monitoring edit cm/cluster-monitoring-config

   3. enableUserWorkload を true に設定します。以下に例を示します。

      apiVersion: v1
      kind: ConfigMap
      metadata:
        name: cluster-monitoring-config
        namespace: openshift-monitoring
      data:
        config.yaml: |
         enableUserWorkload: true

   4. ConfigMap ファイルを保存します。

3. 以下のコマンドを使用して、openshift-user-workload-monitoring namespace の Pod のステータスを確認します。

   oc -n openshift-user-workload-monitoring get pods -w

   Pod のステータスが Running になるまで待機します。以下に例を示します。

   prometheus-operator-5d989f48fd-2qbzd   2/2     Running
   prometheus-user-workload-0             5/5     Running   prometheus-user-workload-1             5/5     Running
   thanos-ruler-user-workload-0           3/3     Running
   thanos-ruler-user-workload-1           3/3     Running

4. Prometheus で Fuse Online のアラートルールが有効になっていることを確認します。

   1. 内部 prometheus インスタンスにアクセスします。

      oc port-forward -n openshift-user-workload-monitoring pod/prometheus-user-workload-0 9090

   2. ブラウザーを開いて localhost:9090 にアクセスします。
   3. Status> Targets の順に選択します。3 つの syndesis エンドポイントが表示されるはずです。
   4. CTRL-C を押して、port-forward プロセスを終了します。
5. OperatorHub から、Grafana Operator を選択した namespace (例:grafana-middleware namespace) にインストールします。

6. クラスターロールとクラスターロールのバインディングを追加して、grafana-operator がノードおよび namespace を一覧表示できるようにします。

   1. grafana-operator Web サイトからクラスターロール YAML ファイルをダウンロードします。

      curl https://raw.githubusercontent.com/grafana-operator/grafana-operator/master/deploy/cluster_roles/cluster_role_grafana_operator.yaml > tmp_role.yaml

   2. grafana-operator のクラスターパーミッションを追加して、他の namespace およびノードを読み取ります。

      cat <<EOF >> tmp_role.yaml
        - apiGroups:
            - ""
          resources:
            - namespaces
            - nodes
          verbs:
            - get
            - list
            - watch
      EOF

      oc apply -f tmp_role.yaml

      oc apply -f - <<EOF
      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRoleBinding
      metadata:
        name: grafana-operator
      roleRef:
        name: grafana-operator
        kind: ClusterRole
        apiGroup: ""
      subjects:
        - kind: ServiceAccount
          name: grafana-operator-controller-manager
          namespace: grafana-middleware
      EOF

7. DASHBOARD_NAMESPACES_ALL 環境変数を使用して namespace を制限することで、grafana-operator が他の namespace から Grafana ダッシュボードを読み取れるようにします。

   oc -n grafana-middleware patch subs/grafana-operator --type=merge -p '{"spec":{"config":{"env":[{"name":"DASHBOARD_NAMESPACES_ALL","value":"true"}]}}}'

8. grafana Pod が再作成されていることを確認します。

   oc -n grafana-middleware get pods -w

9. 必要に応じて、grafana-operator ログを表示します。

   oc -n grafana-middleware logs -f `oc -n grafana-middleware get pods -oname|grep grafana-operator-controller-manager` -c manager

10. Grafana カスタムリソース を追加して、以下のように Grafana サーバー Pod を起動します。

    oc apply -f - <<EOF
    apiVersion: integreatly.org/v1alpha1
    kind: Grafana
    metadata:
      name: grafana-middleware
      namespace: grafana-middleware
    spec:
      config:
        auth:
          disable_signout_menu: true
        auth.anonymous:
          enabled: true
        log:
          level: warn
          mode: console
        security:
          admin_password: secret
          admin_user: root
      dashboardLabelSelector:
      - matchExpressions:
        - key: app
          operator: In
          values:
          - grafana
          - syndesis
      ingress:
        enabled: true
    EOF

11. grafana-operator がモニターリング情報を読み取ることを許可します。

    oc -n grafana-middleware adm policy add-cluster-role-to-user cluster-monitoring-view -z grafana-serviceaccount

12. GrafanaDatasource を追加して、thanos-querier をクエリーします。

    oc apply -f - <<EOF
    apiVersion: integreatly.org/v1alpha1
    kind: GrafanaDataSource
    metadata:
      name: prometheus-grafanadatasource
      namespace: grafana-middleware
    spec:
      datasources:
        - access: proxy
          editable: true
          isDefault: true
          jsonData:
            httpHeaderName1: 'Authorization'
            timeInterval: 5s
            tlsSkipVerify: true
          name: Prometheus
          secureJsonData:
            httpHeaderValue1: "Bearer $(oc -n grafana-middleware serviceaccounts get-token grafana-serviceaccount)"
          type: prometheus
          url: "https://$(oc get route thanos-querier -n openshift-monitoring -ojsonpath='{.spec.host}')"
      name: prometheus-grafanadatasource.yaml
    EOF

13. grafana サーバーログを表示します。

    oc logs -f `oc get pods -l app=grafana -oname`

14. grafana URL にアクセスし、Fuse Online ダッシュボードを表示するには、以下を実行します。

    echo "https://"$(oc -n grafana-middleware get route/grafana-route -ojsonpath='{.spec.host}')

    Grafana コンソールの左側のパネルで、検索ボタンをクリックします。各 Syndesis インスタンスのダッシュボードを含むフォルダー (OCP namespace 名) が表示されます。

    • Fuse Online インテグレーションでは、Integration - Camel を選択します。このダッシュボードには、Apache Camel インテグレーションアプリケーションによって公開される標準メトリクスが表示されます。

    • Fuse Online インフラストラクチャーコンポーネントでは、以下のインフラストラクチャーダッシュボードのいずれかを選択します。

      Infrastructure - DB

      Fuse Online の Postgres インスタンスに関連するメトリクスを表示します。

      Infrastructure - JVM

      syndesis-meta または syndesis-server アプリケーションの実行中の JVM に関するメトリクスを表示します。ダッシュボードの上部にある Application ドロップダウンリストから、監視するアプリケーションを選択します。

      Infrastructure - REST APIs

      request throughput および latency などの Fuse Online インフラストラクチャー API エンドポイントに関連するメトリクスを表示します。ダッシュボードの上部にある Application ドロップダウンリストから、監視するアプリケーションを選択します。

手順

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

   oc login -u developer -p developer

2. バックアップを設定する Fuse Online 環境を稼働中または稼働予定の OpenShift プロジェクトに切り替えます。以下に例を示します。

   oc project my-fuse-online-project

3. OpenShift シークレットを作成します。コマンドラインで以下を行います。

   • 以下のコマンド形式で syndesis-backup-s3 を指定します。

   • AWS 変数を、AWS アクセスキー、AWS シークレットキー、バケットがある AWS リージョン、およびバケットの名前に置き換えます。

     以下のコマンド形式を使用してシークレットを作成します。

     oc create secret generic syndesis-backup-s3 \
     --from-literal=secret-key-id="my-aws-access-key" \
     --from-literal=secret-access-key="my-aws-secret-key" \
     --from-literal=region="aws-region" \
     --from-literal=bucket-name="aws-bucket-name"

     このシークレットは、バックアップジョブの実行中に存在する必要があります。

4. Fuse Online がインストールされていない場合は、default-cr.yml ファイルを編集してバックアップを有効にする必要があります。Fuse Online をインストールする前に syndesis カスタムリソースファイルを編集 を参照してください。Fuse Online のインストール後、カスタムリソースに指定したスケジュールに応じてバックアップジョブが発生します。

   Fuse Online が稼働している場合、syndesis カスタムリソースを編集する必要があります。

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

      oc edit syndesis

   2. 以下を spec: の下に追加します。

      backup:
        schedule: my-backup-interval

      my-backup-interval をバックアップの間隔に置き換えます。以下を参照して、バックアップの間隔を指定する方法を判断してください。

      • cron を使用して事前設定されたスケジュール (英語)

      • cron で設定する間隔 (英語)

        間隔の前に @ 記号を指定しないでください。たとえば、毎日バックアップを行うよう設定するには、カスタムリソースに以下のような記述が含まれるようにします。

        apiVersion: syndesis.io/v1beta1
        kind: Syndesis
        metadata:
          name: app
        spec:
          backup:
            schedule: daily

5. ファイルを保存します。

   これにより、バックアップジョブが syndesis-operator に追加されます。

手順

1. Amazon S3 から必要なバックアップファイルをダウンロードします。詳細は、AWS ドキュメントの S3 バケットからオブジェクトをダウンロードする方法 を参照してください。

2. zip ファイルの内容を展開します。たとえば、以下のコマンドラインを実行すると、7.6-2020-03-15-23:30:00.zip ファイルが展開され、内容が /tmp/fuse-online-backup フォルダーにコピーされます。

   unzip 7.6-2020-03-15-23:30:00.zip -d /tmp/fuse-online-backup

3. 以下の例のように、Fuse Online データベースをデコードします。

   base64 -d /tmp/fuse-online-backup/syndesis-db.dump > /tmp/fuse-online-backup/syndesis-db

4. 新しい Fuse Online 環境を稼働している OpenShift プロジェクトに切り替えます。たとえば、新しい Fuse Online 環境が my-fuse-online-project にある場合は、以下のコマンドを実行します。

   oc project my-fuse-online-project

   これ以降の手順では、新しい Fuse Online 環境が含まれるプロジェクトに切り替えたことを想定します。

5. データベース Pod の名前を取得します。

   復元された Fuse Online 環境で、提供された内部 PostgreSQL データベースが使用される場合は、以下のコマンドを実行し、データベース Pod の名前を取得します。

   oc get pods -l deploymentconfig=syndesis-db -o jsonpath='{.items[*].metadata.name}'

   復元された Fuse Online 環境で外部データベースが使用される場合、そのデータベースの Pod の名前を取得する方法を知っている必要があります。

   これ以降のコマンドでは、DATABASE_POD_NAME を復元された Fuse Online 環境のデータベース Pod の名前に置き換えます。

6. データベースにアクセスしているコンポーネントをスケールダウンします。

   1. syndesis-operator をスケールダウンし、他のコンポーネントをスケールダウンできるようにします。

      oc scale deployment syndesis-operator --replicas 0

   2. syndesis-server および syndesis-meta コンポーネントをスケールダウンします。

      oc scale dc syndesis-server --replicas 0
oc scale dc syndesis-meta --replicas 0

7. データベースのバックアップファイルを Fuse Online データベース Pod に送信します。

   oc cp /tmp/fuse-online-backup/syndesis-db DATABASE_POD_NAME:/tmp/syndesis-db

8. Fuse Online データベース Pod でリモートシェルセッションを開きます。

   oc rsh DATABASE_POD_NAME

9. 以下のコマンドを実行して Fuse Online データベースを復元します。

   psql コマンドによってデータベースのパスワードが要求され、復元された Fuse Online 環境で提供された内部 PostgreSQL データベースが使用される場合は、syndesis-db デプロイメント設定の POSTGRESQL_PASSWORD 環境変数でパスワードを確認できます。復元された Fuse Online 環境で外部データベースが使用される場合、パスワードを知っている必要があります。

   cd /tmp
   psql -c 'DROP database if exists syndesis_restore'
   psql -c 'CREATE database syndesis_restore'
   pg_restore -v -d syndesis_restore /tmp/syndesis-db
   psql -c "SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE datname = 'syndesis'"
   psql -c 'DROP database if exists syndesis'
   psql -c 'ALTER database syndesis_restore rename to syndesis'

   Fuse Online が復元されるはずです。RSH セッションを終了できます。

   exit

10. Fuse Online コンポーネントをスケールアップします。

    oc scale deployment syndesis-operator --replicas 1

    syndesis-operator を 1 にスケールアップすると、スケールダウンされた他の Pod がスケールアップされます。スケールアップされない場合は手作業でスケールアップできます。

    oc scale dc syndesis-server --replicas 1
oc scale dc syndesis-meta --replicas 1

11. サーバーは復元された各インテグレーションを開始しようとしますが、最初にコネクションを更新する必要があります。したがって、復元されたインテグレーションが稼働していないことを確認します。

    1. Fuse Online コンソールルートを取得します。

       echo "https://$(oc get route/syndesis -o jsonpath='{.spec.host}' )"

    2. Fuse Online をインストールする権限を持つ OpenShift ユーザーアカウントで、Fuse Online コンソールにログインします。
    3. インテグレーションのリストを表示し、すべてのインテグレーションが停止したことを確認します。稼働しているインテグレーションがある場合は停止します。

12. パスワードのある各コネクションを更新し、この Fuse Online 環境の正しいパスワードを適用します。以下の手順は、提供された PostgresDB コネクションでこの作業を行う方法になります。

    1. この復元された Fuse Online 環境が稼働しているプロジェクトの OpenShift コンソールで、PostgresDB コネクションのパスワードを取得します。syndesis-db では、パスワードは環境変数にあります。
    2. Fuse Online コンソールでコネクションを表示します。
    3. PostgresDB コネクションを編集します。
    4. PostgresDB コネクションのコネクション詳細で、取得したパスワードを Password フィールドに貼り付けます。

13. 各インテグレーションで Configuration Required が表示されないことを確認します。表示される場合は、インテグレーションを編集して問題を解決します。インテグレーションのすべてのステップが正しいければ、インテグレーションをパブリッシュします。

    Build ステップの直後に、インテグレーションが Stopped 状態にロールバックされ続ける場合は、デプロイメントを削除して、設定が必要ないことを確認し、再度インテグレーションのパブリッシュを試行します。

    ログに記録された以下のメッセージは、無視しても問題はありません。

    Error performing GET request to https://syndesis-my-fuse-online-project.my-cluster-url/api/v1/metrics/integrations

手順

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

   oc login -u developer -p developer

2. アンインストールする Fuse Online 環境を実行している OpenShift プロジェクトに切り替えます。以下に例を示します。

   oc project my-fuse-online-project

3. Fuse Online インフラストラクチャーを削除します。

   oc delete syndesis app

4. syndesis-operator DeploymentConfig および ImageStream リソースを削除します。

   oc delete deployment/syndesis-operator
oc delete is/syndesis-operator

手順

1. クラスターの管理者権限を持つアカウントで OpenShift にログインします。以下に例を示します。

   oc login -u admin -p admin

   クラスターの管理者権限は、syndesis-operator grant コマンドにのみ必要ですが、クラスター管理者がすべての手順を実行することを想定します。

2. Fuse Online が稼働している OpenShift プロジェクトに切り替えます。このプロジェクトでのみパブリック API を公開します。以下に例を示します。

   oc project fuse-online-north

3. ロールを syndesis-public-oauthproxy サービスアカウントに付与します。OpenShift プロジェクトでは、このサービスアカウントを使用して OAuth プロキシーサービスを実行します。クラスターの管理権限を持つユーザーアカウントを指定します。以下に例を示します。

   syndesis-operator grant --user developer

   このコマンドは、クラスターロールとクラスターのロールバインディングを作成し、これを syndesis-public-oauthproxy サービスアカウントに割り当てます。ClusterRoleBinding は、API を公開する OpenShift プロジェクトの名前を指定します。この例では、名前は fuse-online-north になります。

   • ClusterRole: syndesis-auth-delegator
   • ClusterRoleBinding: syndesis-fuse-online-north-auth-delegator

4. クライアントサービスアカウントを作成し、Fuse Online のパブリック API にアクセスする権限を付与します。

   1. 選択した名前で OpenShift サービスアカウントを作成します。たとえば、次のコマンドを実行すると cicd-client サービスアカウントが作成されます。

      oc create serviceaccount cicd-client

      パブリック API エンドポイントを呼び出すコマンドは、このアカウントを使用してパブリック API にアクセスします。また、このサービスアカウントは、API エンドポイントへの呼び出しで指定する必要のあるシークレットトークンを取得するために必要です。この説明は パブリック REST API エンドポイントを呼び出すためのシークレットトークンの取得 を参照してください。

   2. Fuse Online のパブリック API にアクセスするための権限をクライアントサービスアカウントに付与します。Fuse Online がインストールされた OpenShift プロジェクトの名前が fuse-online-north で、API サービスにアクセスするために作成したサービスアカウントの名前が cicd-client である場合、以下のコマンドを実行します。

      oc policy add-role-to-user edit system:serviceaccount:fuse-online-north:cicd-client`

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

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

      oc edit syndesis

   2. リソースを編集して、パブリック API を有効にし、routeHostname の設定としてエンドポイントを呼び出すための Fuse Online 環境のパブリックアドレスを指定します。Fuse Online のインストールに使用された default-cr.yml ファイルで、パブリック API が有効化され、エンドポイントのルートホスト名が指定されている場合は、リソースを編集する必要はありません。

      クラスターのセットアップにより、指定する必要のあるパブリックアドレスが決定されます。詳細は、OpenShift ドキュメントの Routes を参照してください。以下の例では、ルートのホスト名は minishift クラスターに対して有効です。

      spec:
        addons:
          publicApi:
            enabled: true
            routeHostname: public-syndesis.192.168.64.63.nip.io

   3. リソースを保存するか、そのまま閉じます。

      syndesis カスタムリソースを保存することにより、Fuse Online のインストールを担う syndesis-operator がパブリック API OAuth プロキシーサービスをデプロイするようトリガーされます。

      syndesis カスタムリソースを編集する必要がなければ、パブリック API OAuth プロキシーサービスはすでにデプロイされています。これは、Fuse Online のインストールに使用された default-cr.yml ファイルで publicApi が有効化され、そのルートが指定されたためです。

手順

1. この Fuse Online 環境のパブリック REST API を公開したときに作成したサービスアカウントのシークレットトークンの名前を取得します。たとえば、cicd-client がサービスアカウントの名前である場合、以下のコマンドを実行します。

   oc describe serviceaccount cicd-client

   これにより、以下のような 2 つのトークンの名前が含まれる、cicd-client サービスアカウントの情報の一覧が表示されます。

   Tokens:      cicd-client-token-gxb25
                cicd-client-token-gxdnv

2. いずれかのトークンの内容を表示します。以下に例を示します。

   oc describe secret cicd-client-token-gxb25

   これにより、token: とそれに続く長いランダムな文字を表示する Data セクションなど、情報の一覧が表示されます。これはサービスアカウントの 2 つのシークレットトークンの 1 つです。

3. シークレットトークンをコピーし、ファイルに貼り付けて保存します。

手順

1. 左側の Fuse Online ナビゲーションパネルで Integrations をクリックします。
2. インテグレーションのリストで、マーク付けするインテグレーションのエントリーの右にある をクリックしてポップアップメニューを表示し、Manage CI/CD をクリックします。

3. 表示されるダイアログで、以下のいずれかを行います。

   • このインテグレーションをマーク付けする環境が表示されている場合、その環境の左側にあるチェックボックスを選択します。
   • このインテグレーションをマーク付けする環境がすでに選択されている場合は、その環境を選択したままにしておきます。
   • 環境のラベルを作成する必要がある場合、Manage CI/CD をクリックすると、新しい環境ラベルを作成するダイアログが表示されます。必要なラベルを作成してから、この手順に戻り、インテグレーションをマーク付けします。

   Fuse Online によって、選択した環境ラベルがインテグレーションに適用されます。任意の数の環境ラベルをインテグレーションに適用できます。

4. Save をクリックします。

手順

1. Fuse Online の左側のナビゲーションパネルで Integrations をクリックします。
2. 右上の Manage CI/CD をクリックします。

3. Manage CI/CD ページで以下を行います。

   • CI/CD 環境ラベルを作成するには、以下を実行します。

     1. Add New をクリックします。
     2. Add Tag Name ダイアログで、Tag Name 入力フィールドに新しい環境ラベルの名前を入力します (例: test1)。
     3. Save をクリックします。Manage CI/CD ページに、追加した環境ラベルの新しいエントリーがあります。

   • CI/CD 環境ラベルを変更するには、以下を実行します。

     1. CI/CD 環境ラベルの一覧内の、変更するラベルのエントリーで、Edit をクリックします。
     2. Edit Tag ダイアログで、必要に応じて名前を変更します。
     3. Save をクリックすると、環境ラベルのリストに更新された名前が表示されます。Fuse Online は、変更した環境ラベルですでにマーク付けされているすべてのインテグレーションに対し、更新された名前を適用します。

   • CI/CD 環境ラベルを削除するには、以下を実行します。

     1. CI/CD 環境ラベルの一覧内の、削除するラベルのエントリーで、Remove をクリックします。
     2. 確認ダイアログで、Yes をクリックします。Fuse Online は環境ラベルを削除し、削除される環境ラベルでマーク付けされたインテグレーションからもラベルを削除します。