可视化向导部署

本节介绍如何使用可视化向导界面部署 KaiwuDB 集群。部署时,系统将对配置文件、运行环境、硬件配置和软件依赖进行检查。如果相应硬件未能满足要求,系统将继续安装,并提示硬件规格不满足要求。如果软件依赖未能满足要求,系统将中止安装,并提供相应的提示信息。

如果部署时出现错误,用户可以通过查看终端输出、界面提示或安装目录中的日志文件,获取详细的错误信息。

前提条件

  • 待部署节点满足裸机部署要求容器部署要求
  • 安装用户为 root 用户或者拥有 sudo 权限的普通用户。
    • root 用户和配置 sudo 免密的普通用户在执行部署脚本时无需输入密码。
    • 未配置 sudo 免密的普通用户在执行部署脚本时,需要输入密码进行提权。
  • 使用容器版本且安装用户为非 root 用户时,需要通过 sudo usermod -aG docker $USER 命令将用户添加到 docker 组。
  • 已获取对应系统版本的 KaiwuDB 可视化向导安装程序(.AppImage 格式)。

步骤

如需部署 KaiwuDB,遵循以下步骤。

  1. 登录待部署节点,复制安装程序到安装目录。

  2. 为安装程序添加执行权限:

    chmod +x KaiwuDB-*.AppImage
    
  3. 使用以下命令或双击启动安装程序:

    • root 用户

      ./KaiwuDB-*.AppImage
      
    • 普通用户

      sudo ./KaiwuDB-*.AppImage
      
  4. 在欢迎页面点击下一步

  5. 在操作选择页面,点击下一步

  6. 在参数配置页面,设置以下参数,然后点击下一步

    • 安全模式选项:启用后,KaiwuDB 将自动生成证书,存放在 /etc/kaiwudb/certs 目录,作为客户端或应用程序连接数据库的凭证
    • 服务端口
    • HTTP 端口
    • bRPC 端口
    • 数据目录
    • 用户创建选项:如果跳过,系统将默认使用部署数据库时的用户,且无需密码访问数据库
  7. 在部署模式页面,勾选单副本集群模式三副本集群模式,点击设置节点列表

  8. 在节点列表对话框中,点击新增节点

  9. 在新增节点对话框中,设置节点 IP 地址、SSH 用户和端口。建议配置 SSH 免密登录以简化部署流程。

  10. 完成至少 3 个节点设置后,关闭节点列表对话框,点击下一步

  11. 在安装页面,等待安装完成,然后根据需要选择:

    • 点击下一步,进入数据库参数页面。

    • 设置启动参数, 然后点击提交。KaiwuDB 支持设置多个启动参数,用空格分隔。三副本集群支持的参数列表参见kwbase start,单副本集群支持的参数列表参见kwbase start

    • 安装页面

    • 设置启动参数页面

  12. 在数据库参数页面,点击输入license, 在许可证验证窗口输入许可证代码,然后点击提交

  13. (可选)点击设置集群参数按钮,根据需要设置集群参数值。KaiwuDB 支持的集群参数列表参见实时参数

  14. 点击结束完成集群部署。部署完成后,即可进行以下操作:

    • (可选)配置 KaiwuDB 开机自启动

      systemctl enable kaiwudb
      
    • 通过 kwbase 命令或 KaiwuDB 支持的其他方式连接数据库: