GroundRunnerは、チェーンコマンドがオンプレミスのシステムや、インターネット経由で使用することができないリモートのデータソースと対話することを可能にします。一般的には、接続データソースをホストしているような専用サーバーに、IT専門家や組織のネットワーク設定に詳しい人がインストールする。
GroundRunner を設定する前に、チェーンビルダーのセキュリ ティアーキテクチャ をレビューすることをお勧めします。
要件
互換性のあるオペレーティングシステムが必要で、GroundRunnerがWindowsユニバーサル命名規則(UNC)パスなどの共有リソースに使用する場合は、十分な権限を持つユーザーアカウントも必要です。
GroundRunnerの初期インストール時には、Javaランタイム環境(JRE)はインストールされません。
セットアップが完了し、GroundRunnerが実行されると、Javaに依存するコマンドを実行するために必要なJREが自動的にダウンロードされます。インストールや管理者の介入は必要なく、取得したJREがホスト上に存在する場合、既存のJREインストールに影響を与えることはありません。
また、特定の JRE の使用を必要とする組織要件がある場合、SHARED_LIBRARY_OVERRIDES 環境変数を設定して、システムインストールを指すようにすることもできます。この場合、GroundRunner は、自動的に Workiva 標準 JRE をダウンロードせず、提供されたシステム JRE インストールを使用します。
Workiva が提供する JRE は、GPL v2 の下でライセンスされており、クラスパス例外 の対象となります。
メモ: Javaインストールでカスタム証明書を使用するには、Using custom certificates with GroundRunners を参照してください。
職務要件
Workivaプラットフォーム上で
Workivaプラットフォームでは、Chain Builderの設定へのアクセス権と、ランナーを管理する権限が付与されたロールが必要です。2つあります:
- チェーン所有者: これが必須の主な役割です。このロールを持つユーザーは、Chain Builder の「ダウンロード」セクションにアクセスして最新の GroundRunner インストールファイルを取得したり、「ランナー」タブを管理してサービスの有効化や監視を行ったりすることができます。
- 組織チェーンのセキュリティ管理者: この組織レベルのロールには、複数のワークスペースにまたがる接続やランナーを管理する権限もあります。
サーバー上で
「手動更新」では、GroundRunnerがインストールされている物理マシンまたは仮想マシン上でサービスを停止し、実行ファイルを置き換える必要があるため、ユーザーはホストサーバー上で管理者権限を持っている必要があります。
- Windows: 管理者としてコマンドプロンプトを実行し、Windows サービス マネージャーにアクセスできる必要があります(GroundRunner サービスを停止および再起動するため)。
- Linux/macOS: ファイルをインストールディレクトリに移動し、バックグラウンドプロセスを再起動するには、、sudo 、またはroot へのアクセス権が必要です。
GroundRunnerのダウンロード
インストールまたはマニュアル更新のためにGroundRunnerをダウンロードするには、次の手順に従います。
- Workiva ホームのサイドバーで、チェーン をクリックします。
- チェーンビルダーのサイドバー(これは新規タブです)で、 Connections をクリックします。
あるいは、右上のユーザープロフィールアイコンをクリックし、「」→「Chains admin」 を選択してから、「」→「Workplace Settings」 を選択することもできます。 - 上部メニューバーのダウンロード をクリックします。
- お使いのオペレーティングシステムの GroundRunner を検索し、ダウンロード をクリックします。
- ダウンロードが正常に完了したら、以下の設定から適切なものを選択し、それに従ってGroundRunnerをインストールしてください。
GroundRunnerのインストール
Microsoftインストーラー(MSI)は、.NET 3.5以上が必要です。
この要件を満たせない場合は、代わりにコマンドラインインターフェースを使用してGroundRunnerをインストールする必要があります。
GroundRunner をインストールするには:
- GroundRunner.zip を新規フォルダに解凍し、フォルダを開きます。
- GroundRunner.msi を実行して、GroundRunner セットアップウィザードを開きます。
-
次をクリックします。
- 使用許諾契約の条項を確認して承認し、[次へ]をクリックします。
- 「Destination Folder」には、GroundRunner をインストールするパスを入力します(例:
C:\Program Files\GroundRunner\)。次に、「」をクリックし、「Next」 をクリックします。 - プラットフォームの会社トークン( )に、の会社トークン( )を入力してください。
- プラットフォーム認証ホストで、次の操作を行ないます。
- APACの場合は、
h.apac.wdesk.com/s/chains-reaperを入力してください。 - カナダの場合は、
h.ca.wdesk.com/s/chains-reaperを入力してください。 - EMEAの場合は、
h.eu.wdesk.com/s/chains-reaperを入力してください。 - 米国、中米、南米の場合は、
h.app.wdesk.com/s/chains-reaperを入力してください。
- APACの場合は、
- プロキシサーバーを使用する場合は、の「プロキシホスト」欄( )に、そのURLとポート番号を入力してください。
(例:、http://yourproxy:3000、。)
プロキシサーバーをバイパスするには、の「No proxy host」の下に、カンマ区切りでホストのリストを入力してください。 - 次へ、インストール、終了 をクリックする。
- インストールが完了したら、Windows サービス マネージャーで「GroundRunner」を右クリックし、「」を選択して、「 」を起動してください。
GroundRunner のインストールが完了し、アクティベーションの準備が整いました。
コマンドラインインターフェースからインストールするには、GroundRunnerのインストールファイルを、プログラムファイル内の専用ディレクトリにダウンロードする必要があります(例:c:\Program Files (x86)\wdata )。その後、インストールファイルを解凍し、そのディレクトリのルートに展開してください。
その後、GroundRunner をインストールできます:
-
Windows のコマンドプロンプトで、次のように入力します。
c:\Program Files (x86)\wdata\installer.exe をインストールそして、すべてのデフォルト設定を受け入れます。
-
初期化システムとして「Windows」を選択してください。
自動更新に対応させるには、GroundRunner を Windows サービスとして動作させるよう指定する必要があります。GroundRunnersは、テスト目的の場合を除き、サービスとしてのみ実行してください。
- パスについては、新しいディレクトリ「
」内に、「Files 」フォルダを作成してください(例:C:\Program Files (x86)\Wdata\Files)。 - 認証ホスト名(AUTH_HOST)の場合:
- APACの場合は、
h.apac.wdesk.com/s/chains-reaperを入力してください。 - カナダの場合は、
h.ca.wdesk.com/s/chains-reaperを入力してください。 - EMEAの場合は、
h.eu.wdesk.com/s/chains-reaperを入力してください。 - 米国、中米、南米の場合は、
h.app.wdesk.com/s/chains-reaperを入力してください。
- APACの場合は、
- の会社トークン「 」を入力してください。
-
- GroundRunner実行ディレクトリ以外のすべてのファイルを削除します。
- GroundRunnerをサービスとして実行するか、フォアグラウンドプロセスとして実行するかを選択します。
- サービスとして実行する場合は、以下のいずれかを行う:
- コマンドダイアログで、「
sc start GroundRunner」と入力します。 - Windows Service Manager で、「GroundRunner」サービスを開始します。
- コマンドダイアログで、「
-
フォアグラウンドプロセスとして実行する場合は、コマンドダイアログに以下を入力してください:
cd c:\Program Files (x86)\wdata GroundRunner.exe
- サービスとして実行する場合は、以下のいずれかを行う:
GroundRunnerのインストールが完了し、アクティベーションの準備が整いました。
ステップ1:GroundRunnerをインストールする
-
GroundRunnerのインストールファイルを、
のような専用のディレクトリにダウンロードしてください。例:/home/user_name/wdata/。注: "/home/user_name/wdata" は一例として挙げたものです。サービスの設置場所については、所属組織の方針に従ってください。
-
コマンドダイアログで、次のコマンドを使用してインストールファイルを解凍します:
GroundRunner.zip を解凍する - GroundRunnerの詳細を入力してください。
-
を入力し、./installer install を実行します。 - 認証ホスト名(AUTH_HOST)の場合:
- APACの場合は、
h.apac.wdesk.com/s/chains-reaperを入力してください。 - カナダの場合は、
h.ca.wdesk.com/s/chains-reaperを入力してください。 - EMEAの場合は、
h.eu.wdesk.com/s/chains-reaperを入力してください。 - 米国、中米、南米の場合は、
h.app.wdesk.com/s/chains-reaperを入力してください。
- APACの場合は、
- の会社トークン「 」を入力してください。
-
- インストール中に作成されたフォルダを除き、そのディレクトリ内のすべてのファイルを削除してください。
手順 2. GroundRunner を systemd サービスとして設定する(Linux)
GroundRunnerの自動更新を確実に機能させるため、またGroundRunnerを適切な状態に保つために、GroundRunnerは有効化され、再起動可能なsystemdサービスとしてインストールする必要があります。GroundRunner を systemd サービスとして実行する方法については、お使いのオペレーティングシステムのドキュメントおよび組織のポリシーをご参照ください。
基本的な設定において、自動更新が正常に機能するためには、以下の systemd ユニットファイルの要件を満たす必要があります:
-
のExecStartに指定されている実行ファイルが、のGroundRunnerMonitorバイナリを指していることを確認してください。のGroundRunnerバイナリを指していないようにしてください。 -
Restart=alwaysを設定します。 -
、StartLimitBurst、、StartLimitIntervalSecは設定しないでください。これらを設定すると、一時的なエラーが発生した際に GroundRunner が再起動できなくなる可能性があります。GroundRunnerが高速な再起動ループに陥らないようにしたい場合は、RestartSecを設定してください。 -
を入力し、systemctl enableを実行して、systemd の GroundRunner サービスユニットを有効にし、再起動後も GroundRunner が動作し続けるようにします。
Workivaでは、GroundRunnerをフォアグラウンドプロセスとして実行することについて、公式にはサポートしていません。これは設定のテストには役立つかもしれませんが、GroundRunnerの設定が完了したら、長期稼働型のバックグラウンドプロセスとして設定すべきです。
macOS での GroundRunners の動作(テスト目的のみ)
Workivaは、テスト目的のみとして、macOS上のGroundRunnersをサポートしています。 。macOS版のGroundRunnersでは、Linux版やWindows版と同じコマンドを実行できますが、Workivaはlaunchdを有効なサービスマネージャーとして公式にはサポートしていません。これは、Appleが2022年にmacOSサーバーソフトウェアのサポートを終了したためです。Apple製のノートパソコンおよびデスクトップパソコンは、GroundRunnersの実行には適していません。
GroundRunnerの起動
GroundRunnerをインストールしたら、チェーンビルダーでアクティベートする必要があります。
- チェーンビルダーのサイドバーで、 Connections をクリックします。
- 上部のRunners をクリックし、Pending Registration をクリックします。
- ランナーの、短くわかりやすい名前を入力してください。
例えば、「<datasource>-GroundRunner」など。 - [有効化]をクリックします。
GR セットアップチェックリスト
-
のGroundRunnerMonitor()実行ファイルを実行していますか(のGroundRunner()実行ファイルとは異なります)? -
のGroundRunnerMonitor()を、システムレベルの再起動可能なサービスとして設定しましたか?- Linuxの場合:
Systemd。 - Windowsの場合:
Windows サービス。
- Linuxの場合:
- システムの再起動時に、このサービスは再起動しますか?
- Linuxの場合:
systemctl enable。 - Windowsの場合:スタートアップの種類を「
」の「自動」に設定します。。
- Linuxの場合:
- サポート対象のサーバー用オペレーティングシステム上で動作していますか?
- GroundRunnerの通知機能は有効になっていますか?
GroundRunnerを手動で更新する
ほとんど必要ありませんが、GroundRunnerのマニュアルアップグレードが必要になる場合があります。
その手順については、Workivaのサポートページ()およびGroundRunnerマニュアルの更新情報( )をご参照ください。
GroundRunnerをアンインストールする
GroundRunnerが不要になった場合は、アンインストールする事ができます。
- GroundRunner サービスを停止します。
- サービスとして実行されている場合は、Windows サービス マネージャーを使用するか、コマンド ウィンドウで「
sc stop GroundRunner」と入力してください。 - フォアグラウンドプロセスとして実行されている場合は、、Ctrl+C、 を押してください。
- サービスとして実行されている場合は、Windows サービス マネージャーを使用するか、コマンド ウィンドウで「
- コマンドダイアログで、管理者として「
installer.exe uninstall」と入力します。 - GroundRunnerの実行可能ディレクトリを削除します。
コマンドダイアログで、GroundRunner サービスを停止し、その実行ファイルディレクトリ(例:/home/<username>/wdata/Contents )を削除してください。
カスタムJREのインストール
必要に応じて、独自のJREをインストールしてGroundRunnerをサポートすることができます。この JRE の Java バージョンは、GroundRunner に必要なものと一致している必要があります。Oracle Essbase およびOracle Hyperion Financial Management (HFM) GroundRunner 以外は、すべての GroundRunner で同じ JRE バージョンを使用します。
カスタムJREのインストール方法については、を参照してください。Workivaの共有ライブラリを無効にするには、 を参照してください。
GroundRunnerの構成設定と送信ドメイン
データソースとの通信を有効にするには、GroundRunnerがインストールされているサーバーのファイアウォールのポートを開く必要があります。一部のGroundRunnerの構成設定を変更するには、バイナリがインストールされているディレクトリのGroundRunner.config ファイルを編集します。
| 構成 | 設定 |
|---|---|
| ポート |
0から65535. デフォルトでは、GroundRunnerはポート8821 を使用して相互に通信します。 ただし、異なるサーバー上のGroundRunnerがネットワーク内でコマンド出力を共有する場合にのみ、ポートが必要です。 |
| COMPANY_TOKEN | GroundRunner が別のテナントに構成されていない限り、デフォルトのままにしてください。 |
| LOG_LEVEL | 情報 またはデバッグ |
| プロトコル | デフォルトのままにしておく。 |
| HTTP_PROXY_URL |
プロキシサーバーを使用する場合は、URLとポート(必要な場合)を入力します。 メモ: GroundRunner はプロキシサーバーを使用することができるが、NTLM(New Technology LAN Manager)によって認証されたサーバーは使用できない。代わりに、サーバーのIPアドレスを許可する。 |
| LONG_POLL | プロキシサーバーを使用する場合は、trueに設定すると、ロングポーリングを使用してコマンドを取得するようにランナーが指示されます。パフォーマンスを確保するため、ウェブソケットがプロキシサーバーやファイアウォールでサポートされていない場合にのみ、ロングポーリングを使用してください。 |
| NO_PROXY | プロキシサーバーをバイパスするには、代わりに直接到達するホストのカンマ区切りリストを提供して下さい。共通のパターンに基づいて複数のホストを含めるには、[ * ]のワイルドカードを使用します。 |
| GROUNDRUNNER_CERT |
複数のGroundRunnerを使用し、暗号化された情報を2台目のGroundRunnerに送信したい場合に必要。PORT と併用する必要があります。 また、ランナーをアクティブにする際に、PROTOCOL フィールドをHTTPSとして指定する必要があります。 |
| GROUNDRUNNER_CERT_KEY | 複数のGroundRunnerを使用し、2台目のGroundRunnerから暗号化された情報を受信したい場合に必要。これはPORT と併用する必要があります。 |
| DISABLE_WEBSOCKETS | 変換を実行するにはWebsocketが必要です。無効にすると、変換/トランスフォーメーションを使用するコマンドはすべてスキップされます。 |
メモ: 自己署名証明書には、サブジェクト代替名称(SAN)が必要です。これがない場合、GroundRunnerがファイルをダウンロードしようとすると欠落しているSANを参照するエラーメッセージが表示されます。
ネットワークがアウトバウンドドメインを許可する必要がある場合 、これらは GroundRunner に適用されます:
| ドメイン | 目的 |
|---|---|
|
|
Wdataを含むWorkivaの一般的なサービスの主なサブドメイン。 |
*.wdesk.com |
本番Workivaプラットフォームのメインドメイン。 |
*.*.wdesk.com |
Workivaプラットフォームのコンポーネントをサポートするサブドメイン。 |
セキュリティ
GroundRunnersはデータを収集または集計することはなく、送信中のみデータを保持します。拡張検証(EV)証明書は、DigiCert®を介してGroundRunnerとそのデータソース間のトラフィックを常に暗号化し保護します。
メモ: オンプレミスのデータを保護するために、CloudRunnerはGroundRunnerと出力を共有できますが、GroundRunnerはCloudRunnerとファイル出力を共有できません。
GroundRunnerエラーのトラブルシューティング
チェーン実行時にこのようなエラーが表示される場合は、コマンドのGroundRunnersを確認してください。
ヒント: トラブルシューティングを容易にするために、GroundRunnerのログファイル を自動的にテーブルにダウンロードするチェーンを作成することができます。
| エラーメッセージ | 原因 | 着地点 |
|---|---|---|
| エージェントとの通信に失敗しました。このコマンドは実行されませんでした |
コマンドはGroundRunnerと通信できませんでした。 この場合、GroundRunnerが起動しなかったか、GroundRunnerとチェーンビルダー間でネットワーク障害が発生しました。 |
確認事項:
|
| コマンドに関連するリソースをダウンロードできません。エラーが解決しない場合は、サポートにお問い合わせください。 |
これらのチェーンのコマンドに関連するランナーは、互いに通信することができない。 これは、コマンドが異なるランナーを使用していて、CloudRunnerがGroundRunnerベースのコマンドから出力されたファイルを使用しようとしている場合によく発生します。 |
チェーン内のすべてのコマンドで同じランナーを使用する。 チェーンのコマンドが複数のランナーを必要とする場合、GroundRunnerを持つコマンドがCloudRunnerを使用するコマンドにファイル出力を渡さないことを確認します。 |
Error starting command:exec: "﹑[コネクター].exe﹑: ファイルが存在しません" commandExecutorId=[ID]。 |
マルウェアやウイルス対策アプリケーションがコネクターを誤って識別し、GroundRunnerとの通信を傍受した。 | アプリケーションのスキャンからGroundRunnerのインストールディレクトリを除外します。 |
| 証明書のエラー | 自己署名証明書の使用 |
多くの場合、自己署名証明書を使用してGroundRunner通信を暗号化すると便利です。自己署名証明書を使用している場合は、証明書のCommon Name が、サーバーに使用する URL と一致していることを確認してください。 例えば、GroundRunner がポート 8821 でリッスンしており、ネットワーク |
| エラーによる断続的なチェーン障害: "Connection reset by peer" |
複数のランナーが同じマシンにインストールされている場合、それぞれに固有のGUIDが必要である。 同じGUIDが使われた場合、ランナーが重複して更新ループに入る可能性があり、場合によってはチェーンエラーが発生することがあります。 |
GroundRunnerの完全な再インストールをお勧めします。 |
| GroundRunnerではコマンドがスキップされるが、CloudRunnerでは成功する。 | 変換を実行するにはWebsocketが必要です。ウェブソケットを無効にすると、変換は完全にスキップされます。 | 設定ファイルを開き、DISABLE_WEBSOCKETS=false を設定します。 |
ソケットからの読み込みに失敗しました。接続の再試行: read tcp<IP>:<Port>-><IP>:<Port>: wsarecv:接続されたホストが応答しなかったため、接続に失敗しました。 |
内部ファイアウォールまたはネットワークの問題 | エラーを解決するために、社内のITまたはネットワークチームにログと構成のレビューを依頼してください。 |
read<IP>:<Port>-><IP>:<Port>:wsarecv:既存の接続がリモートホストによって強制的に閉じられました。 |
内部ファイアウォールまたはネットワークの問題 | エラーを解決するために、社内のITまたはネットワークチームにログと構成のレビューを依頼してください。 |