Tulip 統合のためのオンプレミス・コネクター・ホスト(OPCH)の導入、設定、および保守に関する技術的な手順について学びましょう。
この記事は、OPCHの物理的な導入およびライフサイクル管理を担当する方に向けた技術リファレンスガイドです。コネクタホストは、
外部のWebサービス、データベース、およびOPC UAサーバーへの接続を容易にするために使用されるサービスです。すべてのTulipインスタンスには、デフォルトでCloud Connector Hostが備わっています。
オンプレミス・コネクタ・ホストが適切なアーキテクチャであるかどうかを判断する際には、いくつかの考慮事項があります。
前提条件
先に進む前に、Tulip コネクタホストの基本について理解しておいてください:*コネクタホスト* オンプレミスコネクタホスト
ネットワーク
オンプレミス・コネクター・ホストを導入する最も一般的な理由は、ローカルネットワーク内でホストされているシステムに接続する際に得られる利点にあります。オンプレミス環境では、Tulip から外部システムへのすべての接続は、ローカルネットワーク内から開始されます。ネットワークからのすべての接続は、セキュアな WebSocket 経由で Tulip へ送信されます。
これに対し、クラウド・コネクタ・ホストでは、サービスへのインバウンドアクセスが必要となります。これは通常、IT部門が判断する事項であり、Tulipのクラウドからサービスへの安全なWebSocket接続を許可する必要があります。多くの場合、WANルーターやファイアウォールでのポートフォワーディング設定を通じて実現されます。
オンプレミス・コネクタ・ホストの導入
Starting with LTS16+, OPCH includes two environment variables to help with troubleshooting and support: TULIP_LOGGING_TO_TULIP (logging) and TULIP_TELEMETRY_TO_TULIP (metric reporting). To explicitly opt out, you can comment out the above environment variables.
技術基準
The amount of resources needed to run OPCH will increase as its usage increases. If you consistently use it beyond 250Hz of throughput, we strongly advise allocating more resources to your virtual machines to ensure optimal performance.
オンプレミスソリューションの導入が決定された場合、Tulipでは分散型Dockerイメージを使用したセルフサービス方式を推奨します。これを実現する最も簡単な方法は、Linuxディストリビューションを搭載した仮想マシンを使用することです。
また、サイトにおける単一障害点を回避するため、1台の仮想マシンにつき1つのオンプレミスコネクタホストのみをホストすることをTulipは推奨しています。
仮想マシンの要件:
- RAM - 4 GB
- ROM - 8~16 GBのディスク容量
- CPU - 2コア
- Docker バージョン - 20.10 以降
ネットワーク要件については、オンプレミス・コネクタ・ホストには以下のものが必要です:
- IPアドレス
- 以下の宛先へのDNS解決
- ポート443経由でのTulipへのアウトバウンドアクセス(IPアドレスはこちらに記載)
- こちらのDocker リポジトリへのアウトバウンドアクセス
- ポートを介した、関連するすべての外部システムへのアウトバウンドアクセス
ネットワーク要件の完全なリストはこちらで確認してください
展開
以下のセクションでは、さまざまな環境でオンプレミス・コネクタ・ホストをデプロイする方法について概説します。AWSとAzureはどちらも、Dockerイメージを実行できるコンテナサービスを提供しています。
AWS
Web UI および以下の手順を参照してください:https://aws.amazon.com/getting-started/hands-on/deploy-docker-containers/
Azure (Bash): LTS16+ OPCH
az container create `-g <AZURE内のリソースグループ名> `--name <コンテナ名> `--cpu 2 `--memory 3 `--restart-policy Always `--public.ecr.aws/tulip/connector-host:<TAG>--os-type Linux `-e TULIP_UUID='<UUID>' `TULIP_FACTORY='https://<YOUR SITE>.tulip.co' `TULIP_MACHINE_SECRET='<SECRET>' `TULIP_DEVICE_TYPE='onprem' `TULIP_LOGGING_TO_TULIP=true`TULIP_TELEMETRY_TO_TULIP=true`TULIP_CONNECTORS_HTTP_PROXY='' `TULIP_CONNECTORS_HTTPS_PROXY=''
Azure (Bash): LTS16以前のOPCH
az container create `-g <AZURE内のリソースグループ名> `--name <コンテナ名> `--cpu 2 `--memory 3 `--restart-policy Always `--public.ecr.aws/tulip/connector-host:<TAG> `--os-type Linux `-e TULIP_UUID='<UUID>' `TULIP_FACTORY='https://<YOUR SITE>.tulip.co' `TULIP_MACHINE_SECRET='<SECRET>' `TULIP_DEVICE_TYPE='onprem' `CONNECTORS_HTTP_PROXY='' `CONNECTORS_HTTPS_PROXY=''
Linux VM: LTS16+ OPCH
docker run -d \ --name tulip-connector-host \ -e TULIP_FACTORY='https://<FACTORY>.tulip.co' \ -e TULIP_UUID='<UUID>' \ -e TULIP_MACHINE_SECRET='<SECRET>' \ -e TULIP_DEVICE_TYPE='onprem' \ -e TULIP_LOGGING_TO_TULIP=true \ -e TULIP_TELEMETRY_TO_TULIP=true \ -e TULIP_CONNECTORS_HTTP_PROXY='' \ -e TULIP_CONNECTORS_HTTPS_PROXY='' \ --restart=always \ --net=host \ public.ecr.aws/tulip/connector-host:<TAG>
Linux VM: LTS16以前のOPCH
--name tulip-connector-host \
-e TULIP\_FACTORY='https://.tulip.co' \
-e TULIP\_UUID='' \
-e TULIP\_MACHINE\_SECRET='' \
-e TULIP\_DEVICE\_TYPE='onprem' \
-e CONNECTORS\_HTTP\_PROXY='' \
-e CONNECTORS\_HTTPS\_PROXY='' \
-e EXIT\_ON\_DISCONNECT=true \ --restart=always \
--net=host \
--mount type=volume,source=tuliplog,target=/log \
public.ecr.aws/tulip/connector-host:
Windows (PowerShell): LTS16+ OPCH
docker run -d --name tulip-connector-host -e TULIP_FACTORY='https://<FACTORY>.tulip.co' -e TULIP_UUID='<UUID>' -e TULIP_MACHINE_SECRET='<SECRET>' -e TULIP_DEVICE_TYPE='onprem' -e TULIP_LOGGING_TO_TULIP=true -e TULIP_TELEMETRY_TO_TULIP=true -e TULIP_CONNECTORS_HTTP_PROXY='' -e TULIP_CONNECTORS_HTTPS_PROXY='' --restart=always --net=host public.ecr.aws/tulip/connector-host:<TAG>
Windows (PowerShell): LTS16以前のOPCH
docker run -d --name tulip-connector-host -e TULIP_FACTORY='https://<FACTORY>.tulip.co' -e TULIP_UUID='<UUID>' -e TULIP_MACHINE_SECRET='<SECRET>' -e TULIP_DEVICE_TYPE='onprem' -e HTTP_PROXY='' -e HTTPS_PROXY='' -e EXIT_ON_DISCONNECT=true --restart=always --net=host --mount type=volume,source=tuliplog,target=/log public.ecr.aws/tulip/connector-host:<TAG>
証明書エラーのトラブルシューティング
OPCHの起動時に「証明書チェーン内の自己署名証明書」エラーが発生する場合、その根本原因は、カスタム証明書を使用している企業のプロキシやファイアウォールが、Tulip Cloudへのセキュアな接続を妨げている可能性があります。
症状 - OPCHのステータスが「Never seen」となる - 起動中にプロセスが終了する - ログにSSL証明書チェーンのエラーが記録される
これを解決するには、以下に示すように、OPCHの起動時に参照する追加の認証局を、以下の環境変数を使用して指定します。なお、このファイルはDockerコンテナ内に存在している必要があります。
LTS16以前のOPCHの場合:-e CONNECTORS_EXTRA_TRUSTED_CAS_FROM_FILES='["/etc/tulipCa/ca.pem"]'
LTS16以降のOPCHの場合:-e TULIP_CONNECTORS_EXTRA_TRUSTED_CAS_FROM_FILES='["/etc/tulipCa/ca.pem"]'
オンプレミス・コネクタ・ホストのアップグレード
OPCH must be kept up-to-date with the Tulip product. Learn more about [connector](/r230/docs/on-prem-<span translate=)-host-version-support">OPCH version support.
Tulip recommends proactively confirming the upgrade by successfully running a test OPCH connection to the development environment and/or development instance. Once this verification is complete, the production environment can be confidently upgraded. Details on how can be found below.
:::(警告) (Edge IO のアップグレードも必要になる場合があります)
OPCH はEdge IO デバイス上で実行できます。お使いのデバイスで自動アップグレードが有効になっていない場合は、手動でアップグレードする必要があります。
すべてのOPCHのアップグレードを完了した後もこの警告バナーが表示される場合は、Edge IO も更新されていることを確認してください。
:::
Tulipは、長期サポート(LTS)リリーススケジュールに従って、オンプレミスコネクタホストのアップデートをリリースしています。サービスをアップグレードするには、以下の手順に従ってください:
OPCHのアップグレード処理中は、ポッドが停止され、再作成されるため、ダウンタイムが発生します。
-
On-Premise Connector Hostの最新バージョンのDockerイメージを入手してください。
docker pull public.ecr.aws/tulip/connector-host:<TAG>2. 以下のコマンドを実行して、Docker コンテナ ID を取得します。docker ps3.TULIP_FACTORY、TULIP_UUID、およびTULIP_MACHINE_SECRETにアクセスできる場合は、手順 4 に進んでください。アクセスできない場合は、以下のコマンドを実行し、その出力を安全な場所に保存してください。docker exec <container-id> env4. 既存の Docker コンテナを停止します。docker stop <コンテナID>5. 既存の Docker コンテナを削除します。docker rm <コンテナID>6. 保存した認証情報を使用して、標準のDocker runコマンドを実行します。
LTS16 以降の OPCH の場合: docker run -d \ --name tulip-connector-host \ -e TULIP_FACTORY='https://<FACTORY>.tulip.co' \ -e TULIP_UUID='<UUID>' \ -e TULIP_MACHINE_SECRET='<SECRET>' \ -e TULIP_DEVICE_TYPE='onprem' \ -e TULIP_LOGGING_TO_TULIP=true \ -e TULIP_TELEMETRY_TO_TULIP=true \ -e TULIP_CONNECTORS_HTTP_PROXY='' \ -e TULIP_CONNECTORS_HTTPS_PROXY='' \ --restart=always \ --net=host \ public.ecr.aws/tulip/connector-host:<TAG>LTS16以前のOPCHの場合: docker run -d \ --name tulip-connector-host \ -e TULIP_FACTORY='https://<FACTORY>.tulip.co' \ -e TULIP_UUID='<UUID>' \ -e TULIP_MACHINE_SECRET='<SECRET>' \ -e TULIP_DEVICE_TYPE='onprem' \ -e CONNECTORS_HTTP_PROXY='' \ -e CONNECTORS_HTTPS_PROXY='' \ -e EXIT_ON_DISCONNECT=true \ --restart=always \ --net=host \ --mount type=volume,source=tuliplog,target=/log \ public.ecr.aws/tulip/connector-host:<TAG>
-
新しい Docker コンテナが稼働していることを確認します。
docker ps
コネクタの環境を使用してアップグレードをテストする
各コネクタには 3 つの異なる環境(本番、プレ本番、開発)があり、これらの各環境は独自のコネクタホストを持つことができ、バージョンも異なる場合があります。アプリケーションの状態(開発版、承認待ち、公開済み)に応じて、異なる環境を使用できます。コネクタホストの検証を行う際の推奨手順は以下の通りです。1. 開発用 OPCH をアップグレードします。2. 検証用コネクタホストをアップグレードします(ここでは、プレプロダクション環境は開発環境を指します)。 1. コネクタページ、またはアプリケーションの開発モードでコネクタをテストします。3. 検証テストが完了したら、本番用コネクタホストをアップグレードします。
詳細については、「コネクタ環境」を参照してください。
あるいは、開発インスタンス上のOPCHをアップグレードしてから、本番環境を安心してアップグレードすることも可能です。
外部ログ管理ツールへのログ転送
This capability is available for LTS15+ OPCH.
オンプレミスコネクタホストのログをサードパーティ製ツールに転送し、一元的な監視やトラブルシューティングを行うことができます。OPCHは、環境変数を通じてDatadog、Grafana Loki、Splunkをサポートしています。 利用可能なログの種類には、OPCH の健全性(特にファクトリへの接続状況)、コネクタ呼び出しの実行、およびサブスクリプションに関するログが含まれます。OPCH の起動フローの一環として、ユーザーはログの転送先となる外部ログ管理ツールの設定を指定できます。複数のサービスに対する認証情報が追加されている場合、ログはすべてのサービスに送信されます
- 送信先を選択してください
- Datadog:グローバルエンドポイント。APIキーのみが必要です。
- Grafana Loki: 顧客がホストする Loki;URL には基本認証を含めることができます。
- Splunk (HEC): マルチインスタンス;URLとトークンの両方が必要です。
- 環境変数の追加以下の変数を「コネクタホスト」環境に追加してください。選択した送信先に対応する変数のみを使用してください。
Datadog
-TULIP_LOGGING_DATADOG_API_KEY=<your_datadog_api_key>
Grafana Loki
-TULIP_LOGGING_LOKI_URL=https://<user>:<password>@loki.your-domain.com/loki/api/v1/push
(URLに「user:password」を埋め込むことで、Basic認証がサポートされます — オプションです。)
Splunk (HEC)
-TULIP_LOGGING_SPLUNK_URL=https://splunk.your-domain.com:8088/services/collector
-TULIP_LOGGING_SPLUNK_TOKEN=<your_splunk_hec_token>
- コネクタホストを再起動する
新しい環境変数が有効になるよう、サービスを再起動します。
- 配信の確認
アクティビティを生成し(例:コネクタ関数を実行)、ログが送信先に表示されることを確認します:
- Datadog:ホスト名またはサービス名を含む最近のログを確認します。
- Loki: Grafana Explore で、ホストラベルまたは既知のメッセージのサブストリングを指定してクエリを実行します。
- Splunk: ホストからの最近のイベントを検索します(例:
index=<your_index> source="tulip-connector-host")。 - ロギングの変更または無効化
- 宛先を切り替えるには、変数を新しいプロバイダーに合わせて更新し(古いものは削除してください)。
- 無効にするには、ロギング変数を削除し、サービスを再起動してください。
追加情報
Grafana Alloy エクスポーターに基づく実装:
Datadog エクスポーター:https://grafana.com/docs/alloy/next/reference/components/otelcol/otelcol.exporter.datadog/
Splunk HEC エクスポーター: https://grafana.com/docs/alloy/next/reference/components/otelcol/otelcol.exporter.splunkhec/
着信および発信コールの負荷
このセクションでは、OPCHがTulip Cloudに送信するHTTPリクエストの数について説明します。これらのリクエストは、固定レートリクエスト(常時実行)と可変レートリクエスト(設定やアクティビティに依存)に分類できます。
固定レートリクエスト
これらのリクエストは、一定かつ予測可能なレートで発生します:
| タイプ | レート | 説明 |
|---|---|---|
| ハートビート | 6リクエスト/分 | OPCHがオンラインで接続されていることを確認します。 |
| データソースのポーリング | 1分あたり20リクエスト | 定期的に |
| 設定されたデータソースの更新を定期的に確認します。 |
リクエスト頻度は変動します
これらのリクエストは、設定およびアクティビティによって異なります。
変更やイベントの発生頻度が高いほど、リクエストのレートも高くなります。
| タイプ | 一般的なレート |
|---|---|
| マシンデータソースのオンライン状態の変更 | 変更ごとに 1 リクエスト(最大 60 リクエスト/分) |
| コネクタの呼び出し | HTTPコネクタの呼び出しごとに1回の送信リクエスト |
計算例
次のような構成を想定します:-マシンデータソース 1 つ- 500 のマシン属性(各属性が1Hz(1 秒に 1 回)でデータを報告)
最悪ケースのリクエストレート:`レート(最悪ケース) = (6 + 1 + 20) + 40 + 60 + 240 = 367 リクエスト/分
The configurations and online statuses typically change rarely. Also, the OPCH optimizes the number of HTTP requests to the Tulip cloud by batching multiple requests together when needed. As a result, the average rate for the above setup will likely be around 200-270 requests/minute.
その他の参考資料
Docker でのログローテーションを有効にする
Dockerのログローテーションを使用していない既存のオンプレミスConnector Hosts については、ディスク容量が適切に管理されるよう、こちらに記載されている手順に従ってください。
OPCHのヘルス状態を確認する
OPCHをAzureまたはKubernetesベースのサービスオーケストレーターと統合するには、以下の設定を使用できます:
LTS16 以降の OPCH の場合:
OPCHをAzureまたはKubernetesベースのサービスオーケストレーターと統合するには、以下の設定を使用できます。ヘルスチェックエンドポイントはポート上でランダムに割り当てられ、ルートパス/health-check で公開されます。 必要に応じて、TULIP_HEALTH_HTTP_PORT を指定したポートに設定することで、割り当てられたポートを上書きできます。例:TULIP_HEALTH_HTTP_PORT = 80。正常な応答では HTTP ステータスコード204 が返され、OPCH サービスが正常に動作していることを示します。
LTS16以前のOPCHの場合:
OPCHをAzureまたはKubernetesベースのサービスオーケストレーターと統合するには、以下の設定を使用できます。ヘルスチェックエンドポイントを有効にするには、環境変数CONNECTORS_HEALTHZ_SERVER_ENABLED を true に設定する必要があります。このエンドポイントはポート9223で利用可能であり、ルートパス/ で公開されます。必要に応じて、CONNECTORS_PORT を指定したポートに設定することで、デフォルトのポート9223を上書きできます。例:CONNECTORS_PORT = 80
正常な応答では HTTP ステータスコード200 (OK) が返され、OPCH サービスが正常に動作していることを示します。
必要に応じて、CONNECTORS_PORT を指定したポートに設定することで、デフォルトのポート9223を上書きできます。例:CONNECTORS_PORT = 80
正常な応答では、HTTPステータスコード200(OK)が返され、OPCHサービスが正常に動作していることを示します。
