severalnines/clustercontrol

ClusterControl Docker镜像

!! 注意 !!

弃用通知：ClusterControl Docker镜像

即日起，独立的ClusterControl Docker镜像已弃用，将不再接收更新或官方支持。此变更旨在简化部署流程，并为数据库集群管理提供更健壮、可扩展的解决方案。

变更内容

• Docker镜像弃用：我们将不再发布新版本或为现有ClusterControl Docker镜像提供支持。
• 替代方案：所有新部署应迁移至ClusterControl Helm Chart，该方案提供更集成、可靠且Kubernetes原生的ClusterControl安装和管理方法。

变更原因

• 增强功能：https://github.com/severalnines/helm-charts/tree/main/charts/clustercontrol%E5%8C%85%E5%90%AB%E6%94%B9%E8%BF%9B%E7%9A%84%E9%85%8D%E7%BD%AE%E3%80%81%E5%8F%AF%E6%89%A9%E5%B1%95%E6%80%A7%E5%92%8C%E7%94%9F%E5%91%BD%E5%91%A8%E6%9C%9F%E7%AE%A1%E7%90%86%E5%8A%9F%E8%83%BD%EF%BC%8C%E8%BF%99%E4%BA%9B%E6%98%AF%E7%8B%AC%E7%AB%8BDocker%E5%AE%B9%E5%99%A8%E6%89%80%E4%B8%8D%E5%85%B7%E5%A4%87%E7%9A%84%E3%80%82
• Kubernetes原生：通过专注于基于Helm的部署，我们能提供与现代容器化环境和最佳实践完全一致的简化方案。
• 服务解耦：ClusterControl可在容器化环境中运行，借助其他辅助容器如cmon-sd、prometheus/victoriametrics、nginx ingress、innodb cluster（使用MySQL Operator）等。

时间线

• 立即弃用：Docker镜像将不再提供进一步的版本发布或维护更新。
• 支持终止：截至2025年底，将尽最大努力解决与Docker镜像相关的现有问题或疑问（如适用）。此日期后，该镜像将被视为完全不支持。

后续步骤

• 规划迁移：查看https://github.com/severalnines/helm-charts/tree/main/charts/clustercontrol%EF%BC%8C%E4%BA%86%E8%A7%A3%E8%A6%81%E6%B1%82%E5%92%8C%E8%BF%81%E7%A7%BB%E6%AD%A5%E9%AA%A4%E3%80%82
• 备份与过渡：在停用旧容器前，确保数据和配置已安全备份。
• 通过Helm部署：使用Helm安装和管理最新版本的ClusterControl，利用新功能和改进。

如对迁移至Helm Chart有任何疑问或需要协助，请联系我们的支持团队或查阅文档中的详细安装指南。感谢您的合作，我们期待通过这种新的、更强大的部署方法继续提升您的ClusterControl使用体验。

目录

1. 支持的标签
2. 概述
3. 镜像描述
4. 运行容器
5. 环境变量
6. 服务管理
7. 示例
8. 开发
9. 免责声明

支持的标签

• https://github.com/severalnines/docker/blob/master/Dockerfile
• https://github.com/severalnines/docker/blob/1.9.8/Dockerfile
• https://github.com/severalnines/docker/blob/1.9.7/Dockerfile

概述

ClusterControl是一款数据库集群管理和自动化软件，可帮助部署、监控、管理和扩展数据库集群。此Docker镜像预装并配置了ClusterControl及其所有组件，可立即用于部署新的数据库服务器/集群或管理现有数据库服务器/集群。

支持的数据库服务器/集群：

• Percona XtraDB Cluster
• MariaDB Galera Cluster
• MySQL/MariaDB（独立和复制）
• MySQL Cluster (NDB)
• MongoDB（副本集和分片集群）
• PostgreSQL/EnterpriseDB（独立和流复制）
• TimescaleDB（独立和流复制）
• Redis（带Sentinel的复制和集群）
• Microsoft SQL Server 2019/2022 for Linux（独立和可用性组）
• Elasticsearch

