跳至主要內容

AINode 部署

大约 14 分钟

AINode 部署

AINode介绍

能力介绍

AINode 是 IoTDB 在 ConfigNode、DataNode 后提供的第三种内生节点，该节点通过与 IoTDB 集群的 DataNode、ConfigNode 的交互，扩展了对时间序列进行机器学习分析的能力，支持从外部引入已有机器学习模型进行注册，并使用注册的模型在指定时序数据上通过简单 SQL 语句完成时序分析任务的过程，将模型的创建、管理及推理融合在数据库引擎中。目前已提供常见时序分析场景（例如预测与异常检测）的机器学习算法或自研模型。

交付方式

是 IoTDB 集群外的额外套件，独立安装包，独立激活（如需试用或使用，请联系天谋科技商务或技术支持）。

部署模式

安装准备

安装包获取

用户可以下载AINode的软件安装包，下载并解压后即完成AINode的安装。

解压后安装包（iotdb-enterprise-ainode-<version>.zip），安装包解压后目录结构如下：

目录类型说明
lib文件夹AINode编译后的二进制可执行文件以及相关的代码依赖
sbin文件夹AINode的运行脚本，可以启动，移除和停止AINode
conf文件夹包含AINode的配置项，具体包含以下配置项
LICENSE文件证书
NOTICE文件提示
README_ZH.md文件markdown格式的中文版说明
README.md文件使用说明

环境准备

  • 建议操作环境: Ubuntu, CentOS, MacOS

  • 运行环境

    • 联网环境下 Python >= 3.8即可，且带有 pip 和 venv 工具；非联网环境下需要使用 Python 3.8版本，并从 此处 下载对应操作系统的zip压缩包（注意下载依赖需选择libs文件夹中的zip压缩包，如下图），并将文件夹下的所有文件拷贝到 iotdb-enterprise-ainode-<version> 文件夹中 lib 文件夹下，并按下文步骤启动AINode。

    • 环境变量中需存在 Python 解释器且可以通过 python 指令直接调用

    • 建议在 iotdb-enterprise-ainode-<version> 文件夹下，新建 Python 解释器 venv 虚拟环境。如安装 3.8.0 版本虚拟环境，语句如下：

      # 安装3.8.0版本的venv，创建虚拟环境，文件夹名为 `venv`
../Python-3.8.0/python -m venv `venv`

安装部署及使用

安装 AINode

  1. AINode 激活

要求 IoTDB 处于正常运行状态，且 license 中有 AINode 模块授权（通常 license 中不具有 AINode 授权，可联系天谋商务或技术支持人员获取 AINode 模块授权）。

激活 AINode 模块授权方式如下：

  • 方式一：激活文件拷贝激活

    • 重新启动 confignode 节点后，进入 activation 文件夹， 将 system_info 文件复制给天谋工作人员，并告知工作人员申请 AINode 独立授权；
    • 收到工作人员返回的 license 文件；
    • 将 license 文件放入对应节点的 activation 文件夹下；

  • 方式二：激活脚本激活

    • 获取激活所需机器码，进入安装目录的 sbin 目录，执行激活脚本：
        cd sbin 
  ./start-activate.sh
    • 显示如下信息，请将机器码（即该串字符）复制给天谋工作人员，并告知工作人员申请 AINode 独立授权：
      Please copy the system_info's content and send it to Timecho:
01-KU5LDFFN-PNBEHDRH
Please enter license:
    • 将工作人员返回的激活码输入上一步的命令行提示处 Please enter license:，如下提示：
      Please enter license:
