https://github.com/alauda/redis-operator

RedisOperator is a production-ready Kubernetes operator designed to simplify the deployment and management of Redis Sentinel, Redis clusters, and standalone Redis instances.
https://github.com/alauda/redis-operator

acl cluster crd kubenetes operator redis sentinel valkey

Last synced: about 2 months ago
JSON representation

RedisOperator is a production-ready Kubernetes operator designed to simplify the deployment and management of Redis Sentinel, Redis clusters, and standalone Redis instances.

• Host: GitHub
• URL: https://github.com/alauda/redis-operator
• Owner: alauda
• License: other
• Created: 2023-11-06T08:51:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-30T01:39:47.000Z (4 months ago)
• Last Synced: 2024-08-30T07:08:17.798Z (4 months ago)
• Topics: acl, cluster, crd, kubenetes, operator, redis, sentinel, valkey
• Language: Go
• Homepage:
• Size: 788 KB
• Stars: 7
• Watchers: 12
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RedisOperator [![Coverage Status](https://coveralls.io/repos/github/alauda/redis-operator/badge.svg?branch=main)](https://coveralls.io/github/alauda/redis-operator?branch=main)

**RedisOperator** is a production-ready kubernetes operator to deploy and manage high available [Redis Sentinel](https://redis.io/docs/management/sentinel/) and [Redis Cluster](https://redis.io/docs/reference/cluster-spec/) instances. This repository contains multi [Custom Resource Definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) designed for the lifecycle of Redis standalone, sentinel or cluster instance.

## Features

* Standalone/Sentinel/Cluster redis arch supported.

* Redis ACL supported.

* Redis 6.0, 6.2, 7.0, 7.2, 7.4 supported (only versions 6.0 and 7.2 have undergone thorough testing. 5.0 also supported, but no acl supported).

* Nodeport/LB access supported; nodeport assignement also supported.

* IPv4/IPv6 supported.

* Online scale up/down.

* Graceful version upgrade.

* Nodeselector, toleration and affinity supported.

* High available in production environment.

## Quickstart

If you have a Kubernetes cluster and `kubectl` configured to access it, run the following command to instance the operator:

TODO

## Documentation

RedisOperator is covered by following topics:

* **TODO** Operator overview

* **TODO** Deploying the operator

* **TODO** Deploying a Redis sentinel/cluster instance

* **TODO** Monitoring the instance 

In addition, few [samples](./config/samples) can be find in this repo.

## Contributing

This project follows the typical GitHub pull request model. Before starting any work, please either comment on an [existing issue](https://github.com/alauda/redis-operator/issues), or file a new one. For more details, please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

## Releasing

To release a new version of the RedisOperator, create a versioned tag (e.g. `v3.18.0`) of the repo, and the release pipeline will generate a new draft release, along side release artefacts.

## License

[Licensed under Apache 2.0](LICENSE)