diff --git a/README.md b/README.md index 135bddc16..29ae53973 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,14 @@ Table of Contents * [redis-cluster-operator](#redis-cluster-operator) * [Overview](#overview) + * [Table of Contents](#table-of-contents) * [Prerequisites](#prerequisites) * [Features](#features) * [Quick Start](#quick-start) * [Deploy redis cluster operator](#deploy-redis-cluster-operator) + * [Install Step by step](#install-step-by-step) + * [Install using helm chart](#install-using-helm-chart) + * [Usage](#usage) * [Deploy a sample Redis Cluster](#deploy-a-sample-redis-cluster) * [Scaling Up the Redis Cluster](#scaling-up-the-redis-cluster) * [Scaling Down the Redis Cluster](#scaling-down-the-redis-cluster) @@ -62,6 +66,8 @@ Table of Contents ### Deploy redis cluster operator +#### Install Step by step + Register the DistributedRedisCluster and RedisClusterBackup custom resource definition (CRD). ``` $ kubectl create -f deploy/crds/redis.kun_distributedredisclusters_crd.yaml @@ -84,6 +90,19 @@ $ kubectl create -f deploy/namespace/role_binding.yaml $ kubectl create -f deploy/namespace/operator.yaml ``` +#### Install using helm chart + +Add Helm repository +``` +helm repo add ucloud-operator https://ucloud.github.io/redis-cluster-operator/ +helm repo update +``` + +Install chart +``` +helm install --generate-name ucloud-operator/redis-cluster-operator +``` + Verify that the redis-cluster-operator is up and running: ``` $ kubectl get deployment @@ -91,6 +110,7 @@ NAME READY UP-TO-DATE AVAILABLE AGE redis-cluster-operator 1/1 1 1 1d ``` +### Usage #### Deploy a sample Redis Cluster 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.** diff --git a/chart/redis-cluster-operator/.helmignore b/charts/redis-cluster-operator/.helmignore similarity index 100% rename from chart/redis-cluster-operator/.helmignore rename to charts/redis-cluster-operator/.helmignore diff --git a/chart/redis-cluster-operator/Chart.yaml b/charts/redis-cluster-operator/Chart.yaml similarity index 100% rename from chart/redis-cluster-operator/Chart.yaml rename to charts/redis-cluster-operator/Chart.yaml diff --git a/chart/redis-cluster-operator/crds/redis.kun_distributedredisclusters_crd.yaml b/charts/redis-cluster-operator/crds/redis.kun_distributedredisclusters_crd.yaml similarity index 100% rename from chart/redis-cluster-operator/crds/redis.kun_distributedredisclusters_crd.yaml rename to charts/redis-cluster-operator/crds/redis.kun_distributedredisclusters_crd.yaml diff --git a/chart/redis-cluster-operator/crds/redis.kun_redisclusterbackups_crd.yaml b/charts/redis-cluster-operator/crds/redis.kun_redisclusterbackups_crd.yaml similarity index 100% rename from chart/redis-cluster-operator/crds/redis.kun_redisclusterbackups_crd.yaml rename to charts/redis-cluster-operator/crds/redis.kun_redisclusterbackups_crd.yaml diff --git a/chart/redis-cluster-operator/templates/_helpers.tpl b/charts/redis-cluster-operator/templates/_helpers.tpl similarity index 100% rename from chart/redis-cluster-operator/templates/_helpers.tpl rename to charts/redis-cluster-operator/templates/_helpers.tpl diff --git a/chart/redis-cluster-operator/templates/operator.yaml b/charts/redis-cluster-operator/templates/operator.yaml similarity index 100% rename from chart/redis-cluster-operator/templates/operator.yaml rename to charts/redis-cluster-operator/templates/operator.yaml diff --git a/chart/redis-cluster-operator/templates/role.yaml b/charts/redis-cluster-operator/templates/role.yaml similarity index 100% rename from chart/redis-cluster-operator/templates/role.yaml rename to charts/redis-cluster-operator/templates/role.yaml diff --git a/chart/redis-cluster-operator/templates/role_binding.yaml b/charts/redis-cluster-operator/templates/role_binding.yaml similarity index 100% rename from chart/redis-cluster-operator/templates/role_binding.yaml rename to charts/redis-cluster-operator/templates/role_binding.yaml diff --git a/chart/redis-cluster-operator/templates/service_account.yaml b/charts/redis-cluster-operator/templates/service_account.yaml similarity index 100% rename from chart/redis-cluster-operator/templates/service_account.yaml rename to charts/redis-cluster-operator/templates/service_account.yaml diff --git a/chart/redis-cluster-operator/values.yaml b/charts/redis-cluster-operator/values.yaml similarity index 100% rename from chart/redis-cluster-operator/values.yaml rename to charts/redis-cluster-operator/values.yaml