Jw+MmF+AtexsfgNGOFgTm83BgXbq0zT1+fOfPvQsLlj6ZsooHFU6HycUSEGC78eT1g67KPvkcLCUIsz2QpbyVmPLr9x1+kVjBubZPYlVpsGYLqLFc8kgpb5vIrPLd3hGLbJ5Ks8fV1WOVrDDVQq89YF2atQa2EaB9EAeTWd0bRMZ+s9ffjc/1Zmh9NSP/T3VCfJcJQyi7YpXWy5nMtcW0gSV+S6fS5r7a96PjbtE0zXNjnEhqgRzdU+mfO8gVuUNaIy9l375cp1GLpeCh6m6pF+APW1CiXLTSijK9Qh3nsL5bAOXNeob5l+HO5fEMgzrW8OJPh26Vl6ljKUpCvpTiw==
License has been stored to sbin/../activation/license
Import completed. Please start cluster and excute 'show cluster' to verify activation status

  • 更新 license 后，重新启动 DataNode 节点，进入 IoTDB 的 sbin 目录下，启动 datanode：

      cd sbin
  ./start-datanode.sh   -d   #-d参数将在后台进行启动
    1. 检查Linux的内核架构
      uname -m
    1. 导入Python环境下载

    推荐下载py311版本应用，导入至用户根目录下 iotdb专用文件夹 中

    1. 切换至iotdb专用文件夹安装Python环境

    以 Miniconda3-py311_24.5.0-0-Linux-x86_64 为例：

      bash ./Miniconda3-py311_24.5.0-0-Linux-x86_64.sh

    根据提示键入“回车”、“长按空格”、“回车”、“yes”、“yes”

    关闭当前SSH窗口重新连接

    1. 创建专用环境
      conda create -n ainode_py python=3.11.9

    根据提示键入“y”

    1. 激活专用环境
      conda activate ainode_py
    1. 验证Python版本
      python --version
    1. 下载导入AINode到专用文件夹，切换到专用文件夹并解压安装包
      unzip iotdb-enterprise-ainode-1.3.3.2.zip
    1. 配置项修改
      vi iotdb-enterprise-ainode-1.3.3.2/conf/iotdb-ainode.properties

    配置项修改：详细信息

    ain_seed_config_node=iotdb-1:10710（集群通讯节点IP:通讯节点端口）

    ain_inference_rpc_address=iotdb-3（运行AINode的服务器IP）

    1. 更换Python源
      pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
    1. 启动AINode节点
      nohup bash iotdb-enterprise-ainode-1.3.3.2/sbin/start-ainode.sh  > myout.file 2>& 1 &

    回到系统默认环境：conda deactivate

配置项修改

AINode 支持修改一些必要的参数。可以在 conf/iotdb-ainode.properties 文件中找到下列参数并进行持久化的修改：

名称描述类型默认值改后生效方式
cluster_nameAINode 要加入集群的标识stringdefaultCluster仅允许在第一次启动服务前修改
ain_seed_config_nodeAINode 启动时注册的 ConfigNode 地址String127.0.0.1:10710仅允许在第一次启动服务前修改
ain_inference_rpc_addressAINode 提供服务与通信的地址 ，内部服务通讯接口String127.0.0.1仅允许在第一次启动服务前修改
ain_inference_rpc_portAINode 提供服务与通信的端口String10810仅允许在第一次启动服务前修改
ain_system_dirAINode 元数据存储路径，相对路径的起始目录与操作系统相关，建议使用绝对路径Stringdata/AINode/system仅允许在第一次启动服务前修改
ain_models_dirAINode 存储模型文件的路径，相对路径的起始目录与操作系统相关，建议使用绝对路径Stringdata/AINode/models仅允许在第一次启动服务前修改
ain_logs_dirAINode 存储日志的路径，相对路径的起始目录与操作系统相关，建议使用绝对路径Stringlogs/AINode重启后生效
ain_thrift_compression_enabledAINode 是否启用 thrift 的压缩机制，0-不启动、1-启动Boolean0重启后生效

启动 AINode

在完成 Seed-ConfigNode 的部署后，可以通过添加 AINode 节点来支持模型的注册和推理功能。在配置项中指定 IoTDB 集群的信息后，可以执行相应的指令来启动 AINode，加入 IoTDB 集群。

联网环境启动

启动命令
  # 启动命令
  # Linux 和 MacOS 系统
  bash sbin/start-ainode.sh  

  # Windows 系统
  sbin\start-ainode.bat  

  # 后台启动命令（长期运行推荐）
  # Linux 和 MacOS 系统
  nohup bash sbin/start-ainode.sh  > myout.file 2>& 1 &

  # Windows 系统
  nohup bash sbin\start-ainode.bat  > myout.file 2>& 1 &
