update readme

Author: polefishu

README.md

@@ -11,6 +11,32 @@ The operator itself is built with the [Operator framework](https://github.com/op
 Each master node and its slave nodes is managed by a statefulSet, create a headless svc for each statefulSet,
 and create a clusterIP service for all nodes.
 
+Each statefulset uses PodAntiAffinity to ensure that the master and slaves are dispersed on different nodes.
+At the same time, when the operator selects the master in each statefulset, it preferentially select the pod
+with different k8s nodes as master.
+
+Table of Contents
+=================
+
+   * [redis-cluster-operator](#redis-cluster-operator)
+      * [Overview](#overview)
+      * [Prerequisites](#prerequisites)
+      * [Features](#features)
+      * [Quick Start](#quick-start)
+         * [Deploy redis cluster operator](#deploy-redis-cluster-operator)
+            * [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)
+            * [Backup and Restore](#backup-and-restore)
+            * [Prometheus Discovery](#prometheus-discovery)
+            * [Create Redis Cluster with password](#create-redis-cluster-with-password)
+            * [Persistent Volume](#persistent-volume)
+            * [Custom Configuration](#custom-configuration)
+            * [Custom Service](#custom-service)
+            * [Custom Resource](#custom-resource)
+      * [ValidatingWebhook](#validatingwebhook)
+      * [End to end tests](#end-to-end-tests)
+
 ## Prerequisites
 
 * go version v1.13+.
@@ -32,7 +58,6 @@ and create a clusterIP service for all nodes.
 
 - __Prometheus Discovery__
 
-
 ## Quick Start
 
 ### Deploy redis cluster operator
@@ -143,7 +168,7 @@ spec:
 
 #### Backup and Restore
 
-**Only Ceph  object storage is supported now**
+**Only Ceph object storage is supported now**
 
 Backup
 ```
@@ -189,4 +214,12 @@ $ kubectl create -f deploy/example/custom-service.yaml
 
 ```
 $ kubectl create -f deploy/example/custom-resources.yaml
-```
+```
+
+## ValidatingWebhook
+
+see [ValidatingWebhook](/hack/webhook/README.md)
+
+## End to end tests
+
+see [e2e](/test/e2e/README.md)

hack/webhook/README.md

@@ -0,0 +1,36 @@
+# ValidatingWebhook for distributedredisclusters
+
+## Prerequisites
+
+Kubernetes with the `admissionregistration.k8s.io/v1beta1` API enabled. Verify that by the following command:
+```
+kubectl api-versions | grep admissionregistration.k8s.io/v1beta1
+```
+The result should be:
+```
+admissionregistration.k8s.io/v1beta1
+```
+
+In addition, the `MutatingAdmissionWebhook` and `ValidatingAdmissionWebhook` admission controllers should be added and listed in the correct order in the admission-control flag of kube-apiserver.
+
+## Deploy
+
+1. Create a signed cert/key pair and store it in a Kubernetes `secret` that will be consumed by operator deployment
+```
+./create-signed-cert.sh --service drc-admission-webhook --secret drc-webhook-cert --namespace default
+```
+
+2. Patch the `ValidatingWebhookConfiguration` by set `caBundle` with correct value from Kubernetes cluster
+```
+cat validatingwebhook.yaml | \
+    patch-ca-bundle.sh > \
+    validatingwebhook-ca-bundle.yaml
+```
+
+3. Deploy resources
+```
+kubectl delete -f operator.yml
+kubectl create -f operator.yml
+kubectl create -f validatingwebhook-ca-bundle.yaml
+kubectl create -f service.yaml
+```

hack/webhook/operator.yml

@@ -0,0 +1,74 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: redis-cluster-operator
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      name: redis-cluster-operator
+  template:
+    metadata:
+      labels:
+        name: redis-cluster-operator
+    spec:
+      serviceAccountName: redis-cluster-operator
+      containers:
+        - name: redis-cluster-operator
+          image: uhub.service.ucloud.cn/operator/redis-cluster-operator:latest
+          command:
+            - redis-cluster-operator
+          args:
+            - --zap-level=4
+            - --zap-time-encoding=iso8601
+            - --ctr-maxconcurrent=10
+            - --rename-command-path=/etc/redisconf
+            - --rename-command-file=redis.conf
+          imagePullPolicy: Always
+          resources:
+            limits:
+              cpu: "2"
+              memory: 2000Mi
+            requests:
+              cpu: 500m
+              memory: 500Mi
+          env:
+            - name: WATCH_NAMESPACE
+              value: ""
+            - name: ENABLE_WEBHOOKS
+              value: "true"
+            - name: POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
+            - name: OPERATOR_NAME
+              value: "redis-cluster-operator"
+          volumeMounts:
+            - name: redisconf
+              mountPath: /etc/redisconf
+            - name: webhook-certs
+              mountPath: /etc/webhook/certs
+              readOnly: true
+      volumes:
+        - name: redisconf
+          configMap:
+            name: redis-admin
+        - name: webhook-certs
+          secret:
+            secretName: drc-webhook-cert
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: redis-admin
+data:
+  redis.conf: |-
+    rename-command CONFIG lni07z1p
+    rename-command BGSAVE pp14qluk
+    rename-command DEBUG 8a4insyv
+    rename-command SAVE 6on30p6z
+    rename-command SHUTDOWN dvui0opr
+    rename-command SLAVEOF xwxvcw36
+    rename-command BGREWRITEAOF www07fko
+    rename-command FLUSHDB dfqw3rsf
+    rename-command FLUSHALL zvsdf2ff

test/e2e/README.md

@@ -0,0 +1,8 @@
+# End to end tests for DistributedRedisCluster and RedisClusterBackup
+
+## Run test in Kubernetes
+
+`kubectl create -f deploy/e2e.yml`
+
+## Build and push e2e test images
+` DOCKER_REGISTRY=your_registry make push-e2e`