OCP 4.x に Fuse Online をインストールするための主なステップは次のとおりです。

Fuse Online のインストールには、設定可能な Fuse Online 環境アドオン機能およびパラメーター設定のデフォルトを指定するデフォルトカスタムリソースが含まれています。

インストール後の Fuse Online 環境が以下に該当する場合は、Fuse Online をインストールする前に、デフォルトのカスタムリソースを編集する必要があります。

上記のいずれかが該当する場合に Fuse Online 環境を設定するには、Fuse Online のインストール時にカスタムリソースを編集する必要があります。つまり、インストール後に Fuse Online 環境の設定を変更して、上記を実装することはできません。また、上記の設定を適用して Fuse Online 環境をインストールした場合、その設定を変更することはできません。

インストール前のみに指定できるカスタムリソース属性の他に、インストール前または後に変更できるカスタムリソース属性が複数あります。

表 1 には、設定可能なカスタムリソース設定の簡単な説明が記載されています。また、インストールの前または後、あるいは両方で変更可能であるかどうかを示しています。適切に Fuse Online を設定するには、以下の表の情報を活用して、インストール前にカスタムリソースをどのように変更する必要があるのか、またはインストール後にカスタムリソースをどのように変更するのかを見極める必要があります。その後、該当する手順にしたがいます。

OCP 4.x の場合:

OCP 3.11 の場合:

Jaeger は、分散サービス間のトランザクションをトレースするためのオープンソースソフトウェアです。これは、複雑なマイクロサービス環境の監視およびトラブルシューティングで特に役立ちます。

OperatorHub またはコマンドラインスクリプトを使用して Fuse Online をインストールする場合、Fuse Online インストールは OperatorHub の存在を検出し、OperatorHub のサブスクリプション機能を使用して Jaeger をインストールします。OperatorHub が利用できないという制限された状況では、Fuse Online は独自のインストール機能を使用して Jaeger をインストールします。

デフォルトの Fuse Online 環境では、必要な Jaeger コンポーネントがすべて設定されます。任意で、Fuse Online カスタムリソースを編集して、クライアントのみ/非依存のサーバー設定、またはハイブリッド Jaeger クライアントおよび Jaeger Operator 設定を指定できます。

デフォルトの Jaeger 設定で Fuse Online をインストールすると、以下のような結果になります。

デフォルトの Jaeger 設定を使用した Fuse Online インストールには、以下の syndesis カスタムリソース仕様があります。

apiVersion: syndesis.io/v1beta2
kind: Syndesis
metadata:
  name: app
spec:
  addons:
    jaeger:
      enabled: true

clientOnly および operatorOnly が指定されていない場合 (デフォルトで false に設定されている場合)、Fuse Online は提供される Jaeger バックエンドだけでなく、Jaeger サーバー設定によって提供されるデフォルトのメモリーのみのストレージも使用します。

クライアントのみの Jaeger 設定をインストールするには、以下のように Fuse Online をインストールする前にカスタムリソースを編集します。

以下に例を示します。

apiVersion: syndesis.io/v1beta2
kind: Syndesis
metadata:
  name: app
spec:
  addons:
    jaeger:
      enabled: true
      clientOnly: true
      queryUri: http://jaeger-query-hostname:443/api
      collectorUri: http://jaeger-collector-hostname:14268/api/traces

ハイブリッド Jaeger クライアントと Jaeger Operator 設定をインストールするには、以下を行います。

syndesis-jaeger という名前の Jaeger カスタムリソースが作成されると、Jaeger インスタンスは Fuse Online インテグレーションからデータを収集します。デフォルトでは、このデータは Fuse Online のアクティビティーログに記録されません。Fuse Online アクティビティーログにこのデータを表示するには、次のサービスを作成します。

oc create -f - <<EOF
 apiVersion: v1
 kind: Service
 metadata:
   labels:
     app: syndesis
     syndesis.io/app: syndesis
     syndesis.io/type: infrastructure
     syndesis.io/component: jaeger
   name: noauth-syndesis-jaeger-query
 spec:
   ports:
     - name: query
       port: 443
       protocol: TCP
       targetPort: 16686
   selector:
     app: jaeger
     app.kubernetes.io/name: syndesis-jaeger
 EOF

外部データベースを使用してコネクションおよびインテグレーションの定義を永続化する Fuse Online 環境をインストールする場合は、Fuse Online をインストールする前に、OpenShift シークレットである syndesis-global-config を作成します。

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

Fuse Online は、コアインテグレーション機能をサービスとして提供する、柔軟かつカスタマイズ可能なオープンソースプラットフォームです。Fuse Online を OpenShift 開発者ユーザーとしてインストールできます (管理者権限は必要ありません)。

以下は、Operator を使用して Fuse Online をインストールする一般的な手順です。