详细语法
  # 启动命令
  # Linux 和 MacOS 系统
  bash sbin/start-ainode.sh  -i <bin_path>  -r  -n

  # Windows 系统
  sbin\start-ainode.bat  -i <bin_path>  -r  -n
参数介绍：
名称标签描述是否必填类型默认值输入方式
ain_interpreter_dir-iAINode 所安装在的虚拟环境的解释器路径，需要使用绝对路径否String默认读取环境变量调用时输入或持久化修改
ain_force_reinstall-r该脚本在检查 AINode 安装情况的时候是否检查版本，如果检查则在版本不对的情况下会强制安装 lib 里的 whl 安装包否Boolfalse调用时输入
ain_no_dependencies-n指定在安装 AINode 的时候是否安装依赖，如果指定则仅安装 AINode 主程序而不安装依赖。否Boolfalse调用时输入

如不想每次启动时指定对应参数，也可以在 conf 文件夹下的ainode-env.sh 和 ainode-env.bat 脚本中持久化修改参数（目前支持持久化修改 ain_interpreter_dir 参数）。

ainode-env.sh :

 # The defaulte venv environment is used if ain_interpreter_dir is not set. Please use absolute path without quotation mark
 # ain_interpreter_dir=

ainode-env.bat :

  @REM The defaulte venv environment is used if ain_interpreter_dir is not set. Please use absolute path without quotation mark
  @REM set ain_interpreter_dir=

在写入参数值的后解除对应行的注释并保存即可在下一次执行脚本时生效。

示例

直接启动：
  # 启动命令
  # Linux 和 MacOS 系统
  bash sbin/start-ainode.sh
  # Windows 系统
  sbin\start-ainode.bat 


  # 后台启动命令（长期运行推荐）
  # Linux 和 MacOS 系统
  nohup bash sbin/start-ainode.sh  > myout.file 2>& 1 &
  # Windows 系统
  nohup bash sbin\start-ainode.bat  > myout.file 2>& 1 &
更新启动：

如果 AINode 的版本进行了更新（如更新了 lib 文件夹），可使用此命令。首先要保证 AINode 已经停止运行，然后通过 -r 参数重启，该参数会根据 lib 下的文件重新安装 AINode。

  # 更新启动命令
  # Linux 和 MacOS 系统
  bash sbin/start-ainode.sh -r
  # Windows 系统
  sbin\start-ainode.bat -r


  # 后台更新启动命令（长期运行推荐）
  # Linux 和 MacOS 系统
  nohup bash sbin/start-ainode.sh -r > myout.file 2>& 1 &
  # Windows 系统
  nohup bash sbin\start-ainode.bat -r > myout.file 2>& 1 &

非联网环境启动

启动命令
  # 启动命令
  # Linux 和 MacOS 系统
  bash sbin/start-ainode.sh  

  # Windows 系统
  sbin\start-ainode.bat  

  # 后台启动命令（长期运行推荐）
  # Linux 和 MacOS 系统
  nohup bash sbin/start-ainode.sh  > myout.file 2>& 1 &

  # Windows 系统
  nohup bash sbin\start-ainode.bat  > myout.file 2>& 1 &
详细语法
  # 启动命令
  # Linux 和 MacOS 系统
  bash sbin/start-ainode.sh  -i <bin_path>  -r  -n

  # Windows 系统
  sbin\start-ainode.bat  -i <bin_path>  -r  -n
参数介绍：
名称标签描述是否必填类型默认值输入方式
ain_interpreter_dir-iAINode 所安装在的虚拟环境的解释器路径，需要使用绝对路径否String默认读取环境变量调用时输入或持久化修改
ain_force_reinstall-r该脚本在检查 AINode 安装情况的时候是否检查版本，如果检查则在版本不对的情况下会强制安装 lib 里的 whl 安装包否Boolfalse调用时输入

注意：非联网环境下安装失败时，首先检查是否选择了平台对应的安装包，其次确认python版本为3.8（由于下载的安装包限制了python版本，3.7、3.9等其他都不行）

示例

