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 プラットフォームでは、チェーンビルダーの設定へのアクセスと、ランナーを管理する権限を付与する役割が必要です。2 つあります：
- チェーンのオーナー：これが必須の主要な役割です。この役割を持つユーザーは、チェーンビルダーの「ダウンロード」セクションにアクセスして最新の GroundRunner インストールファイルを取得し、「ランナー」タブを管理してサービスをアクティブ化または監視できます。
- 組織チェーンセキュリティ管理者：この組織レベルの役割には、複数のワークスペースにわたって接続とランナーを管理する権限もあります。
サーバー上
「手動更新」では、GroundRunner がインストールされている物理マシンまたは仮想マシンでサービスを停止し、実行可能ファイルを置き換えるため、ユーザーはホストサーバーの管理者権限を持っている必要があります。
- Windows：管理者としてコマンドプロンプトを実行し、Windows サービスマネージャーにアクセスして GroundRunner サービスを停止および再起動する機能が必要です。
- Linux/macOS：インストールディレクトリにファイルを移動し、バックグラウンドプロセスを再起動するには、sudoまたはrootアクセス権が必要です。
GroundRunnerのダウンロード
インストールまたはマニュアル更新のためにGroundRunnerをダウンロードするには、次の手順に従います。
- Workiva ホームのサイドバーで、チェーン をクリックします。
- チェーンビルダーのサイドバー（これは新規タブです）で、 Connections をクリックします。
または、右上のユーザープロフィールアイコンをクリックし、チェーン管理者を選択し、次にワークスペース設定を選択することもできます。 - 上部メニューバーのダウンロード をクリックします。
- お使いのオペレーティングシステムの GroundRunner を検索し、ダウンロード をクリックします。
- ダウンロードが正常に完了したら、以下の設定から適切なものを選択し、それに従ってGroundRunnerをインストールしてください。
GroundRunnerのインストール
Microsoftインストーラー（MSI）は、.NET 3.5以上が必要です。
この要件を満たせない場合は、代わりにコマンドラインインターフェイスを使用して GroundRunner をインストールする必要があります。
GroundRunner をインストールするには：
- GroundRunner.zip を新規フォルダに解凍し、フォルダを開きます。
- GroundRunner.msiを実行して、GroundRunner セットアップウィザードを開きます。
-
次をクリックします。
- 使用許諾契約の条項を確認して承認し、[次へ]をクリックします。
- 宛先フォルダに、GroundRunner をインストールするパスを入力し（例：
C:\Program Files\GroundRunner\）、次へをクリックします。 - プラットフォーム企業トークンに、企業トークンを入力します。
- プラットフォーム認証ホストで、次の操作を行ないます。
- 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）
プロキシサーバーをバイパスするには、プロキシなしのホストにホストのカンマ区切りリストを入力します。 - 次へ、インストール、終了 をクリックする。
- インストール後、Windows サービスマネージャーから GroundRunner を右クリックし、開始を選択します。
GroundRunner のインストールが完了し、アクティベーションの準備が整いました。
コマンドラインインターフェイスを介してインストールするには、GroundRunner のインストールファイルをプログラムファイル内の独自のディレクトリ（例：c:\Program Files (x86)\wdata）にダウンロードする必要があります。その後、インストールファイルを解凍し、そのディレクトリのルートに展開できます。
その後、GroundRunner をインストールできます。
-
Windows のコマンドウィンドウで、次のように入力します。
c:\Program Files (x86)\wdata\installer.exe installすべてのデフォルト設定を受け入れます。
-
init システムとして「windows」を選択します。
自動更新をサポートするには、GroundRunner が Windows サービスとして動作するように指定する必要があります。テスト目的の場合を除き、GroundRunner はサービスとしてのみ実行する必要があります。
- パスについては、新しいディレクトリ内に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 サービスマネージャーで、GroundRunnerサービスを開始します。
- コマンドダイアログで、
-
フォアグラウンドプロセスとして実行している場合は、コマンドダイアログで次のように入力します：
cd c:\Program Files (x86)\wdata GroundRunner.exe
- サービスとして実行する場合は、以下のいずれかを行う：
これで GroundRunner がインストールされ、アクティベーションの準備ができました。
ステップ1：GroundRunnerをインストールする
-
GroundRunner のインストールファイルを独自のディレクトリにダウンロードします（
例：/home/user_name/wdata/）。メモ：「/home/user_name/wdata」は一例です。サービスのインストール場所については、組織のポリシーに従ってください。
-
コマンドダイアログで、次を使用してインストールファイルを解凍します：
unzip 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実行可能ファイルがGroundRunnerバイナリではなく、GroundRunnerMonitorバイナリを指していることを確認してください。 -
Restart=alwaysを設定します。 -
StartLimitBurstまたはStartLimitIntervalSecは設定しないでください。これらは、一時的なエラーによる GroundRunner の再起動を妨げる可能性があります。GroundRunner が高速な再起動ループに陥らないようにしたい場合は、RestartSecを設定できます。 -
systemctl enableと入力して、systemd GroundRunner サービスユニットを有効にし、GroundRunner が再起動後も存続するようにします。
Workiva は、GroundRunner をフォアグラウンドプロセスとして実行することを公式にサポートしていません。これは構成のテストには役立つかもしれませんが、GroundRunner の構成が完了したら、長時間実行されるバックグラウンドプロセスとして設定する必要があります。
macOS での GroundRunner の運用（テストのみ）
Workiva は、テスト目的でのみmacOS 上の GroundRunner をサポートします。macOS の GroundRunner は Linux および Windows 版と同じコマンドを実行できますが、Workiva は launchd を有効なサービスマネージャーとして公式にサポートしていません。これは、Apple 社が 2022 年に macOS サーバーソフトウェアのサポートを終了したためです。Apple 社のノートパソコンやデスクトップコンピュータは、GroundRunner の実行には適していません。
GroundRunnerの起動
GroundRunnerをインストールしたら、チェーンビルダーでアクティベートする必要があります。
- チェーンビルダーのサイドバーで、 Connections をクリックします。
- 上部のRunners をクリックし、Pending Registration をクリックします。
- ランナーの短く分かりやすい名前を入力します。
例：「<データソース>-GroundRunner」。 - 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/<ユーザー名>/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プラットフォームのコンポーネントをサポートするサブドメイン。 |
許可リストの権限付与にワイルドカード（*）を使用できない場合は、お使いの地域の「マザーシップ」ドメインを使用して GroundRunner リソースのダウンロードを許可し、将来の潜在的なブロッキングの問題を回避してください。
| ドメイン | 目的 |
|---|---|
|
|
必要なチェーンリソースをダウンロードするためのサブドメイン。 |
セキュリティ
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またはネットワークチームにログと構成のレビューを依頼してください。 |