1、硬件

如下为部署 KWDB 所需的硬件规格：

Tip：实际部署时，用户可以根据实际的业务规模和性能要求规划硬件资源。

2、操作系统

KWDB 支持在以下服务器操作系统进行安装部署。

Tip：如使用上述未提及的操作系统，可能会存在问题，可及时与我们联系解决。

3、软件依赖

安装时，KWDB 会对依赖进行检查。如果缺少依赖会退出安装并提示依赖缺失。如果目标机器不能联网，用户需要在能联网的机器上根据目标机器的操作系统下载好所有依赖文件，然后将依赖文件复制到目标机器上进行安装。

不同操作系统及安装包的依赖略有不同，请根据实际安装包类型及操作系统，在部署前安装好相应的依赖。下表列出需要在目标机器安装的依赖：

4、端口要求

5、安装包处理

tar -zxvf <package_name>

解压后生成的目录包含以下文件：

部署 KWDB 时，系统首先将对配置文件、运行环境、硬件配置和软件依赖进行检查：

• 如果相应硬件未能满足要求，系统将继续安装，并提示硬件规格不满足要求；

在部署过程中，系统会自动生成相关日志。如果部署时出现错误，用户可以通过查看终端输出或 KWDB 安装目录中 log 目录里的日志文件，获取详细的错误信息。

部署完成后，系统会将 KWDB 封装成系统服务（名称为 kaiwudb），并生成以下文件：

• kaiwudb.service：配置 KWDB 的 CPU 资源占用率；

• kaiwudb.service：配置 KWDB 启动参数。

  
  

总结在部署前，首先要先确定：

• 待部署节点的硬件、操作系统、软件依赖和端口满足安装部署要求；

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

详细部署步骤如下：

（1）登录待部署节点，编辑安装包目录下的 deploy.cfg 配置文件，设置安全模式、管理用户、服务端口等信息。

默认情况下，deploy.cfg 配置文件中包含集群配置参数，需删除或注释 [cluster] 集群配置项。

配置文件示例：

[global]secure_mode=ymanagement_user=kaiwudbrest_port=8080kaiwudb_port=26257data_root=/var/lib/kaiwudbcpu=1[local]node_addr=192.168.64.128# [cluster]# node_addr=192.168.64.129, 192.168.64.130# ssh_port=22# ssh_user=admin

相应参数说明：

• global：全局配置

• secure_mode：是否开启安全模式，默认开启安全模式。开启安全模式后，KWDB 生成 TLS 安全证书，作为客户端或应用程序连接数据库的凭证。生成的客户端相关证书存放在 /etc/kaiwudb/certs 目录；

• management_user：KWDB 的管理用户，默认为 kaiwudb。安装部署后，KWDB 创建相应的管理用户以及和管理用户同名的用户组；

• rest_port：KWDB Web 服务端口，默认为 8080；

• kaiwudb_port：KWDB 服务端口，默认为 26257；

• data_root：数据目录，默认为 /var/lib/kaiwudb；

• cpu: 可选参数，用于指定 KWDB 服务占用当前节点服务器 CPU 资源的比例，默认无限制。取值范围为 [0,1]，最大精度为小数点后两位。

  
  

• local：本地节点配置

• node_addr：本地节点对外提供服务的 IP 地址，监听地址为 0.0.0.0，端口为 KWDB 服务端口。

（2）为 deploy.sh 脚本添加运行权限。

chmod +x ./deploy.sh

（3）执行单机部署安装命令。

./deploy.sh install --single

执行成功后，控制台输出以下信息：

INSTALL COMPLETED: KaiwuDB has been installed successfuly! ...

（4）启动 KWDB 节点。

./deploy.sh start

执行成功后，控制台输出以下信息：

START COMPLETED: KaiwuDB has started successfuly! ...

Tip：在 KylinOS 操作系统中，系统可能会提示输入用户密码。此时，无需输入密码，直接按回车键确认即可。 

（5）查看 KWDB 节点状态。

./deploy.sh status

或者

systemctl status kaiwudb

（6）配置 KWDB 开机自启动。

配置 KWDB 开机自启动后，如果系统重启，则自动启动 KWDB。

systemctl enable kaiwudb

如下为部署 KWDB 所需的硬件规格：

Tip：实际部署时，用户可以根据实际的业务规模和性能要求规划硬件资源。

2、操作系统

KWDB 容器镜像支持在以下已安装 Docker 的操作系统中进行安装部署。

3、软件依赖

sudo apt-get install docker-compose

4、端口要求

5、安装包处理

tar -zxvf <install_package_name>

解压后生成的目录包含以下文件：

部署 KWDB 时，系统首先将对配置文件、运行环境、硬件配置和软件依赖进行检查：

在部署过程中，系统会自动生成相关日志。如果部署时出现错误，用户可以通过查看终端输出或 KWDB 安装目录中 log 目录里的日志文件，获取详细的错误信息。