直接启动：
  # 启动命令
  # Linux 和 MacOS 系统
  bash sbin/start-ainode.sh
  # Windows 系统
  sbin\start-ainode.bat 


  # 后台启动命令（长期运行推荐）
  # Linux 和 MacOS 系统
  nohup bash sbin/start-ainode.sh  > myout.file 2>& 1 &
  # Windows 系统
  nohup bash sbin\start-ainode.bat  > myout.file 2>& 1 &

检测 AINode 节点状态

AINode 启动过程中会自动将新的 AINode 加入 IoTDB 集群。启动 AINode 后可以在 命令行中输入 SQL 来查询，集群中看到 AINode 节点，其运行状态为 Running（如下展示）表示加入成功。

IoTDB> show cluster
+------+----------+-------+---------------+------------+-------+-----------+
|NodeID|  NodeType| Status|InternalAddress|InternalPort|Version|  BuildInfo|
+------+----------+-------+---------------+------------+-------+-----------+
|     0|ConfigNode|Running|      127.0.0.1|       10710|UNKNOWN|190e303-dev|
|     1|  DataNode|Running|      127.0.0.1|       10730|UNKNOWN|190e303-dev|
|     2|    AINode|Running|      127.0.0.1|       10810|UNKNOWN|190e303-dev|
+------+----------+-------+---------------+------------+-------+-----------+

停止 AINode

如果需要停止正在运行的 AINode 节点，则执行相应的关闭脚本。

停止命令

  # Linux / MacOS 
  bash sbin/stop-ainode.sh

  #Windows
  sbin\stop-ainode.bat
详细语法
  # Linux / MacOS 
  bash sbin/stop-ainode.sh  -t<AINode-id>

  #Windows
  sbin\stop-ainode.bat  -t<AINode-id>
参数介绍：
名称标签描述是否必填类型默认值输入方式
ain_remove_target-tAINode 关闭时可以指定待移除的目标 AINode 的 Node ID、地址和端口号，格式为<AINode-id>否String无调用时输入

示例

  # Linux / MacOS 
  bash sbin/stop-ainode.sh

  # Windows
  sbin\stop-ainode.bat

停止 AINode 后，还可以在集群中看到 AINode 节点，其运行状态为 UNKNOWN（如下展示），此时无法使用 AINode 功能。

IoTDB> show cluster
+------+----------+-------+---------------+------------+-------+-----------+
|NodeID|  NodeType| Status|InternalAddress|InternalPort|Version|  BuildInfo|
+------+----------+-------+---------------+------------+-------+-----------+
|     0|ConfigNode|Running|      127.0.0.1|       10710|UNKNOWN|190e303-dev|
|     1|  DataNode|Running|      127.0.0.1|       10730|UNKNOWN|190e303-dev|
|     2|    AINode|UNKNOWN|      127.0.0.1|       10790|UNKNOWN|190e303-dev|
+------+----------+-------+---------------+------------+-------+-----------+

如果需要重新启动该节点，需重新执行启动脚本。

移除 AINode

当需要把一个 AINode 节点移出集群时，可以执行移除脚本。移除和停止脚本的差别是：停止是在集群中保留 AINode 节点但停止 AINode 服务，移除则是把 AINode 节点从集群中移除出去。

移除命令

  # Linux / MacOS 
  bash sbin/remove-ainode.sh  

  # Windows
  sbin\remove-ainode.bat
详细语法
  # Linux / MacOS 
  bash sbin/remove-ainode.sh  -i<bin_path>  -t<AINode-id>  -r  -n

  # Windows
  sbin\remove-ainode.bat  -i<bin_path>  -t<AINode-id>  -r  -n
参数介绍：
名称标签描述是否必填类型默认值输入方式
ain_interpreter_dir-iAINode 所安装在的虚拟环境的解释器路径，需要使用绝对路径否String默认读取环境变量调用时输入+持久化修改
ain_remove_target-tAINode 关闭时可以指定待移除的目标 AINode 的 Node ID、地址和端口号，格式为<AINode-id>否String无调用时输入
ain_force_reinstall-r该脚本在检查 AINode 安装情况的时候是否检查版本，如果检查则在版本不对的情况下会强制安装 lib 里的 whl 安装包否Boolfalse调用时输入
ain_no_dependencies-n指定在安装 AINode 的时候是否安装依赖，如果指定则仅安装 AINode 主程序而不安装依赖。否Boolfalse调用时输入

