thelastpickle/cassandra-reaper

Cassandra Reaper Docker镜像文档

1. 镜像概述和主要用途

Cassandra Reaper是一个用于管理Apache Cassandra集群修复操作的工具。该Docker镜像提供了Cassandra Reaper的便捷部署方式，支持通过Web UI和API管理Cassandra集群的修复任务、调度和监控。

2. 核心功能和特性

• 支持多种后端存储（内存、Cassandra）
• 灵活的修复调度和自动化
• 多种修复并行策略（SEQUENTIAL、PARALLEL、DATACENTER_AWARE）
• JMX认证和连接管理
• 自动发现集群节点和动态种子列表
• 可配置的修复强度和超时设置
• 多数据中心支持和感知
• REST API和Web UI界面

3. 使用场景和适用范围

• Cassandra集群的日常维护和修复管理
• 多数据中心Cassandra部署的修复协调
• 需要自动化和调度修复任务的场景
• 对修复过程进行监控和管理的需求
• 需要定制修复策略（如增量修复）的环境
• 希望减少修复对集群性能影响的场景

4. 使用方法和配置说明

4.1 拉取镜像

确保本地镜像仓库中有最新版本的Reaper镜像：

bash
# 使用master标签获取最新开发版本
TAG=master

# 或使用latest标签获取最新稳定版本
TAG=latest

# 拉取镜像
docker pull thelastpickle/cassandra-reaper:${TAG}

4.2 使用内存后端运行

使用内存后端启动Reaper容器，适用于测试环境：

bash
TAG=latest

REAPER_JMX_AUTH_USERNAME=reaperUser
REAPER_JMX_AUTH_PASSWORD=reaperPass

docker run \
    -p 8080:8080 \
    -p 8081:8081 \
    -e "REAPER_JMX_AUTH_USERNAME=${REAPER_JMX_AUTH_USERNAME}" \
    -e "REAPER_JMX_AUTH_PASSWORD=${REAPER_JMX_AUTH_PASSWORD}" \
    thelastpickle/cassandra-reaper:${TAG}

启动后访问Web UI: http://localhost:8080/webui/

4.3 使用Cassandra后端运行

使用Cassandra作为后端存储启动Reaper容器，适用于生产环境：

bash
TAG=latest

REAPER_JMX_AUTH_USERNAME=reaperUser
REAPER_JMX_AUTH_PASSWORD=reaperPass

REAPER_CASS_CLUSTER_NAME=reaper-cluster
REAPER_CASS_CONTACT_POINTS=["192.168.2.185"]

docker run \
    -p 8080:8080 \
    -p 8081:8081 \
    -e "REAPER_JMX_AUTH_USERNAME=${REAPER_JMX_AUTH_USERNAME}" \
    -e "REAPER_JMX_AUTH_PASSWORD=${REAPER_JMX_AUTH_PASSWORD}" \
    -e "REAPER_STORAGE_TYPE=cassandra" \
    -e "REAPER_CASS_CLUSTER_NAME=${REAPER_CASS_CLUSTER_NAME}" \
    -e "REAPER_CASS_CONTACT_POINTS=${REAPER_CASS_CONTACT_POINTS}" \
    -e "REAPER_CASS_KEYSPACE=reaper_db" \
    thelastpickle/cassandra-reaper:${TAG}

启动后访问Web UI: http://localhost:8080/webui/

4.4 Docker Compose配置示例

以下是使用Docker Compose部署Reaper与Cassandra后端的示例：

yaml
version: '3'

services:
  reaper:
    image: thelastpickle/cassandra-reaper:latest
    ports:
      - "8080:8080"
      - "8081:8081"
    environment:
      - REAPER_JMX_AUTH_USERNAME=reaperUser
      - REAPER_JMX_AUTH_PASSWORD=reaperPass
      - REAPER_STORAGE_TYPE=cassandra
      - REAPER_CASS_CLUSTER_NAME=reaper-cluster
      - REAPER_CASS_CONTACT_POINTS=["cassandra-node1", "cassandra-node2"]
      - REAPER_CASS_KEYSPACE=reaper_db
      - REAPER_REPAIR_PARALELLISM=DATACENTER_AWARE
      - REAPER_SCHEDULE_DAYS_BETWEEN=7
      - REAPER_REPAIR_INTENSITY=0.8
    depends_on:
      - cassandra-node1
      - cassandra-node2

  cassandra-node1:
    image: cassandra:latest
    environment:
      - CASSANDRA_CLUSTER_NAME=reaper-cluster
      - CASSANDRA_SEEDS=cassandra-node1,cassandra-node2

  cassandra-node2:
    image: cassandra:latest
    environment:
      - CASSANDRA_CLUSTER_NAME=reaper-cluster
      - CASSANDRA_SEEDS=cassandra-node1,cassandra-node2

