模块：DOCKER

• 1: 使用方法
• 2: 参数列表
• 3: 预置剧本
• 4: 指标列表
• 5: 常见问题

1 - 使用方法

Pigsty 内置了 Docker 支持，您可以用它来快速部署容器化的应用软件。

上手

Docker 是一个 可选模块，且在 Pigsty 的大部分配置模板中，Docker 并非默认启用。因此，用户需要显式地 下载 并 配置 才能在 Pigsty 中使用 Docker。

例如，在默认使用的 meta 模板中，Docker 默认是不会下载安装的。不过在 rich 单节点模板中，则会下载并安装 Docker。

这两个配置的关键区别就在于这两个参数：repo_modules 与 repo_packages。

repo_modules: infra,node,pgsql,docker  # <--- 启用 Docker 仓库
repo_packages: 
  - node-bootstrap, infra-package, infra-addons, node-package1, node-package2, pgsql-common, docker   # <--- 下载 Docker

Docker 下载完之后，您需要在待安装 Docker 的节点上配置 docker_enabled: true 标记，并按需配置 其他参数。

infra:
  hosts:
    10.10.10.10: { infra_seq: 1 ,nodename: infra-1 }
    10.10.10.11: { infra_seq: 2 ,nodename: infra-2 }
  vars:
    docker_enabled: true  # 在这个分组上安装 Docker ！

最后，使用 您可以使用 docker.yml 剧本将其安装到节点上：

./docker.yml -l infra    # 在 infra 分组上安装 Docker

安装

如果您只是临时性的希望在某些节点上，直接从互联网安装 Docker，那么可以考虑使用以下命令：

./node.yml -e '{"node_repo_modules":"node,docker","node_packages":["docker-ce,docker-compose-plugin"]}' -t node_repo,node_pkg -l <select_group_ip>

这条命令会在目标节点上，首先启用 node,docker 两个模块对应的上游软件源，然后安装 docker-ce 与 docker-compose-plugin 两个软件包（EL/Debian同名）。

如果您希望的是在 Pigsty 初始化的时候就自动下载好 Docker 相关软件包，请参考下面的说明。

卸载

因为过于简单，Pigsty 不提供 Docker 模块的卸载剧本，你可以直接使用 Ansible 指令移除 Docker

ansible minio -m package -b -a 'name=docker-ce state=absent'  # 卸载 docker

这条命令会在目标节点上，首先启用 node,docker 两个模块对应的上游软件源，然后安装 docker-ce 与 docker-compose-plugin 两个软件包（EL/Debian同名）。

如果您希望的是在 Pigsty 初始化的时候就自动下载好 Docker 相关软件包，请参考下面的说明。

下载

想要在 Pigsty 安装过程中下载 Docker，在 配置清单 中修改参数 repo_modules 启用 Docker 软件仓库， 然后在 repo_packages 或 repo_extra_packages 参数中指定下载 Docker 软件包。

repo_modules: infra,node,pgsql,docker  # <--- 启用 Docker 仓库
repo_packages: 
  - node-bootstrap, infra-package, infra-addons, node-package1, node-package2, pgsql-common, docker   # <--- 下载 Docker
repo_extra_packages:
  - pgsql-main docker # <--- 也可以在这里指定

这里指定的 docker（实际对应 docker-ce 与 docker-compose-plugin 两个软件包）会在默认的 install.yml 过程中自动下载到本地软件源中。 下载完成后的 Docker 软件包可以通过本地软件源，对所有节点可用。

如果您已经完成了 Pigsty 安装，本地软件源已经初始化完毕，您可以在修改配置之后执行 ./infra.yml -t repo_build 重新下载并构建离线软件源。

安装 Docker 需要用到 Docker 的 YUM/APT 仓库，这个仓库在 Pigsty 中默认包含，但不启用，需要将 docker 加入到 repo_modules 中启用后才能安装

仓库

下载 Docker 需要用到互联网上游软件仓库，已经在定义在默认的 repo_upstream 中，模块名为 docker

