brindster/docker-plugin-cephfs

Docker CephFS卷插件

受其他类似插件启发，本插件提供一种无需向驱动传递敏感信息、通过读取密钥环文件认证的Docker卷管理方案，用于连接和使用CephFS存储。

核心功能

• 基于密钥环文件认证，避免直接传递秘密信息
• 支持自定义集群名称、客户端名称及Ceph监控服务器列表
• 允许配置挂载选项、远程路径等参数
• 提供调试模式输出详细日志

使用场景

• 容器数据持久化存储到CephFS
• 多容器共享CephFS中的数据卷
• 需要安全认证的CephFS卷管理场景

配置说明

前置条件

需确保Docker主机存在 /etc/ceph 目录且可被Docker用户读取，密钥环文件需存放于此目录，默认命名格式为 ceph.client.[客户端名称].keyring。

Ceph客户端创建

在Ceph集群生成客户端密钥环文件：

shell
ceph auth get-or-create client.dockeruser mon 'allow r' osd 'allow rw' mds 'allow' > /etc/ceph/ceph.client.dockeruser.keyring

将该文件复制到所有Docker主机。

插件安装

shell
docker plugin install --alias cephfs brindster/docker-plugin-cephfs \
CLUSTER_NAME=ceph \
CLIENT_NAME=admin \
SERVERS=ceph1,ceph2,ceph3

可配置参数：

• CLUSTER_NAME：默认集群名称（默认值：ceph）
• CLIENT_NAME：默认客户端名称（默认值：admin）
• SERVERS：Ceph监控服务器列表（默认值：localhost）
• DEBUG_MODE=1：启用调试模式

使用示例

命令行创建卷

shell
docker volume create --driver cephfs test
docker run -it --rm -v test:/data busybox sh

Docker Compose基础示例

yaml
version: '3'
services:
  app:
    image: nginx
    volumes:
      - test:/data
volumes:
  test:
    driver: cephfs

带驱动选项的Compose示例

yaml
version: '3'
services:
  app:
    image: nginx
    volumes:
      - test:/data
volumes:
  test:
    driver: cephfs
    driver_opts:
      client_name: dockeruser
      keyring: /etc/ceph/dockeruser.keyring
      mount_opts: mds_namespace=example
      remote_path: /shared_data
      servers: 192.168.1.10,ceph-mon.internal.example.com:16789

驱动选项

• client_name：连接用客户端名称（默认取插件配置的CLIENT_NAME）
• cluster_name：目标集群名称（默认取插件配置的CLUSTER_NAME）
• keyring：密钥环文件路径（默认：/etc/ceph/%cluster_name%.client.%client_name%.keyring）
• mount_opts：额外挂载选项（逗号分隔）
• remote_path：远程挂载路径（默认：卷名称）
• servers：监控服务器列表（逗号分隔，默认取插件配置的SERVERS）