部署
本文介绍如何部署因子开发管理平台(下文称因子平台)。
/home/dolphindb/server
为例分别进行介绍,部署时请替换为实际目录。部署过程无需中止 DolphinDB
进程,可在线部署。单节点模式部署
当 DolphinDB 以单节点模式部署时,因子平台按照以下步骤部署。
解压文件
使用以下命令,在 /home/dolphindb/server/
将压缩包解压:
cd /home/dolphindb/server/
unzip Starfish_V3.00.0.zip
解压后的内容如下:
Starfish_V3.00.0.zip
├── modules
│ └── starfish
│ ├── facplfBasic.dom
│ ├── facplf.dom
│ ├── facplfEnv.dom
│ └── facplfRun.dom
├── starfish
│ └── init
│ ├── init.dos
│ └── internalTemplate.bin
├── starfish_manual.pdf
└── web
└── starfish
安装及加载必备插件
因子平台中包含策略回测等功能,需要预先下载安装及加载插件 Backtest 和 MatchingEngineSimulator。
通过 GUI、VSCode、Web 或 API 执行以下脚本:
installPlugin("Backtest")
installPlugin("MatchingEngineSimulator")
loadPlugin("Backtest")
loadPlugin("MatchingEngineSimulator")
初始化
通过运行 init
目录下的 init.dos 完成初始化。
若本次为首次部署因子平台,可通过 GUI、VSCode、Web 或 API 执行以下脚本完成初始化:
run("/home/dolphindb/server/starfish/init/init.dos")
若此前已部署过 Alpha 版本因子平台,本次为版本升级,请联系技术支持。
增加配置项
初始化成功后,为确保后续节点重启顺利,应在配置文件 dolphindb.cfg 中增加配置项:
preloadModules=plugins::Backtest,plugins::MatchingEngineSimulator
集群模式部署
当 DolphinDB 以集群模式部署时,因子平台按照以下步骤部署。
解压文件
使用以下命令,在 /home/dolphindb/server
将压缩包解压:
cd /home/dolphindb/server/
unzip Starfish_V3.00.0.zip
压缩包中的内容如下:
Starfish_V3.00.0.zip
├── modules
│ └── starfish
│ ├── facplfBasic.dom
│ ├── facplf.dom
│ ├── facplfEnv.dom
│ └── facplfRun.dom
├── starfish
│ └── init
│ ├── init.dos
│ └── internalTemplate.bin
├── starfish_manual.pdf
└── web
└── starfish
文件分发
将解压后的文件按照以下要求置于对应目录,其中 <HomeDir> 可以通过函数 getHomeDir()
获得:
- modules 目录下所有内容置于每个数据节点和计算节点的 modules 目录下:
- 如果在配置文件中配置了某节点的 moduleDir 为某一绝对路径,则 moduleDir 即为该节点的 modules 目录。
- 如果在配置文件中配置了某节点的 moduleDir 为某一相对路径,则 <HomeDir>/moduleDir 即为该节点的 modules 目录。
- 否则,<HomeDir>/modules 为该节点的 modules 目录。
- starfish 目录置于每个数据节点和计算节点的 <HomeDir> 目录下。
例如 dnode1 可通过以下命令实现(目标路径请根据实际情况替换):
cd /home/dolphindb/server/
cp -r starfish ./clusterDemo/data/dnode1/
cp -r modules/starfish ./clusterDemo/data/dnode1/modules/
以上操作中,modules 目录的分发需要对每个数据节点和计算节点执行一次,starfish 目录只需在某一个节点执行一次。
安装及加载必备插件
因子平台中包含策略回测等功能,需要预先下载安装及加载插件 Backtest 和 MatchingEngineSimulator。
通过 GUI、VSCode、Web 或 API 在所有控制节点、数据节点、计算节点执行以下脚本:
installPlugin("Backtest")
installPlugin("MatchingEngineSimulator")
loadPlugin("Backtest")
loadPlugin("MatchingEngineSimulator")
初始化
初始化只需在任一数据节点或计算节点执行一次。通过运行 init
目录下的 init.dos 完成初始化。
若本次为首次部署因子平台,可通过 GUI、VSCode、Web 或 API 执行以下脚本完成初始化:
run("/home/dolphindb/server/clusterDemo/data/dnode1/starfish/init/init.dos")
若此前已部署过 Alpha 版本因子平台,本次为版本升级,请联系技术支持。
增加配置项
初始化成功后,为确保后续节点重启顺利,应在所有节点(包括控制节点、数据节点、计算节点)的配置文件(controller.cfg,cluster.cfg)中增加配置项:
preloadModules=plugins::Backtest,plugins::MatchingEngineSimulator
访问因子平台
部署完成后,可通过 http://127.0.0.1:8848/starfish/index.html
访问因子平台。
其中 127.0.0.1
是节点所在服务器的 IP,8848 是节点的端口号,使用时请根据实际情况调整。
对于集群模式部署的因子平台,可通过任一数据节点或计算节点访问。