KingbaseES数据库docker部署手册.pdf

KingbaseES 数据库 docker 部署手册 金仓数据库管理系统 KingbaseES 文档版本：V9（V009R001C001B0024） 发布日期：2023 年 10 月 12 日 北京人大金仓信息技术股份有限公司 目 目 录 录 第 1 章 前言 1 1.1 适用读者 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 相关文档 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 术语 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.4 手册约定 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 第 2 章 安装概述 3 2.1 产品简介 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.2 安装模式说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.3 License 说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.4 Docker 说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 第 3 章 安装前准备工作 5 3.1 软件环境要求 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3.2 安装包准备 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3.3 Docker 安装 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3.4 检查和配置环境 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.4.1 检查操作系统信息 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.4.2 检查系统内存与存储空间 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 预安装工作 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.5.1 安装用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.5.2 安装目录 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.5.3 数据目录 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3.5 第 4 章 安装详解 10 4.1 导入镜像 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4.2 运行镜像 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 4.2.1 启动命令 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 4.2.2 使用 docker logs 查看容器脚本执行日志 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 4.2.3 使用-p 选项绑定端口 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4.2.4 使用-v 选项挂载目录 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 设置环境变量 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 4.3 I 4.4 目 录 4.3.1 DB_USER: 数据库用户 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 4.3.2 DB_PASSWORD: 数据库初始密码 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 4.3.3 DB_MODE: 数据库模式 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 4.3.4 NEED_START: 进入容器后是否启动数据库 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 4.3.5 ENABLE_CI: 是否需要配置大小写敏感 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 4.3.6 License.dat 持久化及更换 license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 4.3.7 配置文件持久化及修改配置文件后生效 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 数据库基本操作 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.4.1 启动即运行 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.4.2 ksql 访问访问数据库（密码/免密） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 4.4.3 容器外访问数据库 (需要密码) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 4.4.4 数据库启动和停止 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 第 5 章 安装后检查 18 第 6 章 卸载 20 第 7 章 附录 22 版权声明 23 服务周期承诺 24 II 第 1 章 前言 1 第 章 前言 本文档描述了如何基于 docker 安装和卸载 KingbaseES 数据库，以及安装和卸载的常见问题。 前言部分包含以下主题： • 适用读者 • 相关文档 • 术语 • 手册约定 1.1 适用读者 本文档面向所有使用 KingbaseES 的用户，主要是数据库管理员和应用程序开发人员。 1.2 相关文档 • 有关 ksql 的更多信息，请参阅《KingbaseES ksql 工具用户指南及参考》 • 有关 initdb 的更多信息，请参阅《KingbaseES 服务器应用参考手册》 1.3 术语 Docker: docker 是一个开源的应用容器引擎，让开发者可以打包他们的应用以及依赖包到一个可移植的容器中，然 后发布到任何流行的 Linux 或 Windows 操作系统的机器上，也可以实现虚拟化，容器是完全使用沙箱机 制，相互之间不会有任何接口。 1 第 1 章 前言 1.4 手册约定 本文档中可能出现“注意、提示、警告、另请参阅”等标志，它们所代表的含义如下： 注意: 用于突出重要/关键信息、最佳实践等。 提示: 用于突出小窍门、捷径等。 警告: 用于传递设备或环境安全警示信息，若不避免，可能会导致设备损坏、数据丢失、设备性能降低或其 它不可预知的结果。 另请参阅: 用于突出参考、参阅等。 以下程序代码书写约定适用于本文档： 符号 说明 [] 表示包含一个或多个可选项。不需要输入中括号本身。 {} 表示包含两个以上（含两个）的候选，必须在其中选取一个。不需要输入花括号本身。 ${} 表示 {} 中间的值为变量，可根据不同情况产生变化。 | 分割中括号或者花括号中的两个或两个以上选项。不需要输入“|”本身。 ... 表示其之前的元素可以被重复。 斜体 表示占位符或者需要提供特定值的变量。 大写 表示系统提供的元素，以便与用户定义的元素相互区分。除出现在方括号中的元素外，应当按 照顺序逐字输入。当然，部分元素在系统中是大小写不敏感的，因此用户可以根据系统说明以 小写形式输入。 小写 表示由用户提供的元素。 2 第2章 安装概述 2 第 章 安装概述 • 产品简介 • 安装模式说明 • License 说明 2.1 产品简介 金仓数据库管理系统 [简称:KingbaseES] 是北京人大金仓信息技术股份有限公司（简称人大金仓）自主研发的、 具有自主知识产权的商用关系型数据库管理系统（DBMS）。该产品面向事务处理类应用，兼顾各类数据分析类应 用，可用做信息管理系统、业务及生产系统、决策支持系统、全文检索、地理信息系统等的承载数据库。 2.2 安装模式说明 命令行安装 2.3 License 说明 数据库 license 是 KingbaseES 提供的授权文件，其中会对数据库有效日期、发布类型等信息进行设置。 如果在 license 文件中信息与安装环境中相关信息不匹配，数据库将无法启动。 更多 license 信息，详见《License 信息手册》。 3 第2章 安装概述 2.4 Docker 说明 Docker 是一个开源的应用容器引擎，让开发者可以打包他们的应用以及依赖包到一个可移植的镜像中，然后发 布到任何流行的 Linux 或 Windows 操作系统的机器上，也可以实现虚拟化。容器是完全使用沙箱机制，相互之间不 会有任何接口。 4 第 3 章 安装前准备工作 3 第 章 安装前准备工作 • 软件环境要求 • 安装包准备 • Docker 安装 • 检查和配置环境 • 预安装工作 3.1 软件环境要求 Linux 操作系统中 docker 可以正常使用。参见术语 。 3.2 安装包准备 您可以通过人大金仓的销售人员、售后支持人员或代理商获取安装包。 您在获得安装包（tar 文件）的同时，应该会获得一个 MD5 值或 SHA1 值。建议先通过以下命令查看安装程序 文件对应的 MD5 值或 SHA1 值，再和拿到的 MD5 值或 SHA1 值进行比对。如果一致说明安装文件正常；如果不一 致说明安装文件可能不完整，安装过程可能无法正常完成。 假设拿到的安装包文件是 kingbase.tar ，查看其 MD5 值： certutil -hashfile kingbase.tar MD5 查看其 SHA1 值： certutil -hashfile kingbase.tar SHA1 5 第 3 章 安装前准备工作 3.3 Docker 安装 Docker 是一个开源的商业产品，有两个版本：社区版（Community Edition，缩写为 CE）和企业版（Enterprise Edition，缩写为 EE）。企业版包含了一些收费服务，个人开发者一般用不到。下面的介绍都针对社区版。 Docker CE 的安装请参考官方文档，我们这里以 CentOS 为例： 1、Docker 要求 CentOS 系统的内核版本高于 3.10 通过 uname -r 命令查看你当前的内核版本 uname -r 2、使用 root 权限登录 Centos。确保 yum 包更新到最新。 yum -y update 3、卸载旧版本 (如果安装过旧版本的话) yum remove -y docker* 4、安装需要的软件包，yum-util 提供 yum-config-manager 功能，另外两个是 devicemapper 驱动依赖的 yum install -y yum-utils 6 第 3 章 安装前准备工作 5、设置 yum 源，并更新 yum 的包索引 yum-config-manager --add-repo http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo yum makecache fast 6、可以查看所有仓库中所有 docker 版本，并选择特定版本安装 yum list docker-ce --showduplicates | sort -r 7、安装 docker yum install -y docker-ce-3:19.03.9-3.el7.x86_64 # 这是指定版本安装 8、启动并加入开机启动 systemctl start docker && systemctl enable docker 9、验证安装是否成功 (有 client 和 service 两部分表示 docker 安装启动都成功了) docker version 7 第 3 章 安装前准备工作 参考网址: https://blog.csdn.net/MinggeQingchun/article/details/123411872 3.4 检查和配置环境 3.4.1 检查操作系统信息 您可以通过以下命令查看操作系统信息： cat /etc/*release 3.4.2 检查系统内存与存储空间 您可以通过以下命令查看内存信息（以 MB 单位显示）： 8 第 3 章 安装前准备工作 free -m 您可以通过以下命令查看磁盘存储信息（以 GB 单位显示）： df -hl 如果安装过程中出现存储空间不足的情况，请先释放足够的磁盘空间，再执行安装程序。如果硬件配置不满足要 求，需要更换满足要求的硬件设备再进行安装。 3.5 预安装工作 3.5.1 安装用户 在安装 KingbaseES 时，安装用户对于安装路径需有“读”、“写”、“执行”的权限。 您需使用 root 用户安装。 3.5.2 安装目录 使用 docker 命令行安装，安装之后，会安装在 docker 的存储目录下，docker 默认的安装路径是（/var/lib/ docker ）。 参考网址:https://www.cnblogs.com/zp900704/p/16499927.html 3.5.3 数据目录 数据目录是 KingbaseES 中存放数据文件的目录，默认是在容器的/home/kingbase/userdata/data 目录。 9 第4章 安装详解 4 第 章 安装详解 4.1 导入镜像 本节将讲解在 Linux 系统中使用 docker 命令行安装 KingbaseES。 1. 打开新终端，上传 tar 包； 2. 切换到 root 用户； 3. 执行如下命令： 导入 tar 包到本机 docker 镜像仓库中 docker load -i kingbase.tar 查看导入的镜像 docker images 10 第4章 4.2 运行镜像 4.2.1 启动命令 安装详解 docker run -idt --privileged -p ${hostport}:${containerport} –v ${hostpath}:${containerpath} --name ${sub_ container} ${image} /usr/sbin/init 4.2.2 使用 docker logs 查看容器脚本执行日志 11 第4章 4.2.3 安装详解 使用-p 选项绑定端口 图 4.2.1: 将容器内部端口绑定到宿主机端口 4321 上，在宿主机内连接该数据库 宿主机可成功访问对应数据库 4.2.4 使用-v 选项挂载目录 使用-v 可以将容器内数据目录（/home/kingbase/userdata/）挂载到宿主机进行持久化，-v 冒号左边是用 户可配置的，代表用户可以设置的宿主机挂载目录 (用户无需自己创建，挂载后脚本会自动修改好目录的 权限)，右边按照文档描述进行配置 docker run -tid --name kingbase -v /mnt/kingbase/data:/home/kingbase/userdata/ -p 4321:54321 kingbase:v1 / bin/bash 查看挂载是否生效 12 第4章 安装详解 docker inspect -f ‘{{.Mounts}}’ kingbase 持久化数据挂载成功 进入容器 docker exec –it kingbase /bin/bash 4.3 设置环境变量 docker run -tid \ --name kingbase \ -e ENABLE_CI=${enable_ci} \ -e NEED_START=${need_start} \ -e DB_USER=${username} \ -e DB_PASSWORD=${passwd} \ -e DB_MODE=${dbmode} \ kingbase:v1 \ /bin/bash 数据库默认用户名：system 数据库默认密码：123456 数据库默认 data 目录：/home/kingbase/userdata/data 设置的 KINGBASE_DATA 路径是, 需要设置在 -v 选项冒号右侧的容器内的挂载路径下, 不然数据目录无法持久 化。 13 第4章 安装详解 4.3.1 DB_USER: 数据库用户 4.3.2 DB_PASSWORD: 数据库初始密码 容器外访问，输入更改后的密码，访问成功 4.3.3 DB_MODE: 数据库模式 数据库模式：支持 oracle/pg/mysql 14 第4章 安装详解 4.3.4 NEED_START: 进入容器后是否启动数据库 yes(默认启动数据库)/ no（不启动数据库） 4.3.5 ENABLE_CI: 是否需要配置大小写敏感 yes(默认大小写不敏感)/no 大小写敏感 4.3.6 License.dat 持久化及更换 license 容器启动后对应的 license.dat 文件会复制到 etc 持久化目录，并建立软连接 更新 license 直接替换持久化 etc 目录下的 license.dat 文件, 进入容器后，并输入命令修改成正确权限。 15 第4章 安装详解 chown kingbase:kingbase /home/kingbase/userdata/etc/license.dat chmod 755 /home/kingbase/userdata/etc/license.dat 4.3.7 配置文件持久化及修改配置文件后生效 启动容器后, 相关配置文件会随着 data 目录一起持久化，包括 kingbase.conf、kingbase_auto.conf、 sys_hba.conf 等配置文件. 在持久化目录中修改配置文件后，使用如下命令使修改生效： /home/kingbase/install/kingbase/bin/sys_ctl reload -D 4.4 数据库基本操作 4.4.1 启动即运行 /home/kingbase/userdata/data/ 容器启动后，数据库即开始运行（数据库配置正确/或者处于初始态） 4.4.2 ksql 访问访问数据库（密码/免密） 使用 ksql 输入密码进行访问 (默认 kingbase 用户) #(进入容器 linux 默认用户 kingbase) : ksql -Usystem -d test -p54321 16 第4章 安装详解 图 4.4.1: 直接使用 ksql 免密访问 #(进入容器 linux 默认用户 kingbase) : ksql 4.4.3 容器外访问数据库 (需要密码) 宿主机远程访问需要加-h 及改变映射端口 #(linux 非 root 用户 ) : ./kingbase/bin/ksql -Ukingbase -d test -p 4321 -h ${container_host_ip} 4.4.4 数据库启动和停止 #(进入容器 linux 默认用户 kingbase) : sys_ctl -D /home/kingbase/xxxx start/stop 17 第 5 章 安装后检查 5 第 章 安装后检查 在安装完成后，您可以通过以下几种方式进行安装正确性验证： 1. 查看安装后容器的状态 使用 docker ps -a 查询容器 id。 2. 使用 docker logs 命令，检查数据库启动日志 3. 进入容器, 检查金仓数据库的进程, 容器启动，默认启动金仓数据库，数据库在容器内默认端口是 54321 18 第 5 章 安装后检查 4. 输入 exit 命令，退出容器 19 第 6 章 卸载 6 第 章 卸载 本节将讲解在 Linux 系统中使用 docker 命令行卸载 KingbaseES. 1. 打开新终端； 2. 切换到 root 用户； 3. 执行卸载程序。 停止容器 docker stop ${container_id} 删除容器 docker rm ${container_id} 删除镜像 docker rmi ${image_id} 20 第 6 章 卸载 21 第 7 章 附录 7 第 章 附录 1、当使用 docker load -i kingbase.tar 命令报错时，可使用 docker import kingbase.tar 命令，尝试重 新导包。 2、创建容器的的时候，可以在“docker run“命令中增加“--restart=always“选项, 保证 linux 系统重启后，容器自 动运行。 22 版权声明 版权声明 北京人大金仓信息技术股份有限公司（简称：人大金仓）版权所有，并保留对本手册及本声明的一切权利。 未得到人大金仓的书面许可，任何人不得以任何方式或形式对本手册内的任何部分进行复制、摘录、备份、修 改、传播、翻译成其他语言、将其全部或部分用于商业用途。 免责声明 本手册内容依据现有信息制作，由于产品版本升级或其他原因，其内容有可能变更。人大金仓保留在没有任何通 知或者提示的情况下对手册内容进行修改的权利。 本手册仅作为使用指导，人大金仓在编写本手册时已尽力保证其内容准确可靠，但并不确保手册内容完全没有错 误或遗漏，本手册中的所有信息也不构成任何明示或暗示的担保。 技术支持 • 人大金仓官方网站：http://www.kingbase.com.cn/ • 人大金仓文档中心：http://help.kingbase.com.cn/ • 全国服务热线：400-601-1188 • 人大金仓技术支持与反馈信箱：support@kingbase.com.cn 23 服务周期承诺 服务周期承诺 由于市场需求在不断变化，技术创新和发展的进程不断加剧，产品的版本更迭不可避免。人大金仓对于产品版本 生命周期的有效管理，有助于您提前规划项目，更好地从产品服务终止上过渡。 表 1: KingbaseES 产品生命周期里程碑 关键里程碑点 定义 产品发布日期 产品正式发布版本，即 GA（general availability）版本的发布日期。 停止销售日期 正式停止销售的日期，版本停止接受订单日。该日之后，产品将不再销售。 停止功能升级日期 在该日期之后，不再提供新特性和新硬件支持。但依旧提供错误修复、安全修复、功 能维护等服务。 停止功能维护日期 在该日期之后，不再维护功能，修复问题。但依旧提供安全修复等服务 停止安全维护日期 在该日期之后，不再发布补丁版本修复中高风险漏洞，仅提供有限的支持。 产品服务终止日期 停止提供产品服务和支持的日期。包括软件维护版本，缺陷修复，以及针对该产品的 所有服务支持（包括服务热线和远程/现场支持）。 服务周期策略 金仓数据库管理系统 KingbaseES 产品确保以下的服务周期： 1）产品自发布之日起至产品停止功能升级（包含新特性、新硬件支持）之日不少于 5 年。 2）产品停止功能升级之日起至产品停止功能维护（主要包括问题修复）之日不少于 4 年。 3）产品功能维护停止之日起至产品停止安全维护（包括中高风险漏洞修复）之日不少于 2 年。 服务终止策略 金仓数据库管理系统 KingbaseES 产品确保在销售后，至少提供 6 年的服务支持。 注意: 人大金仓将会综合各方因素来确定产品服务终止日期。并将在实际产品服务终止日期之前至少 90 天，通过公 24 服务周期承诺 开方式宣布产品服务终止日期。 25