Operator を使用して OCP 4.x に Fuse Online をインストールする方法の詳細は、以下を参照してください。

オンサイトで OCP に Fuse Online をインストールするには、クラスター管理者がタスクを実行してから、特定の OpenShift プロジェクトで Fuse Online のインストール権限があるユーザーがタスクを実行して、インストールスクリプトを実行します。以下の図では、ワークフローを紹介します。

クラスター管理者は、Fuse Online のインストール先の OpenShift プロジェクトごとに、特定のプロジェクトで Fuse Online をインストールする権限をユーザーに割り当てる必要があります。

デフォルトの Fuse Online 環境をインストールするには、Fuse Online のインストール権限のあるユーザーがインストールスクリプトをダウンロードして実行します。上記以外の手順を実行する必要はありません。

Fuse Online のインストールを可能にするため、クラスター管理者はカスタムリソース定義を登録します。管理者は、OpenShift クラスターに対して 1 度だけこれを実行する必要があります。その後、管理者は Fuse Online を該当のプロジェクトにインストールする権限をユーザーに付与します。これは、Fuse Online をインストールする各プロジェクトに対して行います。

Fuse Online のインストールには、設定可能な Fuse Online 環境アドオン機能およびパラメーター設定のデフォルトを指定するデフォルトカスタムリソースが含まれています。

インストール後の Fuse Online 環境が以下に該当する場合は、Fuse Online をインストールする前に、デフォルトのカスタムリソースを編集する必要があります。

上記のいずれかが該当する場合に Fuse Online 環境を設定するには、Fuse Online のインストール時にカスタムリソースを編集する必要があります。つまり、インストール後に Fuse Online 環境の設定を変更して、上記を実装することはできません。また、上記の設定を適用して Fuse Online 環境をインストールした場合、その設定を変更することはできません。

インストール前のみに指定できるカスタムリソース属性の他に、インストール前または後に変更できるカスタムリソース属性が複数あります。

表 1 には、設定可能なカスタムリソース設定の簡単な説明が記載されています。また、インストールの前または後、あるいは両方で変更可能であるかどうかを示しています。適切に Fuse Online を設定するには、以下の表の情報を活用して、インストール前にカスタムリソースをどのように変更する必要があるのか、またはインストール後にカスタムリソースをどのように変更するのかを見極める必要があります。その後、該当する手順にしたがいます。

OCP 4.x の場合:

OCP 3.11 の場合:

デフォルトの Fuse Online 環境をインストールする場合、デフォルトのカスタムリソースファイルを編集する必要はありません。OCP 4.x での Fuse Online のインストール または OCP 3.11 での Fuse Online のインストール を参照してください。

Fuse Online のカスタマイズ環境をインストールする場合は、Fuse Online をインストールする前に、 default-cr.yml ファイルを編集する必要があります。このファイルは、Fuse Online のダウンロードパッケージに含まれます。Fuse Online のインストール前にのみ指定できるカスタムリソース設定がいくつかあります。インストール前にデフォルトのカスタムリソースを編集する必要がある場合 を参照してください。

Fuse Online のインストール前または後に指定できる、その他のカスタムリソース設定があります。Fuse Online の設定に使用するカスタムリソース属性の説明 を参照してください。

Fuse Online のインストールプロセスでは default-cr.yml ファイルに指定された設定を使用して syndesis カスタムリソースを作成します。syndesis カスタムリソース設定によって、インストールされた Fuse Online 環境の設定が決定されます。

Jaeger は、分散サービス間のトランザクションをトレースするためのオープンソースソフトウェアです。これは、複雑なマイクロサービス環境の監視およびトラブルシューティングで特に役立ちます。

OperatorHub またはコマンドラインスクリプトを使用して Fuse Online をインストールする場合、Fuse Online インストールは OperatorHub の存在を検出し、OperatorHub のサブスクリプション機能を使用して Jaeger をインストールします。OperatorHub が利用できないという制限された状況では、Fuse Online は独自のインストール機能を使用して Jaeger をインストールします。

デフォルトの Fuse Online 環境では、必要な Jaeger コンポーネントがすべて設定されます。任意で、Fuse Online カスタムリソースを編集して、クライアントのみ/非依存のサーバー設定、またはハイブリッド Jaeger クライアントおよび Jaeger Operator 設定を指定できます。

デフォルトの Jaeger 設定で Fuse Online をインストールすると、以下のような結果になります。

デフォルトの Jaeger 設定を使用した Fuse Online インストールには、以下の syndesis カスタムリソース仕様があります。

apiVersion: syndesis.io/v1beta2
kind: Syndesis
metadata:
  name: app
spec:
  addons:
    jaeger:
      enabled: true