部署完成后，系统生成 /etc/kaiwudb/ 目录。Docker Compose 配置文件 docker-compose.yml 位于 /etc/kaiwudb/ｓｃｒｉｐｔ 目录下。

部署完成后，用户可以修改 Docker Compose 配置文件 docker-compose.yml，配置 KWDB 的启动参数和 CPU 资源占用率。

有关定制化部署配置的详细信息，参见配置集群（https://gitee.com/kwdb/docs/blob/2.0/deployment/docker/cluster-config-docker.md）。

我们支持使用安装脚本和 YAML（.yml）文件两种方式部署 KWDB。安装脚本部署支持安全模式和非安全模式。 使用 YAML（.yml）文件进行部署时，仅支持非安全模式，登录 KWDB 数据库时需使用非安全连接模式。

总结在部署前，首先要先确定：

• 待部署节点的硬件、操作系统、软件依赖和端口满足安装部署要求；
• 安装用户为 root 用户或者拥有 sudo 权限的普通用户：root 用户和配置 sudo 免密的普通用户在执行部署脚本时无需输入密码；未配置 sudo 免密的普通用户在执行部署脚本时，需要输入密码进行提权；
• 安装用户为非 root 用户时，需要通过 sudo usermod -aG docker $USER 命令将用户添加到 docker 组。

使用安装脚本部署 KWDB：

（1）登录待部署节点，编辑安装包目录下的 deploy.cfg 配置文件，设置安全模式、管理用户、服务端口等信息。

默认情况下，deploy.cfg 配置文件中包含集群配置参数，需删除或注释 [cluster] 集群配置项。

配置文件示例：

[global]secure_mode=ymanagement_user=kaiwudbrest_port=8080kaiwudb_port=26257data_root=/var/lib/kaiwudbcpu=1[local]node_addr=192.168.64.128# [cluster]# node_addr=192.168.64.129, 192.168.64.130# ssh_port=22# ssh_user=admin

相关参数说明：

• global：全局配置

• secure_mode：是否开启安全模式，默认开启安全模式。开启安全模式后，KWDB 生成 TLS 安全证书，作为客户端或应用程序连接数据库的凭证。生成的客户端相关证书存放在 /etc/kaiwudb/certs 目录；

• management_user：KWDB 的管理用户，默认为 kaiwudb。安装部署后，KWDB 创建相应的管理用户以及和管理用户同名的用户组；

• rest_port：KWDB Web 服务端口，默认为 8080;

• kaiwudb_port：KWDB 服务端口，默认为 26257;

• data_root：数据目录，默认为 /var/lib/kaiwudb;

• cpu: 可选参数，用于指定 KWDB 服务占用当前节点服务器 CPU 资源的比例，默认无限制。取值范围为 [0,1]，最大精度为小数点后两位。

  
  

• local：本地节点配置

• node_addr：本地节点对外提供服务的 IP 地址，监听地址为 0.0.0.0，端口为 KWDB 服务端口。

（2）为 deploy.sh 脚本添加运行权限。

chmod +x ./deploy.sh

（3）执行单机部署安装命令。

./deploy.sh install --single

（4）执行成功后，控制台输出以下信息：

INSTALL COMPLETED: KaiwuDB has been installed successfuly! ...

（5）启动 KWDB 节点。

./deploy.sh start

执行成功后，控制台输出以下信息：

START COMPLETED: KaiwuDB has started successfuly! ...

（6）查看 KWDB 节点状态。

./deploy.sh status

或者

systemctl status kaiwudb

（7）配置 KWDB 开机自启动（可选）。

配置 KWDB 开机自启动后，如果系统重启，则自动启动 KWDB。

systemctl enable kaiwudb

使用 YAML 文件部署 KWDB ：

（1）在 kaiwudb_install/packages 目录下导入 KaiwuDB.tar 文件，获取镜像名称。

# docker load < KaiwuDB.tarLoaded image: "path-to-your-docker-image"

（2）创建 docker-compose.yml 配置文件。

配置文件示例：

version: '3.3'services:  kaiwudb-container:    image: "path-to-your-docker-image"    container_name: kaiwudb-experience    hostname: kaiwudb-experience    ports:      - 8080:8080      - 26257:26257    ulimits:      memlock: -1    volumes:      - /dev:/dev    networks:       - default    restart: on-failure    ipc: shareable    privileged: true    environment:      - LD_LIBRARY_PATH=/kaiwudb/lib    tty: true    working_dir: /kaiwudb/bin    command:       - /bin/bash      - -c      - |        /kaiwudb/bin/kwbase start-single-node --insecure --listen-addr=0.0.0.0:26257 --advertise-addr=127.0.0.1:26257 --http-addr=0.0.0.0:8080 --store=/kaiwudb/deploy/kaiwudb

image 参数的取值必须是导入 KaiwuDB.tar 文件后获取的镜像名称。

（3）运行以下命令，快速启动 KWDB。

docker-compose up -d

（4）配置 KWDB 开机自启动（可选）。

配置 KWDB 开机自启动后，如果系统重启，则自动启动 KWDB。

systemctl enable kaiwudb