k8ssandra/cass-management-api

Datastax Management API for Apache Cassandra™ 镜像文档

镜像概述

Datastax Management API for Apache Cassandra™ 是一个专为Apache Cassandra设计的管理接口工具，通过API方式提供对Cassandra集群的统一管理能力。该镜像封装了Datastax开发的管理接口服务，允许用户通过标准化API（如REST、gRPC）对Cassandra集群执行管理操作，无需直接操作底层集群节点，从而降低管理复杂度，提升操作效率。该镜像适用于需要通过编程或自动化方式管理Cassandra集群的场景，支持与DevOps工具链、监控系统和自动化平台无缝集成。

核心功能特性

1. 多协议API接口支持

• 提供RESTful API和gRPC接口，满足不同场景下的集成需求
• 标准化接口设计，支持版本控制，确保兼容性和可扩展性

2. 全面的集群管理能力

• 集群状态监控：实时获取集群健康状态、节点状态、数据分布信息
• 节点管理：支持节点添加、移除、重启、扩缩容等操作
• 配置管理：动态更新Cassandra配置参数，无需重启集群
• 数据操作支持：提供关键数据操作的安全接口（如备份、修复触发）

3. 监控与告警

• 性能指标采集：CPU、内存、磁盘I/O、网络、CQL查询性能等核心指标
• 自定义告警规则：支持基于指标阈值配置告警条件
• 日志集成：与主流日志系统（如ELK Stack）兼容，便于问题排查

4. 安全与集成

• 认证授权：支持Cassandra原生认证、LDAP和TLS加密
• 集成能力：可与Prometheus、Grafana、Ansible、Kubernetes等工具无缝集成
• 审计日志：记录所有API操作，满足合规性要求

使用场景

1. DevOps自动化管理

• 适合DevOps团队通过API实现Cassandra集群的自动化部署、扩缩容和配置更新
• 集成CI/CD流水线，实现数据库变更的自动化测试和部署

2. 大规模集群管理

• 针对包含数十或数百个节点的Cassandra集群，提供集中式管理接口，简化操作复杂度

3. 第三方系统集成

• 允许监控系统、运维平台、业务系统通过API获取Cassandra状态或执行管理操作
• 例如：自定义管理面板、业务系统触发数据备份等

4. 监控与告警系统构建

• 结合Prometheus和Grafana，通过API采集指标构建可视化监控仪表盘
• 配置告警规则，实现集群异常的实时通知

使用方法

Docker Run 命令示例

bash
docker run -d \
  --name datastax-mgmt-api \
  -p 8080:8080 \  # API服务端口
  -e CASSANDRA_CONTACT_POINTS="cassandra-node1:9042,cassandra-node2:9042" \  # Cassandra集群接触点
  -e MGMT_API_PORT=8080 \  # API服务监听端口
  -e AUTH_ENABLED=true \  # 启用认证
  -e AUTH_USERNAME="admin" \  # 管理员用户名
  -e AUTH_PASSWORD="secure-password" \  # 管理员密码
  -e LOG_LEVEL="INFO" \  # 日志级别
  -v /host/path/config:/app/config \  # 挂载配置文件目录（可选）
  -v /host/path/logs:/app/logs \  # 挂载日志目录（可选）
  datastax/datastax-mgmt-api:latest

环境变量配置

API 使用示例

获取集群状态（REST API）

bash
# 未启用认证
curl http://localhost:8080/api/v1/cluster/state

# 启用认证
curl -u admin:secure-password http://localhost:8080/api/v1/cluster/state

响应示例：

json
{
  "clusterName": "my-cassandra-cluster",
  "status": "HEALTHY",
  "nodes": [
    {"host": "cassandra-node1", "status": "UP", "load": "12GB"},
    {"host": "cassandra-node2", "status": "UP", "load": "15GB"}
  ],
  "keyspaces": ["system", "my_app_keyspace"]
}

触发节点修复（REST API）

bash
curl -u admin:secure-password -X POST http://localhost:8080/api/v1/nodes/cassandra-node1/repair \
  -H "Content-Type: application/json" \
  -d '{"keyspace": "my_app_keyspace", "parallelism": "SEQUENTIAL"}'

配置说明

核心配置参数

• 集群连接配置：通过CASSANDRA_CONTACT_POINTS指定Cassandra集群的初始接触点，API服务将自动发现整个集群
• 认证配置：建议生产环境启用AUTH_ENABLED=true，并通过AUTH_USERNAME和AUTH_PASSWORD设置管理员凭证
• TLS配置：若需加密API通信，启用TLS_ENABLED=true并挂载证书文件到容器内指定路径（TLS_CERT_PATH和TLS_KEY_PATH）
• 指标采集：默认通过METRICS_EXPORT_PORT暴露Prometheus格式指标，可直接配置Prometheus抓取该端口

持久化与日志

• 配置文件：可通过挂载/app/config目录自定义API服务配置（如超时时间、API速率限制等）
• 日志：日志默认输出到标准输出，也可通过挂载/app/logs目录将日志持久化到宿主机

注意事项

• 确保API服务与Cassandra集群网络连通，防火墙需开放Cassandra的CQL端口（默认9042）和API服务端口
• 生产环境中建议启用认证和TLS加密，避免未授权访问
• 大规模集群管理时，建议单独部署API服务并配置负载均衡，确保高可用性
• 定期更新镜像版本以获取最新功能和安全修复