5. 环境变量配置

5.1 Reaper通用配置

REAPER_AUTO_SCHEDULING_ENABLED

• 类型: Boolean
• 默认值: false
• 描述: 是否自动为所有非系统keyspace设置修复计划。启用后，添加新集群将自动为每个keyspace设置修复计划。

REAPER_AUTO_SCHEDULING_EXCLUDED_KEYSPACES

• 类型: List (逗号分隔值)
• 描述: 排除在修复计划之外的keyspace列表。

REAPER_AUTO_SCHEDULING_INITIAL_DELAY_PERIOD

• 类型: String
• 默认值: PT15S (15秒)
• 描述: 计划周期开始前的延迟时间。

REAPER_AUTO_SCHEDULING_PERIOD_BETWEEN_POLLS

• 类型: String
• 默认值: PT10M (10分钟)
• 描述: 检查是否开始修复任务的间隔时间。

REAPER_AUTO_SCHEDULING_SCHEDULE_SPREAD_PERIOD

• 类型: String
• 默认值: PT6H (6小时)
• 描述: 每个修复计划之间的时间间隔。

REAPER_AUTO_SCHEDULING_TIME_BEFORE_FIRST_SCHEDULE

• 类型: String
• 默认值: PT5M (5分钟)
• 描述: 计划中第一次修复开始前的宽限期。

REAPER_DATACENTER_AVAILABILITY

• 类型: String
• 默认值: ALL
• 描述: Reaper在集群数据中心网络位置的部署方式。值必须为ALL、LOCAL或EACH。
  • ALL: Reaper需要通过JMX访问所有数据中心的所有节点
  • LOCAL: Reaper只需要访问本地数据中心的节点
  • EACH: 每个数据中心至少需要一个Reaper实例

REAPER_ENABLE_CROSS_ORIGIN

• 类型: Boolean
• 默认值: true
• 描述: 是否启用CORS头，允许来自其他域的REST请求。

REAPER_ENABLE_DYNAMIC_SEED_LIST

• 类型: Boolean
• 默认值: true
• 描述: 允许Reaper在添加新集群时将集群中的所有节点添加为联系点，而不仅仅是提供的节点。

REAPER_HANGING_REPAIR_TIMEOUT_MINS

• 类型: Integer
• 描述: 等待单个修复完成的时间（分钟）。如果达到此超时，相关修复段将被取消（如果可能），并在同一修复运行过程中安排稍后再次修复。

REAPER_INCREMENTAL_REPAIR

• 类型: Boolean
• 默认值: false
• 描述: 设置默认修复类型，除非为每个运行特别定义。仅支持PARALLEL修复并行性设置。
• 注意: 建议在Cassandra 4.0之前避免使用增量修复，因为潜在的bug可能导致过度流式传输和集群不稳定。

REAPER_JMX_AUTH_USERNAME

• 类型: String
• 描述: 用于JMX认证的用户名。

REAPER_JMX_AUTH_PASSWORD

• 类型: String
• 描述: 用于JMX认证的密码。

REAPER_JMX_CONNECTION_TIMEOUT_IN_SECONDS

• 类型: Integer
• 默认值: 20
• 描述: 建立JMX连接的超时时间（秒）。

REAPER_JMX_PORTS

• 类型: Object
• 描述: 为各个主机使用的自定义JMX端口映射。默认JMX端口为7199。
• 示例:

  jmxPorts:
    127.0.0.1: 7100
    127.0.0.2: 7200
  

REAPER_JMX_CREDENTIALS

• 类型: Object
• 版本: 1.1.0及以上
• 描述: 允许Reaper使用特定于集群的凭据建立JMX连接。
• 示例:

  jmxCredentials:
    clusterProduction1:
      username: user1
      password: password1
  

REAPER_LOGGING_ROOT_LEVEL

• 类型: String
• 描述: 日志过滤级别。级别顺序为ALL < DEBUG < INFO < WARN < ERROR < FATAL < OFF。

REAPER_REPAIR_INTENSITY

• 类型: Float (0.0到1.0之间，不能为0.0)
• 描述: 修复强度定义在触发每个修复段之间的睡眠时间。值为1.0表示不睡眠，值越小睡眠时间越长。