clientOnly および operatorOnly が指定されていない場合 (デフォルトで false に設定されている場合)、Fuse Online は提供される Jaeger バックエンドだけでなく、Jaeger サーバー設定によって提供されるデフォルトのメモリーのみのストレージも使用します。

クライアントのみの Jaeger 設定をインストールするには、以下のように Fuse Online をインストールする前にカスタムリソースを編集します。

以下に例を示します。

apiVersion: syndesis.io/v1beta2
kind: Syndesis
metadata:
  name: app
spec:
  addons:
    jaeger:
      enabled: true
      clientOnly: true
      queryUri: http://jaeger-query-hostname:443/api
      collectorUri: http://jaeger-collector-hostname:14268/api/traces

ハイブリッド Jaeger クライアントと Jaeger Operator 設定をインストールするには、以下を行います。

syndesis-jaeger という名前の Jaeger カスタムリソースが作成されると、Jaeger インスタンスは Fuse Online インテグレーションからデータを収集します。デフォルトでは、このデータは Fuse Online のアクティビティーログに記録されません。Fuse Online アクティビティーログにこのデータを表示するには、次のサービスを作成します。

oc create -f - <<EOF
 apiVersion: v1
 kind: Service
 metadata:
   labels:
     app: syndesis
     syndesis.io/app: syndesis
     syndesis.io/type: infrastructure
     syndesis.io/component: jaeger
   name: noauth-syndesis-jaeger-query
 spec:
   ports:
     - name: query
       port: 443
       protocol: TCP
       targetPort: 16686
   selector:
     app: jaeger
     app.kubernetes.io/name: syndesis-jaeger
 EOF

外部データベースを使用してコネクションおよびインテグレーションの定義を永続化する Fuse Online 環境をインストールする場合は、Fuse Online をインストールする前に、OpenShift シークレットである syndesis-global-config を作成します。

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

Fuse Online インストールスクリプトを実行すると、Fuse Online ダウンロードパッケージに含まれる default-cr.yml ファイルの設定にしたがって Fuse Online 環境がインストールされます。デフォルトの環境をインストールする場合は、このファイルを編集する必要はありません。カスタマイズされた環境をインストールする場合は、インストールスクリプトを実行する前に default-cr.yml ファイルを編集する必要があります。

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

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

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

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

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

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

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

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

3scale の検出を有効にしている場合には、後で任意で無効にすることができます。

Fuse Online カスタムリソースでノードのアフィニティーおよび許容オプションを設定して、Fuse Online インフラストラクチャーコンポーネントおよびインテグレーション Pod を OpenShift クラスター内のノードに配置するように設定できます。nodeAffinity オプションを使用すると、配置先のノードのグループに対して Fuse Online Pod のアフィニティーを指定できます。tolerations オプションを使用すると、Fuse Online Pod が実行されるノードを制御し、他のワークロードがそれらのノードを使用しないようにすることができます。

これらのオプションは、Fuse Online のインストール前または後に Fuse Online カスタムリソースを編集して設定します。

インテグレーションデプロイメントとは別に、インフラストラクチャーコンポーネントデプロイメントのノードアフィニティーまたは許容の設定を指定します。

以下の手順では、oc patch コマンドを使用してカスタムリソースを編集する方法を説明します。この他にも、以下のトピックで説明されているような方法で、カスタムリソースを編集できます。

多くのサービスは、HTTP プロキシーを使用して、他のサービスまたはコンポーネントとの通信をフィルターリングし、セキュリティーを保護します。Fuse Online コンポーネントおよびインテグレーションで HTTP プロキシーを設定するには、Fuse Online のインストール前または後に Fuse Online カスタムリソースを編集します。

Fuse Online はインテグレーションの再ビルド時に HTTP プロキシー設定を使用します。

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

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

Prometheus を使用して Fuse Online インフラストラクチャーコンポーネントおよび Fuse Online インテグレーションを監視できます。Grafana ダッシュボードを使用して、Prometheus によって収集されるメトリクスを可視化することもできます。

Fuse Online インテグレーションを監視する他に、Prometheus を使用して以下の Fuse Online インフラストラクチャーコンポーネントによって公開されるメトリクスを監視できます。

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

以下の表では、Fuse Online インフラストラクチャーコンポーネントおよびインテグレーションのメータリングラベルが一覧表示されています。

Fuse Online を定期的にバックアップするよう設定できます。

Fuse Online をインストールする前に Fuse Online 環境のバックアップを設定するか、Fuse Online 環境の設定を変更してバックアップを有効することができます。

Fuse Online がバックアップを実行するように設定されている場合、Fuse Online はデータを単一のファイルに圧縮し、そのファイルを指定した Amazon S3 バケットにアップロードします。新しい Fuse Online 環境 (コネクションやインテグレーションが定義されていない) にバックアップを適用して、バックアップした Fuse Online 環境を復元できます。

