doyoubi/undermoon

Undermoon !https://github.com/doyoubi/undermoon/workflows/Continuous%20Integration/badge.svg?event=push

镜像概述

Undermoon是一款基于Redis Cluster Protocol的自管理Redis集群系统，旨在提供高可用、可水平扩展的Redis存储服务，并支持通过HTTP API进行集群管理。任何实现Redis协议的存储系统（如KeyDB）均可与Undermoon兼容。

核心功能

• 水平扩展与高可用
• 通过HTTP API进行集群管理
• 主从节点自动故障转移
• 快速扩容
• 支持集群模式与非集群模式客户端
• 字符串值压缩

架构

Undermoon的架构由以下组件构成：

1. Metadata Storage：存储整个集群的元数据（Redis实例、代理、暴露的集群信息），当前使用Memory Broker，在Kubernetes环境下可通过ConfigMap存储。
2. Coordinator：同步Metadata Broker与服务器代理的元数据，检查代理存活状态并触发故障转移。
3. Storage Cluster：由服务器代理和Redis实例组成，对外提供类似官方Redis Cluster的服务，可通过Redis Cluster Proxy兼容非智能客户端。
4. Chunk：集群的最小构建单元，包含4个Redis实例和2个分布在不同物理机的服务器代理，确保负载均衡。

使用场景

• 需要高可用Redis集群的应用系统
• 需动态扩展Redis存储容量的业务场景
• 需兼容非集群模式Redis客户端的场景

配置说明

在Kubernetes中运行Undermoon

使用https://github.com/doyoubi/undermoon-operator%E6%98%AFKubernetes%E7%8E%AF%E5%A2%83%E4%B8%8B%E5%88%9B%E5%BB%BA%E9%9B%86%E7%BE%A4%E7%9A%84%E6%9C%80%E7%AE%80%E6%96%B9%E5%BC%8F%EF%BC%9A

bash
helm install my-undermoon-operator undermoon-operator-<x.x.x>.tgz

helm install \
    --set 'cluster.clusterName=my-cluster-name' \
    --set 'cluster.chunkNumber=2' \
    --set 'cluster.maxMemory=2048' \
    --set 'cluster.port=5299' \
    my-cluster \
    -n my-namespace \
    undermoon-cluster-<x.x.x>.tgz

详情请参考undermoon-operator的https://github.com/doyoubi/undermoon-operator%E3%80%82

使用Docker Compose运行

请查看Docker Compose示例文档。

手动部署Undermoon

可参考手动部署文档进行非Docker方式的部署。

开发指南

Undermoon尽量避免使用unsafe及可能导致崩溃的调用（如unwrap）。提交代码前请执行以下命令：

bash
$ make lint
$ make test

更多信息请参考开发指南。

相关文档

• Redis Cluster Protocol与服务器代理
• Chunk组件说明
• Slot迁移机制
• Memory Broker副本
• 非集群模式客户端支持配置
• 命令表
• 性能测试报告
• 最佳实践
• Broker外部存储

API文档

• Proxy UMCTL命令
• HTTP Broker API
• Memory Broker API