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 をクリックします。
または、右上のユーザープロファイルのアイコンをクリックし、Chains admin を選択し、Workplace Settings を選択することもできます。 - 上部メニューバーのダウンロード をクリックします。
- お使いのオペレーティングシステムの GroundRunner を検索し、ダウンロード をクリックします。
- ダウンロードが正常に完了したら、以下の設定から適切なものを選択し、それに従ってGroundRunnerをインストールしてください。
GroundRunnerのインストール
Microsoftインストーラー(MSI)は、.NET 3.5以上が必要です。
この条件を満たせない場合は、代わりにコマンドラインインターフェイスを使用してGroundRunnerをインストールする必要があります。
GroundRunner をインストールするには:
- GroundRunner.zip を新規フォルダに解凍し、フォルダを開きます。
- GroundRunner.msi を実行し、GroundRunner セットアップウィザードを開きます。
- 次をクリックします。
- 使用許諾契約の条項を確認して承認し、[次へ]をクリックします。
- インストール先フォルダには、GroundRunner をインストールするパスを入力し(例:
C:∕Program FilesGroundRunner∕)、Next をクリックします。
- Platform の企業トークン に、の企業トークン を入力してください。
- プラットフォーム認証ホストで、次の操作を行ないます。
- 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とポートをProxy host に入力してください。
(例えば、http://yourproxy:3000。)
プロキシサーバーをバイパスするには、No proxy host の下に、カンマで区切ったホストのリストを入力する。 - 次へ、インストール、終了 をクリックする。
- インストールが完了したら、Windows サービスマネージャから GroundRunner を右クリックし、Start を選択します。
GroundRunner のインストールが完了し、アクティベーションの準備が整いました。
コマンドラインインタフェースでインストールするには、GroundRunnerのインストールをプログラムファイル内の専用ディレクトリにダウンロードする必要があります(例:c:˶Program Files (x86)˶wdata )。その後、インストールファイルを解凍し、そのディレクトリのルートに解凍します。
その後、GroundRunnerをインストールすることができます:
- Windowsのコマンドウィンドウで、
と入力し、すべてのデフォルトを受け入れます。c:˶Program Files (x86)˶wdatainstaller.exeインストール- initシステムに "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 の場合は、
- 会社トークン を入力してください。
- initシステムに "windows "を選択する。
- 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サービスとして実行する方法については、各OSのドキュメントおよび組織ポリシーを参照してください。
基本的な構成では、自動アップデートが正しく動作するために、以下のsystemdユニットファイルが必要です:
-
ExecStart実行ファイルが、GroundRunnerMonitorバイナリを指しており、
GroundRunnerバイナリを指していないことを確認してください。 - Set
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を公式にサポートしていない。これは、アップルが2022年にmacOSサーバーソフトウェアのサポートを打ち切ったためだ。アップルのノートパソコンやデスクトップパソコンは、GroundRunnersの実行には適していません。
GroundRunnerの起動
GroundRunnerをインストールしたら、チェーンビルダーでアクティベートする必要があります。
- チェーンビルダーのサイドバーで、 Connections をクリックします。
- 上部のRunners をクリックし、Pending Registration をクリックします。
- ランナーの名前を短く説明して入力してください。
例えば、"<データソース>-GroundRunner"。
- [有効化]をクリックします。
GroundRunnerを手動で更新する
ほとんど必要ありませんが、GroundRunnerのマニュアルアップグレードが必要になる場合があります。
この方法については、Workiva サポートページGroundRunner Manual update を参照してください。
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プラットフォームのコンポーネントをサポートするサブドメイン。 |
セキュリティ
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またはネットワークチームにログと構成のレビューを依頼してください。 |