コネクションまたはインテグレーションが作成されていない新しい Fuse Online 環境で、Fuse Online 環境のバックアップを復元できます。Fuse Online 環境の復元後、復元されたコネクションを編集してパスワードを更新する必要があります。その後、復元されたインテグレーションをパブリッシュできます。

時々、パッチとセキュリティー修正が組み込まれた新しいアプリケーションイメージが Fuse Online に対してリリースされます。これらの更新は、Red Hat のエラータ更新チャネルを介して通知されます。その後、Fuse Online イメージをアップグレードできます。

Fuse Online を 7.8 にアップグレードする前に、アップグレード前の Docker イメージへのアクセス の説明にしたがって、Fuse Online バックアップおよびリストアデータベースの Docker イメージへのアクセスを設定する必要があります。

Fuse Online のアップグレード手順は、Fuse Online をインストールした方法によって異なります。

error: code = Unknown desc = toomanyrequests: You have reached your pull rate limit

プロジェクトやプロジェクトの内容を削除せずに、OCP プロジェクトから Fuse Online をアンインストールできます。Fuse Online のアンインストール後、稼働中のインテグレーションは継続されますが、編集または再パブリッシュできなくなります。

Fuse Online がインストールされている OpenShift プロジェクトを削除すると、プロジェクトのすべてが削除されます。これには、定義されたすべてのインテグレーションと、稼働中のすべてのインテグレーションが含まれます。

oc delete project fuse-online-project

オンサイトの OCP で Fuse Online を実行している場合、外部ツールを使用して Fuse Online 環境から別の Fuse Online 環境に Fuse Online インテグレーションをコピーすることがあります。外部 CI/CD ツールは、Jenkins ジョブ、Ansible Playbook、cron ベースのシェルスクリプトなどです。たとえば、Ansible Playbook ではインテグレーションを Fuse Online 開発環境からエクスポートし、Fuse Online テスト環境にインポートすることができます。

これを有効にするには、各 Fuse Online 環境の Fuse Online パブリック REST API エンドポイントを公開する必要があります。つまり、Fuse Online がインストールされている OpenShift プロジェクトごとに、ここの手順を繰り返す必要があります。

この手順を実行した OpenShift プロジェクトでは、外部 CI/CD ツールで Fuse Online のパブリック REST API エンドポイントを使用して Fuse Online インテグレーションをエクスポートまたはインポートできます。

Fuse Online パブリック REST API エンドポイントのベース URL は、以下のようになります。

https://public-syndesis.192.168.64.42.nip.io/api/v1/public

Fuse Online 環境ごとに、ベース URL の最初の部分は異なります。OpenShift アプリケーションを作成して、これによりパブリック REST API エンドポイントへのアクセスを有効にする Fuse Online パブリック OAuth プロキシーを実行する場合、Fuse Online 環境のパブリックアドレスを指定します。このアドレスは、Fuse Online 環境で動作するエンドポイントを呼び出すベース URL の最初の部分です。以下に例を示します。

https://public-syndesis.192.168.64.42.nip.io

ベース URL の 2 つ目の部分は、すべての Fuse Online 環境で同じです。

/api/v1/public

Fuse Online のパブリック REST API は、3 つのリソースで動作するエンドポイントを提供します。

Fuse Online のパブリック REST API エンドポイントを呼び出すコマンドで、シークレットトークンを指定する必要があります。このトークンは、任意の Fuse Online 環境で Fuse Online パブリック REST API を公開したときに作成したサービスアカウントのものです。

-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJzeW5kZXNpcyIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJzeW5kZXNpcy1jZC1jbGllbnQtdG9rZW4tMnZjNmwiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC5uYW1lIjoic3luZGVzaXMtY2QtY2xpZW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiNjUxMjYxNGMtMmYwMS0xMWU5LTk3OWEtNDI1YWNlMzY3MTcyIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OnN5bmRlc2lzOnN5bmRlc2lzLWNkLWNsaWVudCJ9.uKsri0JSKJDbgHoQwAhBJSNuWKwJgjegf2QlrCkhxVssSK1zIMZQaF9P5a4R7ZcWRnrZ_345UTqxYVeRlfHWVH0PqBkD-n7PAS9dcKJIFdS1jUHOmL1FTGgc3YW-bz1SlWT93tvK1EhorZ4_-EBfXhSAP4Uumi5qAg3_QUTMDstq233NSwBKYtFOw3Pp1ys3p3y0hcaiLMimeCH60vR4iWvptqqzc5QDigHiPySZNWxs_5awZlwdoIDvR-nSj690aC-49UKFgyEEdzdFU4bI2W4hOyDyhN9fVaIAZQKeJUrJBU-lnFTHI_NAd2OwzOEBpWZuj31Za5w9fU4kf4UDGA'

