要使链中的命令能够与内部远程数据源交互,IT 管理员或熟悉企业网络和防火墙设置的人员需要在专用服务器上安装和设置 GroundRunner,如托管已连接数据源的服务器。将命令添加到链时,会将其连接分配给 GroundRunner,以便在数据源中执行任务。
提示: 为便于排除故障,您可以创建一个链来自动下载 GroundRunner 的日志文件 到一个表中。
先决条件
GroundRunners 支持部分操作系统,并要求
- Java® 版本 8
注: GroundRunners 目前仅支持 Java 版本 8,不支持 以后的版本。
- 服务器资源有限
要访问 Windows 通用命名规则 (UNC) 路径等共享资源,GroundRunner 还要求用户账户具有访问该资源的适当权限。
Java
如有必要,请从Oracle® 或OpenJDK 下载 Java,并将其安装到 PATH 变量中,以便通过命令提示符中的java
启用全局访问。安装 Java 或编辑其配置后,重新启动服务器。
注意: 安装 Java 时,可能会询问您是安装 Java Development Kit (JDK) 还是 Java Runtime Environment (JRE)。对于 GroundRunners,只需要 JRE。
如果使用自签名证书或非证书颁发机构颁发的证书,请将其导入 Java Keystore 以启用 Java/SSL 安全性:
- 从 IT 管理员处获取用于保护网站安全的证书副本,或从浏览器中导出。
- 将证书复制到 GroundRunner 安装中。
- 在 CLI 中,将证书导入 Java Keystore。例如:
keytool -import -trustcacerts -keystore "C:\Program Files\Java\jre1.8.0_251\lib\security\cacerts" -storepass changeit -noprompt -alias [alias name] -file [path_to_exported_file] -alias [alias name] -file [path_to_exported_file] -lib\security\cacerts
系统要求
GroundRunners 支持这些操作系统,无需依赖外部库:
- Microsoft Windows® Desktop 10,32 位和 64 位
- Microsoft Windows® Server 2012、2012 R2、2016、2019 和 2022
- Linux® Redhat 和 Ubuntu
- macOS® Mojave 或更高版本
虽然 GroundRunners 所需的服务器资源有限,但我们建议至少使用
- 512MB 可用随机存取内存(RAM)
- 100GB 可用磁盘空间
注: 为帮助计算所需磁盘空间,一个包含 5 条命令的命令链,每条命令产生 10MB 的短暂输出,需要 50MB 才能完成。
推荐的主机配置包括配置有以下功能的虚拟机:
- 两到四个处理器
- 8GB 系统内存
- 固态硬盘(SSD)存储设备
注: GroundRunners从不 收集或汇总数据;仅在传输过程中保留数据。扩展验证 (EV) 证书始终通过 DigiCert® 对 GroundRunner 与其数据源之间的流量进行加密和保护。
用户账户
默认情况下,GroundRunners 使用的是本地管理账户,无法充分访问共享驱动器等远程资源。要访问 Windows UNC 路径等共享资源,请使用具有足够权限的用户账户启动 GroundRunner。如果使用的用户账户不是默认的本地系统管理员,请授予其管理 GroundRunner 安装目录的权限,以启用自动更新。
下载 GroundRunners
下载 GroundRunner 进行安装或手动更新:
- 从 Wdata,单击Chain Builder 。
- 在 Chain Builder 中,从侧边栏选择Settings 。
- 单击顶部的Downloads 。
- 找到适用于您操作系统的 GroundRunner,然后单击右侧的Download 。
安装接地转轮
注意: Microsoft 安装程序 (MSI) 需要 .NET 3.5 或更高版本。如果无法满足这一要求,请通过命令行界面 (CLI) 安装 GroundRunner。
步骤 1.安装 GroundRunner
要使用 MSI 安装 .NET 3.5 或更高版本的 Microsoft Windows 桌面或 Windows 服务器的 GroundRunner:
- 下载 GroundRunner,并解压缩
windows_amd64_ground_runner.zip
。 - 要打开 GroundRunner 安装向导,请运行
GroundRunner.msi
,然后单击下一步 。 - 查看并接受许可协议中的条款,然后单击Next 。
- Destination Folder ,输入安装 GroundRunner 的路径,如
C:\Program Files\GroundRunner\
,然后单击Next 。 - 在Platform 公司令牌 中,输入您的公司令牌。
注: 要在Chain Builder 中找到您的公司令牌,请从Admin
中选择Runners ,Downloads 。 - 在Platform auth host 中:
- 如果在北美,请输入
h.app.wdesk.com/s/wdata/oc/app
。 - 如果在欧洲,请输入
h.eu.wdesk.com/s/wdata/oc/app
。 - 如果在亚太地区,请输入
h.apac.wdesk.com/s/wdata/oc/app
。
- 如果在北美,请输入
- 如果使用代理服务器,请执行以下操作之一:
- 要访问代理服务器,请在Proxy host 中输入其有效 URL,必要时包括端口。例如,
http://yourproxy:3000
。 - 要绕过代理服务器,请在No proxy host 中,输入一个以逗号分隔的主机列表,以代替直接连接。
- 要访问代理服务器,请在Proxy host 中输入其有效 URL,必要时包括端口。例如,
- 单击下一步,安装, 和完成 。如果出现 "用户帐户控制 "提示,请单击Yes 以启用安装程序对设备进行更改。
- 在 Windows 服务管理器中,右键单击GroundRunner ,然后选择Start 。
步骤 2.激活 GroundRunner
- 在 Chain Builder 中,从侧边栏选择Settings 。
- 单击顶部的Runners 。
- 在Pending Registration 下,为跑步者输入一个简短的描述性名称,如
<数据源>-GroundRunner
- 单击激活 。
注: 为确保 GroundRunner 可执行文件的完整性,Windows® 安装程序可供下载,并由 Workiva 发行管理团队进行加密签名,作为软件开发生命周期的一部分。
使用命令行界面 (CLI) 为 Microsoft Windows 桌面或 Windows 服务器安装 GroundRunner:
步骤 1.下载 GroundRunner
- 将 GroundRunner 的安装程序下载到程序文件中自己的目录,如
c:\Program Files (x86)\wdata
。 - 解压安装文件,并将文件解压缩到目录根目录:
GroundRunner.exe
GroundRunnerMonitor.exe
installer.exe
步骤 2.安装 GroundRunner
- 从 Windows 命令行界面 (cmd.exe) (CLI),以管理员身份运行命令
c:\Program Files (x86)\wdata\installer.exe install
,并接受所有默认设置。- 关于路径,请在新目录中创建
Files
文件夹,如C:\Program Files (x86)\Wdata\Files
。如果不存在,选择创建。 - 授权主机名 (AUTH_HOST):
- 如果在北美,请输入
h.app.wdesk.com/s/wdata/oc/app
。 - 如果在欧洲,请输入
h.eu.wdesk.com/s/wdata/oc/app
。
- 如果在北美,请输入
- 对于公司令牌,请输入为贵组织生成的值。
注: 要在Chain Builder 中找到您的公司 ID,请从Admin
中选择Runners ,Downloads 。
- 关于路径,请在新目录中创建
- 删除
GroundRunner
可执行目录之外的所有文件。 - 选择将 GroundRunner 作为服务或前台进程运行。
- 如果服务 ,请执行以下操作之一:
- 在 CLI 中输入命令
sc start GroundRunner
。 - 在 Windows 服务管理器中,启动
HostRunner
服务。
- 在 CLI 中输入命令
- 如果前台进程 ,在 CLI 中输入命令:
cd c:\Program Files (x86)\wdata GroundRunner.exe
- 如果服务 ,请执行以下操作之一:
步骤 3.激活 GroundRunner
- 在 Chain Builder 中,从侧边栏选择Settings 。
- 单击顶部的Runners 。
- 在Pending Registration 下,为跑步者输入一个简短的描述性名称,如
<数据源>-GroundRunner
- 单击激活 。
在 Linux 或 macOS 上安装 GroundRunner:
步骤 1.安装 GroundRunner
- 将 GroundRunner 的安装文件下载到自己的目录中,如
/home/
。/wdata/ - 在命令行界面(CLI)中,解压安装文件:
- 对于 Linux,使用
unzip linux_amd64_ground_runner.zip
命令。 - 对于 macOS,请使用
unzip darwin_amd64_ground_runner.zip
命令。
- 对于 Linux,使用
- 输入 GroundRunner 的详细信息。
- 对于 Windows,使用命令
./installer install
。 - 对于 Mac OS,使用命令
./occli install
。 - 授权主机名 (AUTH_HOST):
- 如果在北美,请输入
h.app.wdesk.com/s/wdata/oc/app
。 - 如果在欧洲,请输入
h.eu.wdesk.com/s/wdata/oc/app
。
- 如果在北美,请输入
- 对于公司令牌,请输入为贵组织生成的值。
注: 要在Chain Builder 中找到您的公司 ID,请从Admin
中选择Runners ,Downloads 。
- 对于 Windows,使用命令
- 删除
GroundRunner
可执行目录之外的所有文件。
步骤 2.选择是作为服务运行还是作为前台进程运行
在 CLI 中输入命令,将 GroundRunner 作为后台服务或前台进程运行:
- 如果从默认的操作系统启动程序执行,可以作为后台服务运行。输入:
/home/[username]/wdata/Contents/GroundRunnerMonitor
- 要将其作为前台进程运行并将日志写入控制台,请输入:
cd home/[username]/wdata/Contents sudo ./GroundRunner
- 要将其作为前台进程运行并将日志写入日志文件,请输入:
cd home/[username]/wdata/Contents sudo ./GroundRunnerMonitor
提示: 要停止 GroundRunner 作为前台进程,请按CTRL + C 。
步骤 3.激活 GroundRunner
- 在 Chain Builder 中,从侧边栏选择Settings 。
- 单击顶部的Runners 。
- 在Pending Registration(待注册) 下,为 GroundRunner 输入一个简短的描述性名称,如
。-GroundRunner - 单击激活 。
检查接地转轮的状态
GroundRunners 需要持续的心跳来交换信息,说明如何运行作业和任何相关信息。如果 GroundRunner 离线,它将无法再响应命令,管理员会收到一封警告电子邮件。
要查看地面运行程序的在线/离线状态,请在Chain Builder ,从Admin
,Runners ,查看哪些运行程序Pending Registration ,Active ,或Inactive 。注: 如果网络中断,GroundRunners 会自动尝试重新建立通信。
要查看运行程序的主机操作系统资源状态,请选择其Show status 。
注意: 要查看Linux 服务器上的所有活动 GroundRunner,请在 CLI 中输入此命令:ps -a |grep GroundRunner
。
手动更新 GroundRunner
虽然很少见,但您可能需要手动升级 GroundRunner。
下载并安装最新的 MSI,并卸载之前下载的任何版本。
- 为您的操作系统下载最新的 GroundRunner。
- 在 Windows 服务管理器中,停止 GroundRunner 服务。
- 将下载的 GroundRunner 安装文件移动到它自己的目录下,如
c:\groundrunner_upgrade
- 并解压其文件。 - 将这些解压缩文件复制并粘贴到安装 GroundRunner 二进制文件的位置:
-
GroundRunner.exe
或ocrunner.exe
-
GroundRunnerMonitor.exe
或ocrunnermonitor.exe
-
- 在 Windows 服务管理器中,重新启动 GroundRunner 服务。
- 为您的操作系统下载最新的 GroundRunner。
- 在托管 GroundRunner 的服务器上,导航到服务运行所在的目录。
- 在 CLI 中,停止 GroundRunner 服务。
- 将下载的 GroundRunner 安装文件移动到它自己的目录下,如
/home/
- 并解压文件。/groundrunner_upgrade/ - 将这些解压缩文件复制并粘贴到安装 GroundRunner 二进制文件的目录中:
-
GroundRunner
或ocrunner
-
GroundRunnerMonitor
或ocrunnermonitor
-
- 要重启 GroundRunner 服务,请在 CLI 中输入以下命令:
cd /home/
/wdata/Contents
./GroundRunner
设置 GroundRunner 的环境
默认情况下,GroundRunners 可用于所有工作区和环境。将 GroundRunner 的使用限制在特定环境中:
- 在Chain Builder 中,转到Settings ,然后从 GroundRunner 菜单中选择Edit 。
- 在Runner Restrictions 下,取消选中Global ,然后选择要使用 GroundRunner 的工作空间和环境。
- 单击保存 。
卸载 GroundRunner
如果您不再需要 GroundRunner,可以卸载它。
- 停止 GroundRunner 服务:
- 如果作为服务运行 ,请使用 Windows 服务管理器,或在 CLI 中输入命令
sc stop GroundRunner
。 - 如果作为前台进程运行 ,请按键序
。
- 如果作为服务运行 ,请使用 Windows 服务管理器,或在 CLI 中输入命令
- 在 CLI 中,以管理员身份输入命令
installer.exe uninstall
。 - 删除
GroundRunner
可执行目录。
在 CLI 中,停止 GroundRunner 服务,并删除其可执行目录,如/home/
。
GroundRunner 配置设置和出站域
要与数据源通信,可能需要在安装 GroundRunner 的服务器上打开防火墙端口。要更改某些 GroundRunner 的配置设置,可以编辑二进制文件安装目录下的GroundRunner.config
文件。
注: GroundRunners 可以使用代理服务器,只是而不是 通过新技术局域网管理器 (NTLM) 验证的代理服务器。而不是将服务器的 IP 地址列入白名单。
配置 | 设置 |
---|---|
港口 |
0 至65535 . 默认情况下,GroundRunners 使用8821 端口相互通信。不过,如果不同服务器上的 GroundRunners 在网络内共享命令输出,则需要一个端口, 。 |
公司密码 |
保留为默认值,除非 GroundRunner 配置为不同的租户 |
日志级别 |
info 或debug |
程序 |
保持默认值 |
HTTP_PROXY_URL |
如果使用代理服务器,请输入其有效 URL,必要时包括端口。例如,http://yourproxy:3000 |
龙卷 |
如果使用代理服务器,请设置为true ,以指示运行程序使用长轮询获取命令。为确保性能,如果代理服务器或防火墙不支持网络套接字,请仅使用长轮询 。 |
NO_PROXY |
要绕过代理服务器,请提供以逗号分隔的主机列表,以便直接连接。要根据共同模式包含多个主机,请使用* 通配符。 |
groundrunner_cert |
如果使用一个以上的 GroundRunner 并希望向第二个 GroundRunner 发送加密信息,则需要使用。 还必须与PORT 同时使用。 激活运行程序时,还必须将PROTOCOL 字段指定为 HTTPS。 |
groundrunner_cert_key |
如果使用一个以上的 GroundRunner 并希望从第二个 GroundRunner 接收加密信息,则需要使用。 还必须与PORT 同时使用。 |
请注意,您的自签名证书必须有一个主题替代名称(SAN)。如果没有,当您的 GroundRunner 尝试下载文件时,它会显示一条错误信息,说明缺少 SAN。
如果您的网络必须允许外域 ,这些适用于 GroundRunners:
域名 | 目的 |
---|---|
|
常见 Workiva 服务的主要子域,包括 Wdata |
*.wdesk.com |
Workiva 生产平台的主要领域 |
*.*.wdesk.com |
Workiva 平台支持组件的子域 |
排除 GroundRunner 错误
如果在运行链时收到这些错误,请检查命令的 GroundRunners:
错误信息 | 原因 | 决议 |
---|---|---|
与代理通信失败,此命令未执行 | 命令无法与地面运行程序通信。如果出现这种情况,说明 GroundRunner 没有启动,或者 GroundRunner 和Chain Builder 之间发生了网络中断。 | 验证:
|
无法下载与命令相关的资源。如果错误仍然存在,请联系技术支持。 | 链条上的指令运行程序无法相互通信。当命令使用不同的运行程序时,CloudRunner 会尝试使用从使用 GroundRunner 的命令中输出的文件,这种情况经常发生。注意: 为了确保内部部署数据的安全,CloudRunner 可以与 GroundRunner 共享任何输出,但 GroundRunner 不能与 CloudRunner 共享文件输出。 |
将同一个运行程序用于链中的所有命令,或- 链中的命令需要多个运行程序 - 确保使用 GroundRunners 的命令不会将文件输出传递给使用 CloudRunner 的命令。 |
Error starting command: exec: \"\[connector].exe\": file does not exist" commandExecutorId=[ID] | 恶意软件或杀毒软件错误地识别了连接器,并拦截了它与 GroundRunner 的通信。 | 将 GroundRunner 安装目录排除在应用程序扫描范围之外。 |
证书错误 | 使用自签名证书 | 在许多情况下,使用自签名证书对 GroundRunner 通信进行加密非常方便。如果使用自签名证书,请确保证书的Common Name 与可访问服务器的 URL 匹配。例如,如果 GroundRunner 在 8821 端口监听,并且可以从网络访问服务器localhost ,证书的通用名称 将是localhost 。 |
间歇性链故障,错误信息为: "连接被对等方重置" |
在同一台机器上安装多个运行程序时,每个运行程序都必须有一个唯一的 GUID。 如果使用相同的 GUID,运行程序可能会重叠并进入更新循环,从而导致偶尔的链式故障。 |
我们建议重新安装 GroundRunner。
|