openebs/mayastor-api-rest

Mayastor REST API服务镜像文档

概述

Mayastor REST API服务镜像是Mayastor存储系统的核心组件，提供RESTful API接口，用于通过编程方式管理和监控Mayastor存储集群。该服务允许用户执行存储资源的创建、配置、查询和删除等操作，是自动化集成Mayastor存储系统的关键桥梁。

核心功能与特性

1. RESTful API接口

• 遵循REST规范，支持标准HTTP方法（GET/POST/PUT/DELETE）
• 提供JSON格式的请求与响应，易于解析和集成
• 版本化API设计（如/api/v1），确保接口兼容性

2. 存储资源管理

• 存储池（Storage Pool）管理：创建、查询、扩容、删除存储池
• 卷（Volume）操作：创建持久卷、绑定卷到节点、扩容卷、删除卷
• 存储节点监控：查询节点存储容量、使用率、健康状态

3. 监控与诊断能力

• 实时查询存储集群状态及性能指标（IOPS、吞吐量、延迟）
• 支持事件日志记录，追踪存储操作历史
• 提供健康检查接口，快速诊断服务可用性

4. 安全特性

• 支持TLS加密传输（需配置证书）
• 可选的API访问认证（如Bearer Token）

使用场景

1. 自动化运维

• 集成到CI/CD流水线，实现存储资源的按需创建与清理
• 通过脚本自动化执行存储扩容、故障转移等运维操作

2. 管理平台集成

• 作为后端服务集成到存储管理平台（如Kubernetes Operator、OpenStack Cinder）
• 对接监控系统（Prometheus、Grafana），实现存储指标可视化

3. 开发与测试

• 开发人员通过API快速构建测试环境的存储配置
• 自动化测试框架调用API验证存储功能正确性

使用方法

前置条件

• 已部署Mayastor存储集群，且集群控制平面可访问
• 主机需开放API服务端口（默认8080）

启动容器

基础启动命令

bash
docker run -d \
  --name mayastor-api \
  -p 8080:8080 \
  -e MAYASTOR_CLUSTER_ADDR=mayastor-control-plane:50051 \
  mayastor/rest-api:latest

带TLS配置的启动命令

bash
docker run -d \
  --name mayastor-api-tls \
  -p 8443:8443 \
  -e MAYASTOR_CLUSTER_ADDR=mayastor-control-plane:50051 \
  -e API_PORT=8443 \
  -e TLS_ENABLED=true \
  -e TLS_CERT_PATH=/certs/server.crt \
  -e TLS_KEY_PATH=/certs/server.key \
  -v /host/path/to/certs:/certs \
  mayastor/rest-api:latest

环境变量配置

API访问示例

获取所有卷列表

bash
curl http://localhost:8080/api/v1/volumes

创建存储池

bash
curl -X POST http://localhost:8080/api/v1/storage-pools \
  -H "Content-Type: application/json" \
  -d '{
    "name": "pool-1",
    "node": "mayastor-node-01",
    "devices": ["/dev/sdb"]
  }'

注意事项

• API服务需与Mayastor集群控制平面网络互通，建议部署在同一网络命名空间
• 生产环境中建议启用TLS加密和API认证，避免未授权访问
• 高可用性部署需配合负载均衡器（如NGINX）实现多实例冗余