可视化 GUI 模式部署

可视化 GUI 模式提供轻量化跨平台图形界面,支持鼠标操作和表单式参数配置,适用于带图形化环境的服务器或桌面端。

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

WARNING

以下环境不支持可视化模式:

  • CentOS
  • openEuler
  • KylinOS V10 SP3 2403 LoongArch_64 架构

前提条件

系统要求

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

用户权限要求

  • 安装用户为 root 用户或拥有 sudo 权限的普通用户。

    • root 用户和配置 sudo 免密的普通用户在执行安装程序时无需输入密码。
    • 未配置 sudo 免密的普通用户在执行安装程序时,需要输入密码进行提权。
  • 使用容器安装程序部署时,如果安装用户为非 root 用户,需要通过以下命令将用户添加到 docker 组:

    sudo usermod -aG docker $USER
    

步骤

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

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

    sudo ./KaiwuDB-*.run -g
    # 或者
    sudo ./KaiwuDB-*.run --graph
    
  3. 在操作向导页面,选中全新安装,点击下一步

  4. 在用户许可页面,阅读并勾选同意许可协议,点击下一步

  5. 在参数配置页面,设置安装参数,完成后点击下一步

    参数说明
    开启安全模式默认不开启安全模式。
    勾选开启安全模式后选择安全协议:
    - TLS:启用 TLS 安全模式。
    - TLCP:启用 TLCP 安全模式。
    开启安全模式后,KaiwuDB 自动生成相应证书,存放于 /etc/kaiwudb/certs 目录。
    HTTP 端口KaiwuDB Web 服务端口,默认为 8080
    KaiwuDB 服务端口KaiwuDB 服务端口,默认为 26257
    BRPC 端口时序引擎间的 BRPC 通信端口,单节点部署时系统会自动忽略该设置,默认为 27257
    数据目录KaiwuDB 数据目录,默认为 /var/lib/kaiwudb
  6. 在节点管理页面,选择单机模式,点击增加节点,填写本机节点 IP、端口、用户名和密码,点击保存,确认连接状态为正常后,根据需要选择是否为所有用户安装,然后点击下一步

  7. 在开始安装页面,等待安装完成。可点击详细信息查看执行的具体命令及输出结果。如果安装过程中出现错误,也可通过查看安装目录 log 目录下的日志文件获取详细信息。

  8. 安装完成后,根据需要选择是否立即启动 KaiwuDB:

    • 勾选启动 KaiwuDB:点击结束后,系统启动成功后将显示 14 天试用期提示,建议及时完成激活,具体激活步骤,参见许可证管理

    • 不勾选:点击结束直接退出安装程序,后续需手动启动 KaiwuDB:

      systemctl start kaiwudb
      
  9. 查看服务或节点状态:

    # 查看服务状态
    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 表示节点处于异常状态。
  10. (可选)配置 KaiwuDB 开机自启动。

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