如不想每次启动时指定对应参数，也可以在 conf 文件夹下的ainode-env.sh 和 ainode-env.bat 脚本中持久化修改参数（目前支持持久化修改 ain_interpreter_dir 参数）。

ainode-env.sh :

 # The defaulte venv environment is used if ain_interpreter_dir is not set. Please use absolute path without quotation mark
 # ain_interpreter_dir=

ainode-env.bat :

  @REM The defaulte venv environment is used if ain_interpreter_dir is not set. Please use absolute path without quotation mark
  @REM set ain_interpreter_dir=

在写入参数值的后解除对应行的注释并保存即可在下一次执行脚本时生效。

示例

直接移除：
# Linux / MacOS 
bash sbin/remove-ainode.sh

# Windows
sbin\remove-ainode.bat

移除节点后，将无法查询到节点的相关信息。

IoTDB> show cluster
+------+----------+-------+---------------+------------+-------+-----------+
|NodeID|  NodeType| Status|InternalAddress|InternalPort|Version|  BuildInfo|
+------+----------+-------+---------------+------------+-------+-----------+
|     0|ConfigNode|Running|      127.0.0.1|       10710|UNKNOWN|190e303-dev|
|     1|  DataNode|Running|      127.0.0.1|       10730|UNKNOWN|190e303-dev|
+------+----------+-------+---------------+------------+-------+-----------+
指定移除：

如果用户丢失了 data 文件夹下的文件，可能 AINode 本地无法主动移除自己，需要用户指定节点号、地址和端口号进行移除，此时我们支持用户按照以下方法输入参数进行删除。

# Linux / MacOS 
bash sbin/remove-ainode.sh -t <AINode-id>/<ip>:<rpc-port>

# Windows
sbin\remove-ainode.bat -t <AINode-id>/<ip>:<rpc-port>

常见问题

启动AINode时出现找不到venv模块的报错

当使用默认方式启动 AINode 时，会在安装包目录下创建一个 python 虚拟环境并安装依赖，因此要求安装 venv 模块。通常来说 python3.8 及以上的版本会自带 venv，但对于一些系统自带的 python 环境可能并不满足这一要求。出现该报错时有两种解决方案（二选一）：

在本地安装 venv 模块，以 ubuntu 为例，可以通过运行以下命令来安装 python 自带的 venv 模块。或者从 python 官网安装一个自带 venv 的 python 版本。

apt-get install python3.8-venv

安装 3.8.0 版本的 venv 到 AINode 里面 在 AINode 路径下

../Python-3.8.0/python -m venv venv(文件夹名）

在运行启动脚本时通过 -i 指定已有的 python 解释器路径作为 AINode 的运行环境，这样就不再需要创建一个新的虚拟环境。

python中的SSL模块没有被正确安装和配置，无法处理HTTPS资源

WARNING: pip is configured with locations that require TLS/SSL, however the ssl module in Python is not available.
可以安装 OpenSSLS 后，再重新构建 python 来解决这个问题

Currently Python versions 3.6 to 3.9 are compatible with OpenSSL 1.0.2, 1.1.0, and 1.1.1.

Python 要求我们的系统上安装有 OpenSSL，具体安装方法可见链接

sudo apt-get install build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev uuid-dev lzma-dev liblzma-dev
sudo -E ./configure --with-ssl
make
sudo make install

pip版本较低

windows下出现类似“error：Microsoft Visual C++ 14.0 or greater is required...”的编译问题

出现对应的报错，通常是 c++版本或是 setuptools 版本不足，可以在

./python -m pip install --upgrade pip
./python -m pip install --upgrade setuptools

安装编译python

使用以下指定从官网下载安装包并解压:

.wget https://www.python.org/ftp/python/3.8.0/Python-3.8.0.tar.xz
tar Jxf Python-3.8.0.tar.xz

编译安装对应的 python 包:

cd Python-3.8.0
./configure prefix=/usr/local/python3
make
sudo make install
python3 --version

Copyright © 2024 The Apache Software Foundation.
Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries

Have a question? Connect with us on QQ, WeChat, or Slack. Join the community now.