Skip to content

Commit a01fa97

Browse files
authored
Merge pull request ucloud#67 from ucloud/feature/helm-chart-on-github
host chart on github
2 parents 68cf8a6 + f4cdcea commit a01fa97

File tree

11 files changed

+20
-0
lines changed

11 files changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,14 @@ Table of Contents
2020

2121
* [redis-cluster-operator](#redis-cluster-operator)
2222
* [Overview](#overview)
23+
* [Table of Contents](#table-of-contents)
2324
* [Prerequisites](#prerequisites)
2425
* [Features](#features)
2526
* [Quick Start](#quick-start)
2627
* [Deploy redis cluster operator](#deploy-redis-cluster-operator)
28+
* [Install Step by step](#install-step-by-step)
29+
* [Install using helm chart](#install-using-helm-chart)
30+
* [Usage](#usage)
2731
* [Deploy a sample Redis Cluster](#deploy-a-sample-redis-cluster)
2832
* [Scaling Up the Redis Cluster](#scaling-up-the-redis-cluster)
2933
* [Scaling Down the Redis Cluster](#scaling-down-the-redis-cluster)
@@ -62,6 +66,8 @@ Table of Contents
6266

6367
### Deploy redis cluster operator
6468

69+
#### Install Step by step
70+
6571
Register the DistributedRedisCluster and RedisClusterBackup custom resource definition (CRD).
6672
```
6773
$ kubectl create -f deploy/crds/redis.kun_distributedredisclusters_crd.yaml
@@ -84,13 +90,27 @@ $ kubectl create -f deploy/namespace/role_binding.yaml
8490
$ kubectl create -f deploy/namespace/operator.yaml
8591
```
8692

93+
#### Install using helm chart
94+
95+
Add Helm repository
96+
```
97+
helm repo add ucloud-operator https://ucloud.github.io/redis-cluster-operator/
98+
helm repo update
99+
```
100+
101+
Install chart
102+
```
103+
helm install --generate-name ucloud-operator/redis-cluster-operator
104+
```
105+
87106
Verify that the redis-cluster-operator is up and running:
88107
```
89108
$ kubectl get deployment
90109
NAME READY UP-TO-DATE AVAILABLE AGE
91110
redis-cluster-operator 1/1 1 1 1d
92111
```
93112

113+
### Usage
94114
#### Deploy a sample Redis Cluster
95115

96116
NOTE: **Only the redis cluster that use persistent storage(pvc) can recover after accidental deletion or rolling update.Even if you do not use persistence(like rdb or aof), you need to set pvc for redis.**

0 commit comments

Comments
 (0)