- { name: docker-ce ,description: 'Docker CE' ,module: docker  ,releases: [7,8,9] ,arch: [x86_64, aarch64] ,baseurl: { default: 'https://download.docker.com/linux/centos/$releasever/$basearch/stable'    ,china: 'https://mirrors.aliyun.com/docker-ce/linux/centos/$releasever/$basearch/stable'  ,europe: 'https://mirrors.xtom.de/docker-ce/linux/centos/$releasever/$basearch/stable' }}
- { name: docker-ce ,description: 'Docker CE' ,module: docker  ,releases: [11,12,20,22,24] ,arch: [x86_64, aarch64] ,baseurl: { default: 'https://download.docker.com/linux/${distro_name} ${distro_codename} stable' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/docker-ce/linux//${distro_name} ${distro_codename} stable' }}

您可以在 repo_modules 与 node_repo_modules 两个参数中，使用 docker 模块名引用这个仓库。

请注意，Docker 的官方软件仓库在中国大陆默认处于 封锁 状态，您需要使用中国地区的镜像站点才能正常完成下载。

如果您处在中国大陆地区遇到 Docker 本身下载失败的问题，请检查您的配置清单中，region 是否被设置为了 default，默认情况下自动配置的 region: china 可以解决这个问题。

代理

如果您的网络环境需要使用代理服务器才能访问互联网，您可以在 Pigsty 的配置清单中配置 proxy_env 参数，这个参数会被写入到 Docker 的配置文件中的 proxy 相关配置中。

proxy_env:
  no_proxy: "localhost,127.0.0.1,10.0.0.0/8,192.168.0.0/16,*.pigsty,*.aliyun.com,mirrors.aliyuncs.com,mirrors.tuna.tsinghua.edu.cn,mirrors.zju.edu.cn"
  #http_proxy: 'http://username:password@proxy.address.com'
  #https_proxy: 'http://username:password@proxy.address.com'
  #all_proxy: 'http://username:password@proxy.address.com'

在执行 configure 的过程中如果指定了 -x 参数，当前环境中的代理服务器配置会自动生成到 Pigsty 配置文件到 proxy_env 中。

除了使用代理服务器之外，您还可以通过配置 Docker镜像站点 的方式来规避封锁。

镜像站

您可以通过参数 docker_registry_mirrors 指定 Docker 的 Registry Mirrors 参数，使用未被墙掉的镜像站点：

普通墙外用户，除了官方默认的 DockerHub 站点外，还可以考虑使用 quay.io 镜像站点。如果您的内网环境已经有了成熟的镜像基础设施，您可以使用内网的 Docker 镜像站点，避免受到外网镜像站点的影响，提高下载速度。

使用公有云厂商服务的用户可以考虑使用内网免费的 Docker 镜像。例如，如果您使用阿里云，可以使用阿里云提供的内网 Docker 镜像站点（需要登陆）：

["https://registry.cn-hangzhou.aliyuncs.com"]   # 阿里云镜像站点，需要显式登陆

如果你使用腾讯云，可以使用腾讯云提供的内网 Docker 镜像站点（需要内网）：

["https://ccr.ccs.tencentyun.com"]   # 腾讯云镜像站点，内网专用

此外，您还可以使用 CF-Workers-docker.io 快速拉起您自己的 Docker 镜像代理。 也可以考虑使用免费的 Docker代理镜像 （风险自负！）

拉取镜像

参数 docker_image 与 docker_image_cache 可用于直接指定在 Docker 安装时，需要拉取的镜像列表。

使用这一功能，可以让 Docker 装好之后就带有指定的镜像（前提是可以成功拉取，此任务失败会自动忽略跳过）

例如，您可以在配置清单中指定需要拉取的镜像：

infra:
  hosts:
    10.10.10.10: { infra_seq: 1 }
  vars:
    docker_enabled: true  # 在这个分组上安装 Docker ！
    docker_image:
      - redis:latest      # 拉取最新版本的 Redis 镜像

另一种预先加载镜像的方式是使用本地 save 的 tgz 压缩包：如果您预先使用 docker save xxx | gzip -c > /tmp/docker/xxx.tgz 将 Docker 镜像导出保存在本地。 那么这些导出的镜像文件可以通过参数 docker_image_cache 指定的 glob 被自动加载。默认的位置是： /tmp/docker/*.tgz。

这意味着你可以事先把镜像放在 /tmp/docker 目录中，然后执行 docker.yml 安装 docker 后会自动加载这些镜像包。

例如，在 supabase自建教程 中就使用了这种技术，在拉起 Supabase，安装 Docker 之前，把本地 /tmp/supabase 目录的 *.tgz 镜像压缩包都拷贝到了目标节点的 /tmp/docker 目录下。

- name: copy local docker images
  copy: src="{{ item }}" dest="/tmp/docker/"
  with_fileglob: "{{ supa_images }}"
  vars: # you can override this with -e cli args
    supa_images: /tmp/supabase/*.tgz

应用

Pigsty 提供了一系列开箱即用的，基于 Docker Compose 的 软件模板，您可以用它们一键拉起使用外部由 Pigsty 管理数据库集群的业务软件。

2 - 参数列表

DOCKER 模块提供了 8 个配置参数。

参数概览

DOCKER 参数组用于 Docker 容器引擎的部署与配置，包括启用开关、数据目录、存储驱动、镜像加速以及监控。

您可以使用 docker.yml 剧本，在节点上安装并启用 Docker。

Docker 的默认参数定义于 roles/docker/defaults/main.yml

docker_enabled: false             # 在当前节点启用 Docker？
docker_data: /var/lib/docker      # Docker 数据目录，默认为 /var/lib/docker
docker_storage_driver: overlay2   # Docker 存储驱动，可选 zfs, btrfs 等
docker_cgroups_driver: systemd    # Docker CGroup 驱动：cgroupfs 或 systemd
docker_registry_mirrors: []       # Docker 镜像仓库加速列表
docker_exporter_port: 9323        # Docker 监控指标导出端口，默认 9323
docker_image: []                  # Docker 启动后待拉取的镜像列表
docker_image_cache: /tmp/docker/*.tgz # Docker 镜像缓存 tarball 匹配模式

docker_enabled

参数名称： docker_enabled， 类型： bool， 层次：G/C/I

是否在当前节点启用Docker？默认为： false，即不启用。

docker_data

参数名称： docker_data， 类型： path， 层次：G/C/I

Docker 数据目录，默认为 /var/lib/docker。

此目录用于存储 Docker 的镜像、容器、卷等数据。如果您有独立的数据磁盘，建议将此目录指向该磁盘的挂载点。

docker_storage_driver

参数名称： docker_storage_driver， 类型： enum， 层次：G/C/I

Docker 存储驱动，默认为 overlay2。

请参考官方文档：https://docs.docker.com/engine/storage/drivers/select-storage-driver/

可选的存储驱动包括：

• overlay2：推荐的默认驱动，适用于大多数场景
• fuse-overlayfs：用于无 root 权限的容器场景
• btrfs：使用 Btrfs 文件系统时
• zfs：使用 ZFS 文件系统时
• vfs：用于测试目的，不推荐生产使用

docker_cgroups_driver

参数名称： docker_cgroups_driver， 类型： enum， 层次：G/C/I

Docker使用的 CGroup FS 驱动，可以是 cgroupfs 或 systemd，默认值为： systemd

docker_registry_mirrors

参数名称： docker_registry_mirrors， 类型： string[]， 层次：G/C/I

Docker 镜像仓库加速地址列表，默认值为：[] 空数组。

您可以使用 Docker 镜像站点加速镜像拉取，下面是一些中国大陆可用的镜像站点示例：

["https://docker.m.daocloud.io"]                # DaoCloud 镜像站点
["https://docker.1ms.run"]                      # 毫秒镜像站点
["https://mirror.ccs.tencentyun.com"]           # 腾讯云内网镜像站点
["https://registry.cn-hangzhou.aliyuncs.com"]   # 阿里云镜像站点，需要登录

您也可以考虑使用 Cloudflare Worker 搭建 Docker Proxy 来加速访问。

如果拉取速度仍然太慢，您也可以考虑使用其他 Registry：docker login quay.io

docker_exporter_port

参数名称： docker_exporter_port， 类型： port， 层次：G

Docker 监控指标导出端口，默认为 9323。

Docker 守护进程会在此端口暴露 Prometheus 格式的监控指标，供监控基础设施采集。

docker_image

参数名称： docker_image， 类型： string[]， 层次：G/C/I

Docker 待拉取的镜像列表，默认为空列表 []。

在这里指定的 Docker 镜像名称会在安装阶段自动拉取。

docker_image_cache

参数名称： docker_image_cache， 类型： path， 层次：G/C/I

本地 Docker 镜像离线缓存包 glob 匹配模式，默认为 /tmp/docker/*.tgz。

您可以使用 docker save | gzip 的方式将镜像打包，并通过此参数在 Docker 安装阶段自动导入。

匹配该模式的 .tgz 后缀 tarball 文件将使用以下方式逐个导入 Docker 中：

cat *.tgz | gzip -d -c - | docker load

3 - 预置剧本

Docker 模块提供了一个默认的剧本 docker.yml ，用于安装 Docker Daemon 与 Docker Compose。

docker.yml

剧本原始文件：docker.yml 中

执行本剧本，将会在带有 docker_enabled: true 标记地目标节点上安装 docker-ce 与 docker-compose-plugin，启用 dockerd 服务

以下是 docker.yml 剧本中可用的任务子集：

• docker_install ： 在节点上安装 Docker，Docker Compose 软件包
• docker_admin ： 将指定的用户加入 Docker 管理员用户组中
• docker_config ： 生成 Docker 守护进程服务配置文件
• docker_launch ： 启动 Docker 守护进程服务
• docker_register ： 将 Docker 守护进程注册为 Prometheus 监控目标
• docker_image ： 尝试从 /tmp/docker/*.tgz 加载预置镜像压缩包（如果存在）

Docker 模块没有提供专门的卸载剧本，如果您需要卸载 Docker，可以手工停止 docker 后卸载：

systemctl stop docker                        # 停止 Docker 守护进程服务
yum remove docker-ce docker-compose-plugin   # 在 EL 系统上卸载 Docker 
apt remove docker-ce docker-compose-plugin   # 在 Debian 系统上卸载 Docker

4 - 指标列表

DOCKER 模块包含有 123 类可用监控指标。

5 - 常见问题

谁能执行Docker命令？

默认情况下，Pigsty 会将当前远程节点执行剧本的管理用户（即目标节点上 ssh 远程登陆的用户），以及参数 node_admin_username 中指定的管理用户加入到 Docker 操作系统用户组中。 在这个用户组（docker）中的所有用户，可以使用 docker CLI 命令对 Docker 发起管理。

如果你想让其他用户也可以执行 Docker 命令，可以将该操作系统用户加入到 docker 组中：

usermod -aG docker <username>

使用代理服务器

在 Docker 安装过程中，如果 proxy_env 参数存在， 这里的 HTTP 代理服务器配置会被写入到 /etc/docker/daemon.json 配置文件中。

Docker 在从上游 Registry 拉取镜像时，会使用此代理服务器。

小提示，在执行 configure 过程中使用 -x 参数会将当前环境中的代理服务器配置写入到 proxy_env 中。

使用镜像站点

如果您在中国大陆受到功夫网影响，可以考虑使用墙内可用的 Docker 镜像站点，例如 quay.io：

docker login quay.io    # 输入用户名密码，完成登陆

2024-06 更新，国内所有可用 Docker 镜像站点均已被墙，请使用代理服务器访问并拉取。

将Docker纳入监控

在 Docker 模块安装过程中

针对节点单独执行监控目标注册子任务 docker_register 或 register_prometheus 即可：

./docker.yml -l <your-node-selector> -t register_prometheus

使用软件模板

Pigsty 提供了一系列使用 Docker Compose 拉起的软件工具模板，可以开箱即用。

但需要首先安装 Docker 模块。