longhornio/csi-snapshotter

CSI Snapshotter 镜像文档

镜像概述和主要用途

CSI Snapshotter是容器存储接口（CSI）规范中的关键组件，主要用于管理容器存储卷的快照生命周期。作为CSI控制器服务的一部分，它负责处理快照的创建、删除、查询等操作，实现容器化环境中存储数据的备份、恢复与迁移，为容器应用提供可靠的存储快照管理能力。

核心功能和特性

• 快照生命周期管理：支持容器存储卷快照的创建、删除、查询等核心操作，完整覆盖快照从创建到清理的全生命周期。
• CSI规范兼容：严格遵循CSI规范（如v1.0及以上版本），确保与各类CSI驱动、控制器及存储后端的兼容性。
• 存储后端集成：可与主流存储后端（如Ceph、AWS EBS、Azure Disk等）集成，通过CSI接口调用存储后端的快照能力。
• 元数据管理：支持为快照添加元数据（如描述、创建时间等），便于快照的识别与管理。
• 高可用设计：支持多实例部署，通过 leader 选举机制确保服务的高可用性，避免单点故障。

使用场景和适用范围

典型使用场景

• 容器数据备份：定期为容器存储卷创建快照，实现应用数据的定时备份，防止数据丢失。
• 数据恢复：当容器数据损坏或丢失时，通过快照快速恢复至历史状态。
• 数据迁移：基于快照创建新的存储卷，实现容器数据在不同环境或存储后端间的迁移。
• 开发测试环境搭建：利用生产环境快照快速创建开发/测试环境，确保环境一致性。

适用范围

• Kubernetes集群中部署CSI驱动的环境。
• 需要对容器存储卷进行快照管理的容器化应用（如数据库、消息队列等有状态应用）。
• 采用CSI规范的存储系统（如云厂商存储服务、分布式存储等）。

使用方法和配置说明

前置条件

• 已部署CSI控制器服务，并确保CSI端点（如Unix域套接字或TCP地址）可访问。
• 存储后端支持快照功能，并已配置相应的CSI驱动。

部署方式

CSI Snapshotter通常作为CSI控制器的sidecar容器运行，与CSI控制器服务协同工作。可通过Docker命令直接运行，或集成到Kubernetes的Deployment/StatefulSet中。

部署示例

Docker Run 示例

bash
docker run -d \
  --name csi-snapshotter \
  --volume /var/lib/csi/sockets/pluginproxy/csi.sock:/csi/csi.sock \
  -e CSI_ENDPOINT=unix:///csi/csi.sock \
  -e LOG_LEVEL=info \
  -e METRICS_ADDRESS=:8080 \
  docker.xuanyuan.run/your-registry/csi-snapshotter:latest

参数说明

• --volume /var/lib/csi/sockets/pluginproxy/csi.sock:/csi/csi.sock：挂载CSI控制器的Unix域套接字，使snapshotter能与CSI控制器通信。
• -e CSI_ENDPOINT：CSI控制器的端点地址（必填），格式为unix://<path>或tcp://<host>:<port>。
• -e LOG_LEVEL：日志级别，可选值：debug、info、warn、error（默认info）。
• -e METRICS_ADDRESS： metrics暴露地址（如:8080），用于监控服务运行状态。

配置参数说明