命令行模式部署

命令行模式通过文本菜单逐步引导完成安装,支持数字输入进行选择操作,无需额外依赖,适用于无图形化环境。

安装过程中内置参数实时校验,配置有误时自动提示重新输入,支持安全模式与非安全模式,部署完成后可选择立即启动数据库。

前提条件

系统要求

  • 待部署节点的硬件、操作系统和软件依赖满足部署准备要求。
  • 已获取 KaiwuDB 安装程序(.run 文件)。

用户权限要求

  • 安装用户为 root 用户或已配置 sudo 免密的普通用户。

  • 使用容器安装程序部署时,如果安装用户为非 root 用户,需要通过以下命令将用户添加到 docker 组:

    sudo usermod -aG docker $USER
    

步骤

  1. 登录待部署节点,将 .run 安装程序复制到安装目录,并赋予执行权限:

    chmod +x KaiwuDB-*.run
    
  2. 执行以下命令,以命令行模式启动安装程序:

    ./KaiwuDB-*.run -c
    # 或者
    ./KaiwuDB-*.run --cli
    
  3. 安装程序启动后,进入主功能菜单,输入 1 选择安装 KaiwuDB:

    1. 安装 KaiwuDB
    2. 卸载 KaiwuDB
    3. 安装 KaiwuDB 并加入集群
    4. 升级节点
    5. 退出
    
    请输入操作 [1-5]:
    
  4. 输入 1 选择单机模式:

    1. 单机安装
    2. 单副本集群
    3. 三副本集群
    4. 返回主菜单
    
    请选择 [1-4]:
    
  5. 安装程序自动生成配置文件模板并打开编辑器。根据实际环境修改各参数,保存并退出后,安装程序将自动开始安装。

    配置文件示例:

    [global]
    # 是否开启安全模式
    secure_mode=tls
    # adminui 端口
    rest_port=8080
    # 数据库服务端口
    kaiwudb_port=26257
    # 数据传输端口
    brpc_port=27257
    # 数据目录
    data_root=/var/lib/kaiwudb
    
    [node1]
    host=127.0.0.1
    # ssh 连接端口
    port=22
    # ssh 连接用户
    user=admin
    # ssh 连接密码
    passwd=*******
    

    参数说明:

    参数说明
    secure_mode安全模式,支持以下取值:
    - insecure:非安全模式。
    - tls:(默认)TLS 安全模式。
    - tlcp:TLCP 安全模式。
    开启安全模式后,KaiwuDB 自动生成相应证书,存放于 /etc/kaiwudb/certs 目录。
    rest_portKaiwuDB Web 服务端口,默认为 8080
    kaiwudb_portKaiwuDB 服务端口,默认为 26257
    brpc_port时序引擎间的数据传输端口,单节点部署时系统会自动忽略该设置,默认为 27257
    data_root数据目录,默认为 /var/lib/kaiwudb
    host本地节点 IP 地址。
    portSSH 连接端口。
    userSSH 连接用户。
    passwdSSH 连接密码。
  6. 选择是否为所有用户安装 KaiwuDB:

    是否为所有用户安装:(y/N)
    
  7. 安装过程中终端会实时显示安装进度。出现错误时,可以通过查看安装目录 log 目录下的日志文件获取详细信息。

  8. 完成安装后,根据提示选择是否立即启动数据库:

    是否启动数据库:(y/N)
    
    • 输入 y:系统自动启动并初始化 KaiwuDB,启动完成后将显示 14 天试用期提示,建议及时完成激活,具体激活步骤,参见许可证管理

    • 输入 N:跳过启动,后续需手动启动 KaiwuDB。

      systemctl start kaiwudb
      
  9. 在主功能菜单,输入 5 退出部署流程。

  10. 查看服务或节点状态:

    # 查看服务状态
    systemctl status kaiwudb
    
    # 查看节点状态
    kw-status
    

    节点状态返回字段说明:

    字段描述
    id节点 ID。
    address节点地址。
    sql_addressSQL 地址。
    build节点运行的 KaiwuDB 版本。
    started_at节点启动的日期和时间。
    updated_at节点状态更新的日期和时间。节点正常时,每 10 秒左右记录一次新状态;节点异常时,更新信息可能会有所滞后。
    locality节点 ID。
    start_mode节点启动模式。
    is_available / is_live均为 true 表示节点处于正常状态;均为 false 表示节点处于异常状态。
  11. (可选)配置 KaiwuDB 开机自启动。

    systemctl enable kaiwudb
    
  12. 执行 kw-sql 使用数据库部署用户登录数据库或者通过以下任一方式连接和管理 KaiwuDB: