ipfs/ipfs-cluster-test

IPFS Cluster Docker镜像

镜像概述和主要用途

IPFS Cluster Docker镜像提供IPFS Cluster的容器化部署，IPFS Cluster是跨IPFS守护进程的集群数据编排工具，通过分配、复制和跟踪分布式pin集，实现自动化数据可用性和冗余，确保数据在多节点间可靠存储与访问。

核心功能和特性

• 集群对等服务：ipfs-cluster-service应用，需与go-ipfs协同运行，管理集群节点间的pin集同步与数据复制。
• CLI客户端工具：ipfs-cluster-ctl，通过HTTP API与集群节点交互，支持pin管理、集群状态查询等操作。
• Follower节点支持：ipfs-cluster-follow应用，简化follower节点的配置与运行流程，降低集群扩展难度。

使用场景和适用范围

适用于需要跨多IPFS节点保障数据冗余和高可用性的场景，包括：

• 分布式存储系统的数据管理
• 企业级数据备份与容灾方案
• 内容分发网络（CDN）的资源同步
• 团队协作的IPFS pin集集中管理

使用方法和配置说明

基本运行示例（docker run）

启动IPFS Cluster服务节点：

bash
docker run -d --name ipfs-cluster-service \
  -p 9094:9094 \  # API端口
  -p 9095:9095 \  # 集群通信端口
  -v /path/to/cluster/config:/data/ipfs-cluster \  # 挂载配置目录
  ipfs/ipfs-cluster:latest \
  ipfs-cluster-service daemon

CLI客户端使用

通过容器内ipfs-cluster-ctl管理集群：

bash
# 添加内容到集群pin集
docker exec -it ipfs-cluster-service ipfs-cluster-ctl pin add <内容CID>

# 查看集群状态
docker exec -it ipfs-cluster-service ipfs-cluster-ctl status

Docker Compose配置示例

yaml
version: '3'
services:
  ipfs-cluster:
    image: ipfs/ipfs-cluster:latest
    container_name: ipfs-cluster
    ports:
      - "9094:9094"  # API端口
      - "9095:9095"  # 集群通信端口
    volumes:
      - ./cluster-data:/data/ipfs-cluster  # 持久化集群配置与数据
    command: ipfs-cluster-service daemon
    depends_on:
      - ipfs  # 依赖IPFS节点

  ipfs:
    image: ipfs/go-ipfs:latest
    container_name: ipfs
    ports:
      - "4001:4001"  # P2P通信端口
      - "5001:5001"  # IPFS API端口
      - "8080:8080"  # 网关端口
    volumes:
      - ./ipfs-data:/data/ipfs  # 持久化IPFS数据

配置参数说明

详细配置选项参见官方文档，核心配置项包括：

• APIAddr：API服务监听地址（默认/ip4/0.0.0.0/tcp/9094）
• ClusterAddr：集群通信地址（默认/ip4/0.0.0.0/tcp/9095）
• IPFSConnAddr：连接的IPFS节点API地址（默认/ip4/127.0.0.1/tcp/5001）
• ReplicationFactor：数据复制因子（默认3）
• ClusterSecret：集群密钥（节点间通信认证，需所有节点一致）

文档与资源

• 官方完整文档：[***]
• 下载与安装指南：[***]
• 项目更新与路线图：[***]

贡献与许可

• 贡献指南：[***]
• 许可协议：双许可（Apache 2.0 和 MIT），© 2020 Protocol Labs, Inc.