特定のインテグレーションのみで動作する Fuse Online のパブリック REST API エンドポイントを呼び出すコマンドで、エンドポイントが操作するインテグレーションの ID を指定する必要があります。以下のいずれかを指定します。

Fuse Online のパブリック REST API エンドポイントを呼び出す curl コマンドの形式は、以下のようになります。

curl [options] \
     -H "Content-Type: <media-type>" \
     -H "SYNDESIS-XSRF-TOKEN: awesome" \
     -H `Authorization: Bearer <token>` \
     <base-url><endpoint> \
     [--request <HTTP-method>] \
     [-d <data>] \
     [-o <filename>]

以下の curl コマンドは、指定する 1 つまたは複数の環境に対してインテグレーションをマーク付けする Fuse Online のパブリック API エンドポイントを呼び出します。

curl -v -k -L -H "Content-Type: application/json" -H "SYNDESIS-XSRF-TOKEN: awesome" -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJzeW5kZXNpcyIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJzeW5kZXNpcy1jZC1jbGllbnQtdG9rZW4tMnZjNmwiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC5uYW1lIjoic3luZGVzaXMtY2QtY2xpZW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiNjUxMjYxNGMtMmYwMS0xMWU5LTk3OWEtNDI1YWNlMzY3MTcyIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OnN5bmRlc2lzOnN5bmRlc2lzLWNkLWNsaWVudCJ9.uKsri0JSKJDbgHoQwAhBJSNuWKwJgjegf2QlrCkhxVssSK1zIMZQaF9P5a4R7ZcWRnrZ_345UTqxYVeRlfHWVH0PqBkD-n7PAS9dcKJIFdS1jUHOmL1FTGgc3YW-bz1SlWT93tvK1EhorZ4_-EBfXhSAP4Uumi5qAg3_QUTMDstq233NSwBKYtFOw3Pp1ys3p3y0hcaiLMimeCH60vR4iWvptqqzc5QDigHiPySZNWxs_5awZlwdoIDvR-nSj690aC-49UKFgyEEdzdFU4bI2W4hOyDyhN9fVaIAZQKeJUrJBU-lnFTHI_NAd2OwzOEBpWZuj31Za5w9fU4kf4UDGA'
https://public-syndesis.192.168.64.42.nip.io/api/v1/public/integrations/timer-to-log/tags -d '["test","staging"]' --request PUT

サンプル curl コマンドでは、以下のとおりです。

オンサイトの OCP で Fuse Online を稼働している場合、パイプラインのインテグレーションを特定するために、指定する CI/CD 環境のインテグレーションをマーク付けします。これにより、タイムスタンプ付きのラベルがインテグレーションに適用されます。バックエンド CI/CD Fuse Online のパブリック API は、ラベルおよびそのタイムスタンプを使用してインテグレーションをフィルターリングし、パイプラインが動作する必要のあるインテグレーションを見つけます。

たとえば、Fuse Online で test1 環境のインテグレーションをマーク付けするとします。その後、Fuse Online のパブリック API エクスポートエンドポイントを呼び出して、test1 環境ラベルがあるインテグレーションをエクスポートできます。エンドポイントによって test1 インテグレーションがをエクスポートファイルにパッケージ化され、そのファイルが返されます。test1 インテグレーションを Fuse Online テスト環境にコピーするには、パブリック API インポートエンドポイントを呼び出し、エクスポートした test1 インテグレーションが含まれるファイルを提供します。

ここで、以前 test1 環境に対してマーク付けしたインテグレーションを繰り返し更新し、パブリッシュするとします。インテグレーションが新しいバージョンになり、更新されたバージョンを test1 環境にエクスポートするとします。すでにインテグレーションが test1 環境に対してマーク付けされている場合でも、再度マーク付けする必要があります。インテグレーションを再度マーク付けすると、test1 環境ラベルのタイムスタンプが更新されます。これは、インテグレーションが更新され、エクスポートできるようになったことを外部ツールに示します。

インテグレーションを再度マーク付けする、つまりインテグレーションにすでに割り当てられた環境ラベルのタイムスタンプを更新するには、CI/CD のインテグレーションのマーク付け の手順にしたがいます。CI/CD ダイアログで、対象の環境のチェックボックスがすでに選択されているはずなので、Save をクリックします。

オンサイトの OCP で Fuse Online を稼働している場合、パイプラインのインテグレーションを特定するために、指定する CI/CD 環境のインテグレーションをマーク付けします。これにより、ラベルがインテグレーションに適用されます。

Fuse Online コンソールで CI/CD 環境ラベルを作成、変更、または削除できます。CI/CD 環境ラベルは、CI/CD パイプラインのインテグレーションに適用できる識別用のタグです。

