kvrocks-operator

README

KvrocksOperator

This project provides an operator for managing kvrocks instances on Kubernetes.It is built using the kubebuilder framework.

Quick Start

Deploy

1. Install OpenKruise

helm repo add openkruise https://openkruise.github.io/charts/
helm repo update
helm install kruise openkruise/kruise --version 1.4.0

1. Create ns kvrocks

kubectl create ns kvrocks

1. Use helm to install and manage the crd/operator

git clone https://github.com/RocksLabs/kvrocks-operator.git
helm install kvrocks-crd deploy/crd -n kvrocks
helm install kvrocks-operator deploy/operator -n kvrocks

1. Modify the examples/standard.yaml examples/sentinel.yaml and then apply

kubectl apply -f examples/standard.yaml examples/sentinel.yaml

Notice

1.You need to prepare the storageclass and indicate it in the manifest.
2.We currently support only standalone kvrocks clusters and those with sentinels. Cluster mode is temporarily unsupported.
3.Note the naming rules of kvrocks custom resource. kvrocks-standard-1-demo consists of four parts
(1). kvrocks
(2). type
(3). Indicate the sentinel cluster index used. In this case, the sentinel cluster is: sentinel-1
(4). cluster name

Running e2e tests

Please refer to the Test README for more information.

Observability Configuration Guide

Please refer to the Observability Configuration Guide for more information.

Development Guide

Please refer to the Development Guide for more information.

Design Details

For more design etails, please refer to Design Document.

Community

Feel free to ask us any questions through issues or slack