更多详情请访问Severalnines网站。

镜像描述

拉取ClusterControl镜像的命令如下：

bash
$ docker pull docker.xuanyuan.run/severalnines/clustercontrol

该镜像基于RockyLinux 9和Apache 2.4，包含ClusterControl软件包和必备组件：

• 通过Severalnines仓库安装的ClusterControl控制器、GUI v1（端口9443）、GUI v2、云、通知和web-ssh软件包。
• MariaDB、CMON数据库、cmon用户授权以及ClusterControl UI的dcps数据库。
• Apache、ClusterControl GUI的文件和目录权限，已安装SSL。
• ClusterControl使用的SSH密钥。
• ClusterControl CLI（s9s）

运行容器

运行ClusterControl容器的最简单命令为：

bash
$ docker run -d severalnines/clustercontrol

但对于生产环境，建议使用固定IP地址/主机名和持久卷，以确保在重启、升级和重新调度时数据不丢失，如下所示：

注意

如果要从ClusterControl 1.9.6（或更早版本）升级到1.9.7（2023年9月）或1.9.8（2024年2月），请参阅https://github.com/severalnines/docker/blob/master/UPGRADING-TO-1.9.7.md%E3%80%82%E9%9C%80%E8%A6%81%E6%89%A7%E8%A1%8C%E9%A2%9D%E5%A4%96%E6%AD%A5%E9%AA%A4%E6%9D%A5%E5%81%9C%E6%AD%A2%E5%B9%B6%E9%87%8D%E6%96%B0%E5%88%9B%E5%BB%BA%E5%AE%B9%E5%99%A8%E4%BB%A5%E5%AE%8C%E6%88%90%E6%AD%A3%E7%A1%AE%E5%8D%87%E7%BA%A7%E3%80%82%E5%A6%82%E6%9E%9C%E4%BB%8E1.9.7%E5%8D%87%E7%BA%A7%EF%BC%8C%E5%8F%AF%E5%BF%BD%E7%95%A5%E6%AD%A4%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9%E3%80%82

bash
# 创建Docker网络以实现持久化主机名和IP地址
$ docker network create --subnet=192.168.10.0/24 db-cluster

# 启动容器
$ docker run -d --name clustercontrol \
--network db-cluster \
--ip 192.168.10.10 \
-h clustercontrol \
-p 5000:80 \
-p 5001:443 \
-p 9443:9443 \
-p 9999:9999 \
-v /storage/clustercontrol/cmon.d:/etc/cmon.d \
-v /storage/clustercontrol/datadir:/var/lib/mysql \
-v /storage/clustercontrol/sshkey:/root/.ssh \
-v /storage/clustercontrol/cmonlib:/var/lib/cmon \
-v /storage/clustercontrol/backups:/root/backups \
-v /storage/clustercontrol/prom-data:/var/lib/prometheus \
-v /storage/clustercontrol/prom-conf:/etc/prometheus \
severalnines/clustercontrol

建议的端口映射：

• 5000 -> 80 - ClusterControl GUI v2 HTTP
• 5001 -> 443 - ClusterControl GUI v2 HTTPS
• 9443 -> 9443 - ClusterControl GUI v1 HTTPS
• 9999 -> 9999 - 备份流端口（仅当ClusterControl作为数据库备份目标时使用）

推荐的持久卷：

• /etc/cmon.d - ClusterControl配置文件。
• /var/lib/mysql - 用于存储cmon和dcps数据库的MySQL数据目录。
• /root/.ssh - SSH私钥和公钥。
• /var/lib/cmon - ClusterControl内部文件。
• /root/backups - 默认备份目录（仅当ClusterControl作为数据库备份目标时使用）。
• /var/lib/prometheus - Prometheus数据目录。
• /etc/prometheus - Prometheus配置目录。

注意