外部ツールを使用して Fuse Online インテグレーションを別の Fuse Online 環境からコピーできるようにするには、先に以下のタスクを実行する必要があります。

/public​/integrations​/{env}​/export.zip

{env} を、すでに作成した CI/CD 環境ラベルに置き換えてください。インテグレーションが特定の環境に対してマーク付けされている場合、Fuse Online はマーク付けされたタイミングを示すタイムスタンプで管理します。エンドポイントがマーク付けされてからエクスポートされていない場合に限り、インテグレーションをエクスポートするのがデフォルトの挙動です。たとえば、test1 環境に対してマーク付けされたインテグレーションをエクスポートする場合、エンドポイントは以下のようになります。

/public/integrations/test1/export.zip

このエンドポイントは、test1 環境ラベルがあり、以下の条件のいずれかを満たす、各インテグレーションをエクスポートします。

エンドポイントはインテグレーションを export.zip ファイルにパッケージ化し、そのファイルを返します。

インテグレーションがエクスポートされた後に指定の環境に対してマーク付けされたインテグレーションがない場合は、エンドポイントは HTTP 204 応答を返し、返すものがないことを示します。

以下に例を示します。

/public/integrations/test1/export.zip?ignoreTimestamp=true -o export.zip

以下に例を示します。

/public/integrations/{env}/export.zip?all=true

{env} を CI/CD 環境ラベルに置き換えます。エンドポイントは、その環境に対してマーク付けされていない各インテグレーションに、指定した環境ラベルを割り当てます。

all=true オプションを追加する場合、エクスポートされたインテグレーションを export.zip ファイルにパッケージ化するように明示的に指定する必要もあります。以下に例を示します。

/public/integrations/test1/export.zip?all=true -o export.zip

このエンドポイントの呼び出しによって、以下のことが実行されます。

curl -v -k -L -H "Content-Type: multipart/form-data" -H "SYNDESIS-XSRF-TOKEN: awesome" -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJzeW5kZXNpcyIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJzeW5kZXNpcy1jZC1jbGllbnQtdG9rZW4tMnZjNmwiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC5uYW1lIjoic3luZGVzaXMtY2QtY2xpZW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiNjUxMjYxNGMtMmYwMS0xMWU5LTk3OWEtNDI1YWNlMzY3MTcyIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OnN5bmRlc2lzOnN5bmRlc2lzLWNkLWNsaWVudCJ9.uKsri0JSKJDbgHoQwAhBJSNuWKwJgjegf2QlrCkhxVssSK1zIMZQaF9P5a4R7ZcWRnrZ_345UTqxYVeRlfHWVH0PqBkD-n7PAS9dcKJIFdS1jUHOmL1FTGgc3YW-bz1SlWT93tvK1EhorZ4_-EBfXhSAP4Uumi5qAg3_QUTMDstq233NSwBKYtFOw3Pp1ys3p3y0hcaiLMimeCH60vR4iWvptqqzc5QDigHiPySZNWxs_5awZlwdoIDvR-nSj690aC-49UKFgyEEdzdFU4bI2W4hOyDyhN9fVaIAZQKeJUrJBU-lnFTHI_NAd2OwzOEBpWZuj31Za5w9fU4kf4UDGA'
https://public-syndesis.192.168.64.42.nip.io/api/v1/public/integrations/dev1/export.zip

コマンドでは、以下のようになります。

Fuse Online のパブリック API エクスポートエンドポイントを呼び出して、1 つまたは複数のインテグレーションを取得できます。エクスポートされたインテグレーションを別の Fuse Online 環境にコピーするには、Fuse Online のパブリック API インポートエンドポイントを呼び出します。

​/public​/integrations

以下の例では、エンドポイントは export.zip ファイルにあるインテグレーションをインポートし、testing 環境に対してタグを付けます。

/public/integrations -F data=@export.zip -F environment=testing --request POST

インポートエンドポイントは指定のインテグレーションを常にインポートします。最後にインポートされてからインテグレーションが変更されていない場合も、エンドポイントはそれをインポートします。