REAPER_REPAIR_MANAGER_SCHEDULING_INTERVAL_SECONDS

• 类型: Integer
• 默认值: 30
• 描述: 控制修复管理器调度下一段处理的速度。减小此值可以显著加快修复速度。

REAPER_REPAIR_PARALELLISM

• 类型: String
• 描述: 默认修复并行性类型。值必须为SEQUENTIAL、PARALLEL或DATACENTER_AWARE。
  • SEQUENTIAL: 一次一个副本，对快照执行验证压缩
  • PARALLEL: 所有副本同时，无快照
  • DATACENTER_AWARE: 一次仅一个DC中的所有副本，无快照

REAPER_REPAIR_RUN_THREADS

• 类型: Integer
• 描述: 用于处理Reaper任务的线程数量。应足够大以避免某些线程等待I/O时导致阻塞。

REAPER_SCHEDULE_DAYS_BETWEEN

• 类型: Integer
• 默认值: 7
• 描述: 两次调度新修复之间的天数。这是新修复计划的默认值，也可以为每个新计划单独定义。值为0表示连续修复。

REAPER_SEGMENT_COUNT

• 类型: Integer
• 描述: 为新注册的Cassandra修复运行创建的默认修复段数量。每个段由Reaper进程单独修复。

REAPER_SERVER_APP_BIND_HOST

• 类型: String
• 描述: 用于访问应用程序UI的主机地址。要绑定到所有接口，请使用0.0.0.0或留空。

REAPER_SERVER_APP_PORT

• 类型: Integer
• 描述: 用于访问应用程序UI的端口号。必须与管理端口不同。

REAPER_SERVER_ADMIN_BIND_HOST

• 类型: String
• 描述: 用于访问管理UI的主机地址。

REAPER_SERVER_ADMIN_PORT

• 类型: Integer
• 描述: 用于访问管理UI的端口号。必须与应用程序端口不同。

REAPER_STORAGE_TYPE

• 类型: String
• 描述: 用于存储系统状态的后端类型。值必须为cassandra、database或memory。

REAPER_USE_ADDRESS_TRANSLATOR

• 类型: Boolean
• 默认值: false
• 描述: 在AWS中运行多区域集群时，设置为true以使用EC2MultiRegionAddressTranslator，允许将节点广播的公共地址转换为用于公开JMX的私有IP地址。

5.2 Cassandra后端特定配置

REAPER_CASS_ACTIVATE_QUERY_LOGGER

• 类型: Boolean
• 默认值: false
• 描述: 在日志输出中记录对Cassandra后端的CQL调用。

REAPER_CASS_CLUSTER_NAME

• 类型: String
• 描述: 用于存储Reaper控制数据的集群名称。

REAPER_CASS_CONTACT_POINTS

• 类型: Array (逗号分隔Strings)
• 描述: 要联系的Cassandra集群中的种子节点。例如：["127.0.0.1", "127.0.0.2"]

REAPER_CASS_KEYSPACE

• 类型: String
• 描述: 存储Reaper控制数据的keyspace名称。

REAPER_CASS_LOCAL_DC

• 类型: String
• 描述: 使用dcAwareRoundRobin策略时，指定离Reaper最近的数据中心名称。

REAPER_CASS_AUTH_USERNAME

• 类型: String
• 描述: Cassandra原生协议用户名。

REAPER_CASS_AUTH_PASSWORD

• 类型: String
• 描述: Cassandra原生协议密码。

REAPER_CASS_AUTH_ENABLED

• 类型: Boolean
• 默认值: false
• 描述: 允许Reaper在通过原生协议建立与Cassandra的连接时发送认证凭据。启用时，必须设置REAPER_CASS_AUTH_USERNAME和REAPER_CASS_AUTH_PASSWORD。

REAPER_CASS_NATIVE_PROTOCOL_SSL_ENCRYPTION_ENABLED

• 类型: Boolean
• 默认值: false
• 描述: 允许Reaper在通过原生协议建立与Cassandra的连接时使用加密连接。

5.3 H2和Postgres后端特定配置

REAPER_DB_DRIVER_CLASS

• 类型: String
• 描述: 指定用于连接数据库的驱动程序。

REAPER_DB_URL

• 类型: String
• 描述: 指定连接数据库的URL。

REAPER_DB_USERNAME

• 类型: String
• 描述: 数据库用户名。

REAPER_DB_PASSWORD

• 类型: String
• 描述: 数据库密码。

完整文档请访问: [***]
代码仓库: https://github.com/thelastpickle/cassandra-reaper