从ClusterControl 1.9.7（2023年9月）开始，环境变量DOCKER_HOST_ADDRESS不再需要。该变量仅适用于1.9.1至1.9.6版本。

片刻后，可通过以下ClusterControl Web GUI访问（假设Docker主机IP地址为192.168.11.111）：

• ClusterControl GUI v2 HTTP: [*]
• ClusterControl GUI v2 HTTPS: [*]
• ClusterControl GUI v1 HTTPS: [*]

注意，从ClusterControl 1.9.7开始，ClusterControl GUI v2是默认的前端图形用户界面（GUI）。ClusterControl GUI v1已结束开发周期，视为功能冻结产品。所有新开发将集中在ClusterControl GUI v2上。

环境变量

• CMON_PASSWORD={string}

  • 'cmon'用户的MySQL密码。默认为'cmon'。建议使用docker secret。
  • 示例：CMON_PASSWORD=cmonP4s5

• MYSQL_ROOT_PASSWORD={string}

  • ClusterControl容器的MySQL root密码。默认为'password'。建议使用docker secret。
  • 示例：MYSQL_ROOT_PASSWORD=MyPassW0rd

• CMON_STOP_TIMEOUT={integer}

  • 容器引导过程中等待CMON优雅停止（SIGTERM）的时间（秒）。默认为30。
  • 如果超时，将使用SIGKILL停止CMON。
  • 示例：CMON_STOP_TIMEOUT=30

服务管理

ClusterControl需要运行多个进程：

• mariadbd - ClusterControl数据库，运行于MariaDB 10.5。
• httpd - 运行于Apache 2.4的Web服务器。
• php-fpm - 用于ClusterControl GUI v1的PHP 7.4 FastCGI进程管理器。
• cmon - ClusterControl后端守护进程，ClusterControl的核心，依赖mariadbd。
• cmon-ssh - ClusterControl基于Web的SSH守护进程，依赖cmon和httpd。
• cmon-events - ClusterControl通知守护进程，依赖cmon和httpd。
• cmon-cloud - ClusterControl云集成守护进程，依赖cmon和httpd。

这些进程由进程控制系统Supervisord管理。要管理进程，可使用supervisorctl客户端，如下例所示：

bash
[root@docker-host]$ docker exec -it clustercontrol /bin/bash
$ supervisorctl
cmon                             RUNNING   pid 504, uptime 0:11:37
cmon-cloud                       RUNNING   pid 505, uptime 0:11:37
cmon-events                      RUNNING   pid 506, uptime 0:11:37
cmon-ssh                         RUNNING   pid 507, uptime 0:11:37
httpd                            RUNNING   pid 509, uptime 0:11:37
mariadbd                         RUNNING   pid 503, uptime 0:11:37
php-fpm                          RUNNING   pid 508, uptime 0:11:37
supervisor> restart cmon
cmon: stopped
cmon: started
supervisor> status cmon
cmon                             RUNNING   pid 504, uptime 0:00:21
supervisor>

在某些情况下，手动升级或配置调整后可能需要重启相应服务。启动命令详情可在conf/supervisord.conf中找到。

示例

• https://github.com/severalnines/docker/tree/master/examples/docker
• https://github.com/severalnines/docker/tree/master/examples/kubernetes

开发

请通过我们的支持渠道报告错误、改进或建议：[***]

如有任何问题，欢迎通过我们的联系我们页面或发送邮件至***与我们联系。

免责声明

尽管Severalnines提供ClusterControl Docker镜像，但不建议用于生产环境。由于其内部逻辑和系统设计，ClusterControl产品从未计划在容器环境中运行。我们将尽最大努力维护Docker镜像，但它不属于产品开发计划和流程的一部分。

注意，从ClusterControl 1.9.7开始，ClusterControl GUI v2是默认的前端图形用户界面（GUI）。ClusterControl GUI v1已结束开发周期，视为功能冻结产品。所有新开发将集中在ClusterControl GUI v2上。