curl -v -k -L -H "Content-Type: multipart/form-data" -H "SYNDESIS-XSRF-TOKEN: awesome" -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJzeW5kZXNpcyIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJzeW5kZXNpcy1jZC1jbGllbnQtdG9rZW4tMnZjNmwiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC5uYW1lIjoic3luZGVzaXMtY2QtY2xpZW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiNjUxMjYxNGMtMmYwMS0xMWU5LTk3OWEtNDI1YWNlMzY3MTcyIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OnN5bmRlc2lzOnN5bmRlc2lzLWNkLWNsaWVudCJ9.uKsri0JSKJDbgHoQwAhBJSNuWKwJgjegf2QlrCkhxVssSK1zIMZQaF9P5a4R7ZcWRnrZ_345UTqxYVeRlfHWVH0PqBkD-n7PAS9dcKJIFdS1jUHOmL1FTGgc3YW-bz1SlWT93tvK1EhorZ4_-EBfXhSAP4Uumi5qAg3_QUTMDstq233NSwBKYtFOw3Pp1ys3p3y0hcaiLMimeCH60vR4iWvptqqzc5QDigHiPySZNWxs_5awZlwdoIDvR-nSj690aC-49UKFgyEEdzdFU4bI2W4hOyDyhN9fVaIAZQKeJUrJBU-lnFTHI_NAd2OwzOEBpWZuj31Za5w9fU4kf4UDGA'
https://public-syndesis.192.168.64.45.nip.io/api/v1/public/integrations -F data=@export.zip -F environment=testing --request POST

このコマンドでは、以下のようになります。

このエンドポイントは、指定されたインテグレーションの状態を返します。状態には Running、Stopped、Pending、または Error があります。

/public/integrations/{id}/state

/public/integrations/timer-to-log/state

このエンドポイントは、指定のインテグレーションに適用されている環境ラベル (タグ) を返します。

/public/integrations/{id}/tags

/public/integrations/timer-to-log/tags

このエンドポイントは PATCH メソッドを使用して、指定された環境の指定のインテグレーションをマーク付けします。インテグレーションが指定の環境に対してすでにマーク付けされている場合、エンドポイントはその環境ラベルのタイムスタンプを更新します。インテグレーションが新しいリクエストで指定されていない環境に対してマーク付けされていた場合、エンドポイントはそのタグをそのまま残し、タイムスタンプを更新しません。

この PATCH エンドポイントは、他の既存のタグを削除しなくてもタグが追加されるため、CI/CD ツールに便利です。これは、指定環境に対してインテグレーションをマーク付けし、リクエストで指定されていない環境のタグを削除する、PUT エンドポイントとは対象的です。

/public/integrations/{id}/tags

public/integrations/timer-to-log/tags --request PATCH -d '["test2","test3"]'

このエンドポイントは PUT メソッドを使用して、指定された環境の指定されたインテグレーションをマーク付けします。インテグレーションが新しいリクエストで指定されていない環境に対してマーク付けされている場合、エンドポイントはその環境ラベルをインテグレーションから削除します。

未指定の環境ラベルを削除せずにインテグレーションをマーク付けするには、代わりに PATCH メソッドエンドポイント を呼び出します。

/public/integrations/{id}/tags

public/integrations/timer-to-log/tags --request PUT -d '["test2","test3"]'

このエンドポイントは指定されたインテグレーションをパブリッシュします。インテグレーションがすでに稼働中である場合、エンドポイントはインテグレーションを停止し、再度パブリッシュします。

/public/integrations/{id}/deployments

/public/integrations/timer-to-log/deployments

{"id":"i-Lc0JLrsUFtBJfR_ylfEz:8","version":8,"createdAt":1555365135324,"updatedAt":1555365135324,"userId":"system:serviceaccount:syndesis:syndesis-cd-client","currentState":"Pending","targetState":"Published","integrationId":"i-Lc0JLrsUFtBJfR_ylfEz", . .2c+PC9zdmc+","description":"Trigger events based on an interval or a cron expression","isDerived":false},"stepKind":"endpoint"},{"id":"-Lc0I7wqEVfKCDDHC8Jv","configuredProperties":{"bodyLoggingEnabled":"true","contextLoggingEnabled":"true"},"metadata":{"configured":"true"},"stepKind":"log","name":"Log"}]}],"continuousDeliveryState":{"test2":{"name":"test2","releaseTag":"i-LcXyw7GUFtBJfR_ylgtz","lastTaggedAt":1555365085713},"test3":{"name":"test3","releaseTag":"i-LcXyw7GUFtBJfR_ylguz","lastTaggedAt":1555365085713}}}}

このエンドポイントは、指定されたインテグレーションを停止します。

/public/integrations/{id}/deployments/stop

/public/integrations/timer-to-log/deployments stop

このエンドポイントはインテグレーションをエクスポートします。エンドポイントが指定の環境に対してマーク付けされ、まだ 1 回もエクスポートされていないインテグレーションか、その環境に対して最後にマーク付けされた後にエクスポートされていないインテグレーションをエクスポートするのがデフォルトの挙動です。以下のいずれかを行う場合は、オプションを指定できます。

Fuse Online パブリック API エクスポートエンドポイントの呼び出し も参照してください。

/public/integrations/{env}/export.zip

/public/integrations/test1/export.zip

以下の例では、エンドポイントは test1 環境に対してマーク付けされたすべてのインテグレーションをエクスポートします。前回エクスポートされた後にインテグレーションが更新されたかどうかは関係ありません。

/public/integrations/test1/export.zip?ignoreTimestamp=true -o export.zip

最後の例では、エンドポイントは各インテグレーションが test1 環境に対してマーク付けされていることを確かめ、export.zip ファイルのすべてのインテグレーションを返します。

/public/integrations/test1/export.zip?all=true -o export.zip

このエンドポイントは、提供されたファイルにあるインテグレーションをインポートします。Fuse Online パブリック REST API インポートエンドポイントの呼び出し も参照してください。

/public/integrations

/public/integrations -F data=@export.zip -F environment=testing --request POST

{"lastImportedAt":1554888047271,"results":[{"id":"i-Lc0JLrsUFtBJfR_ylfEz","version":5,"createdAt":1554800274935,"updatedAt":0,"tags":["timer"],"name":"timer-to-log","flows":[{"id":"-Lc0I5AZEVfKCDDHC8Jv","steps":[{"id":"-Lc0I5jnEVfKCDDHC8Jv","configuredProperties":{"period":"900000"},"metadata":…​"description":"Trigger events based on an interval or a cron expression","isDerived":false},"stepKind":"endpoint"},{"id":"-Lc0I7wqEVfKCDDHC8Jv","configuredProperties":{"bodyLoggingEnabled":"true","contextLoggingEnabled":"true"},"metadata":{"configured":"true"},"stepKind":"log","name":"Log"}]}],"continuousDeliveryState":{"staging":{"name":"staging","releaseTag":"i-Lc5WI16UFtBJfR_ylgfz","lastTaggedAt":1554887553159},"test":{"name":"test","releaseTag":"i-Lc5WI16UFtBJfR_ylggz","lastTaggedAt":1554887553159,"lastExportedAt":1554887330152,"lastImportedAt":1554887859824}}}]}

