部署准备

硬件

下表列出部署 KaiwuDB 所需的硬件规格。

项目	要求
CPU 和内存	单节点配置建议不低于 4 核 8G。对于数据量大、复杂的工作负载、高并发和高性能场景，建议配置更高的 CPU 和内存资源以确保系统的高效运行。
磁盘	- 推荐使用 SSD 或者 NVMe 设备，尽量避免使用 NFS、CIFS、CEPH 等共享存储。 - 磁盘必须能够实现 500 IOPS 和 30 MB/s 处理效率。 - 使用 HDD 硬盘部署单机版本时，避免设备数过多或每秒写入测点数过高，否则数据写入性能将显著下降 - KaiwuDB 系统自身启动不会占用过多磁盘容量（低于 1G）。实际所需磁盘大小主要取决于用户的业务量。
文件系统	建议使用 ext4 文件系统。

操作系统

KaiwuDB 支持在以下操作系统进行安装部署：

操作系统	版本	裸机部署	裸机部署	容器部署	容器部署
		ARM64	x86_64	ARM64	x86_64
Anolis	7			✓	✓
	8	✓	✓	✓	✓
CentOS	7				✓
	8				✓
Debian	V11			✓
KylinOS	V10 SP2	✓	✓	✓	✓
	V10 SP3 2303	✓	✓
	V10 SP3 2403	✓	✓	✓	✓
openEuler	24.03				✓
Ubuntu	V20.04	✓	✓	✓	✓
	V22.04	✓	✓	✓	✓
	V24.04	✓	✓	✓	✓
UOS	1050e			✓	✓
	1060e			✓	✓
	1070e	✓	✓	✓	✓
Windows Server	WSL2		✓		✓

说明

容器部署需要目标机器已安装 Docker。如未安装，请参考 Docker 官方安装文档open in new window 进行安装。对于无法联网的环境，可下载 Docker 二进制包进行离线安装，详见 Docker 离线安装指南open in new window。
未提及的操作系统版本也许可以运行 KaiwuDB，但尚未得到 KaiwuDB 官方支持。

软件依赖

裸机部署

下表列出需要在目标机器安装的依赖：

依赖	版本	说明
OpenSSL	v1.1.1+	N/A
libprotobuf	v3.6.1 ~ v21.x	Ubuntu 18.04 版本默认的 libprotobuf 版本低于所需版本，用户需要在部署前提前安装高版本的 libprotobuf 或者使用安装包内提供的高版本 libprotobuf 完成安装。具体操作说明，参见为 Ubuntu 18.04 安装 libprotobuf。
GEOS	v3.3.8+	可选依赖
xz-libs	v5.2.0+	N/A
libgcc	v7.3.0+	N/A
libgflags	系统默认	N/A
libkrb5	系统默认	N/A

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

为 Ubuntu 18.04 安装 libprotobuf

说明

以下步骤仅适用于 Ubuntu 18.04 操作系统。

检查当前系统中是否已安装 libprotobuf 及其版本是否符合要求（3.6.1 及以上版本）。

dpkg -l | grep libprotobuf

如果未安装 libprotobuf，手动安装 packages 目录下的 libprotobuf 文件。
```
dpkg -i ./libprotobuf23_3.12.4_amd64.deb
```
如果系统中已经安装了 libprotobuf，但版本低于 3.6.1：
1. 查看 libprotobuf 版本的相关依赖：
```
apt-cache rdepends <libprotobuf_package>
```
2. 确认没有其他重要包依赖于当前版本后，手动安装 packages 目录下的 libprotobuf 文件。
```
dpkg -i ./libprotobuf23_3.12.4_amd64.deb
```

容器部署

使用脚本或 YAML 文件部署时，目标机器需已安装 Docker Compose（1.20.0 及以上版本）。

在线安装：参考 Docker Compose 官方安装文档open in new window
离线安装：参考 Docker Compose 离线安装指南open in new window
Ubuntu/Debian 系统快速安装：
```
sudo apt-get install docker-compose
```

端口要求

下表列出 KaiwuDB 服务默认使用的端口。如需使用其他端口，可在安装部署过程中进行修改。

端口号	说明
`8080`	数据库 Web 服务端口
`26257`	数据库服务端口和对外连接端口

安装包和可视化安装程序

根据不同的使用场景，获取安装包或可视化安装程序：

安装包：适用于生产环境部署和具备 Linux 操作经验的用户。支持脚本、YAML 文件、Docker Run 命令和 kwbase CLI 四种部署方式，可灵活配置集群参数，具备完整的命令行管理功能。
可视化安装程序：适用于初学者和偏好图形化操作的用户。通过直观的向导界面简化部署流程，降低技术门槛，使用前需确保目标机器具备图形化桌面环境支持。

安装包

获取系统环境对应的安装包，将安装包复制到待安装 KaiwuDB 的目标机器上，然后解压缩安装包：

tar -zxvf <package_name>

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

文件	说明
`add_user.sh`	安装、启动 KaiwuDB 后，为 KaiwuDB 数据库创建用户。
`deploy.cfg`	安装部署配置文件，用于配置部署节点的 IP 地址、端口等配置信息。
`deploy.sh`	安装部署脚本，用于安装、卸载、启动、状态获取、关停和重启等操作。
`packages` 目录	存放 DEB、RPM、Docker 镜像包和 libprotobuf 包。说明：具体包含的文件因安装包类型而异。
`utils` 目录	存放工具类脚本。

可视化安装程序

获取系统环境对应的可视化向导安装程序（.AppImage 格式），复制到待安装 KaiwuDB 的目标机器上。

许可证文件

已联系open in new window KaiwuDB 技术支持人员，获取 .lic 格式的 KaiwuDB 许可证文件。

# 部署准备

# 硬件

# 操作系统

# 软件依赖

# 裸机部署

# 为 Ubuntu 18.04 安装 libprotobuf

# 容器部署

# 端口要求

# 安装包和可视化安装程序

# 安装包

# 可视化安装程序

# 许可证文件