このエンドポイントは、指定された環境ラベルを指定のインテグレーションから削除します。環境ラベル自体は引き続き存在しますが、指定されたインテグレーションのマーク付けが解除されます。

/public/integrations/{id}/tags/{env}

/public/integrations/timer-to-log/tags/dev1 --request DELETE

このエンドポイントは環境ラベルを作成します。Fuse Online コンソールで、またはパブリック API エンドポイントを呼び出して明示的にマーク付けするまで、インテグレーションがこのラベルでマークが付けられることはありません。

/public/environments/{env}

/public/environments/dev1 --request POST

このエンドポイントを呼び出した Fuse Online 環境に、dev1 環境ラベルが存在するようになります。このラベルでマーク付けされたインテグレーションはまだありません。

このエンドポイントは、Fuse Online 環境に存在する環境ラベルの一覧を返します。Fuse Online コンソールで環境ラベルを作成します。CI/CD の環境ラベルの管理 を参照してください。

/public/environments[?withUses=true]

このエンドポイントは環境ラベルを変更します。元の環境ラベルについてマーク付けされていたインテグレーションは、新しい環境ラベルに対してマーク付けされるようになります。

/public/environments/{env}

/public/environments/dev1 -d ‘dev2' --request PUT

dev1 環境に対してマーク付けされていたインテグレーションのタグがなくなります。このインテグレーションは、dev2 環境に対してマーク付けされるようになります。

このエンドポイントは、指定された環境ラベルが適用されている各インテグレーションからラベルを削除します。

/public/environments/{env}

/public/environments/dev1 --request DELETE

このエンドポイントは、指定されたコネクションのプロパティーを変更します。これは、設定が必要なコネクションがあるインテグレーションをインポートした後に役立ちます。たとえば、コネクションが使用するクレデンシャルを変更する必要がある場合などが該当します。

​/public​/connections​/{id}​/properties

/public/connections/PostgresDB/properties --request POST -d '{ "user": "myuser", "password": "mypassword" }'

{"uses":0,"id":"i-LaOziUGpQE45nua4pfCz","name":"TODO app","configuredProperties":{"password":"»ENC:c2cb731046372a275b76beabc92aefa061f79b43fb791fb599d9e85ec0235a7e","basePath":"/api","host":"http://todo-syndesis.my-minishift.syndesis.io/","specification":…​"userId":"admin","lastUpdated":1555365796629,"createdDate":1553066813379,"board":{"id":"i-Lbj4-vqUFtBJfR_ylfCz","metadata":{"connector-id":"i-LaOzcPZpQE45nua4pfBz","connector-version-latest":"1","connector-version-connection":"1"},"messages":[{"level":"WARN","code":"SYNDESIS007"}],"createdAt":1554494263030,"updatedAt":1554494263727,"targetResourceId":"i-LaOziUGpQE45nua4pfCz","notices":0,"warnings":1,"errors":0},"isDerived":false}