Merge pull request #18 from ucloud/v0.2.0

V0.2.0

Author: gaopenghigh

.gitignore

@@ -77,5 +77,6 @@ tags
 # End of https://www.gitignore.io/api/go,vim,emacs,visualstudiocode
 .idea/*
 vendor/*
-manager
-main
+/main
+/Dockerfile-withvendor
+Dockerfile-TZSH

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.12.9-alpine3.9 as go-builder
+FROM golang:1.13.3-alpine as go-builder
 
 RUN apk update && apk upgrade && \
     apk add --no-cache ca-certificates git mercurial
@@ -19,7 +19,7 @@ RUN go mod download
 COPY pkg ./ cmd ./ version ./
 
 RUN GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o ${GOBIN}/${PROJECT_NAME} \
-    -ldflags "-X ${REPO_PATH}/pkg/version.Version=${VERSION} -X ${REPO_PATH}/pkg/version.GitSHA=${GIT_SHA}" \
+    -ldflags "-X ${REPO_PATH}/version.Version=${VERSION} -X ${REPO_PATH}/version.GitSHA=${GIT_SHA}" \
     $BUILD_PATH
 
 # =============================================================================

Dockerfile-withvendor

@@ -0,0 +1,56 @@
+SHELL=/bin/bash -o pipefail
+
+PROJECT_NAME=redis-cluster-operator
+REPO=ucloud/$(PROJECT_NAME)
+
+# replace with your public registry
+ALTREPO=$(DOCKER_REGISTRY)/$(PROJECT_NAME)
+E2EALTREPO=$(DOCKER_REGISTRY)/$(PROJECT_NAME)-e2e
+
+VERSION=$(shell git describe --always --tags --dirty | sed "s/\(.*\)-g`git rev-parse --short HEAD`/\1/")
+GIT_SHA=$(shell git rev-parse --short HEAD)
+BIN_DIR=build/bin
+.PHONY: all build check clean test login build-e2e push push-e2e build-tools
+
+all: check build
+
+build: test build-go build-image
+
+build-go:
+	GO111MODULE=on CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build \
+	-ldflags "-X github.com/$(REPO)/version.Version=$(VERSION) -X github.com/$(REPO)/version.GitSHA=$(GIT_SHA)" \
+	-o $(BIN_DIR)/$(PROJECT_NAME)-linux-amd64 cmd/manager/main.go
+	GO111MODULE=on CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build \
+	-ldflags "-X github.com/$(REPO)/version.Version=$(VERSION) -X github.com/$(REPO)/version.GitSHA=$(GIT_SHA)" \
+	-o $(BIN_DIR)/$(PROJECT_NAME)-darwin-amd64 cmd/manager/main.go
+
+build-image:
+	docker build --build-arg VERSION=$(VERSION) --build-arg GIT_SHA=$(GIT_SHA) -t $(ALTREPO):$(VERSION) .
+	docker tag $(ALTREPO):$(VERSION) $(ALTREPO):latest
+
+build-e2e:
+	docker build -t $(E2EALTREPO):$(VERSION)  -f test/e2e/Dockerfile .
+
+build-tools:
+	bash hack/docker/redis-tools/make.sh build
+
+test:
+	GO111MODULE=on go test $$(go list ./... | grep -v /vendor/) -race -coverprofile=coverage.txt -covermode=atomic
+
+login:
+	@docker login -u "$(DOCKER_USER)" -p "$(DOCKER_PASS)"
+
+push: build-image
+	docker push $(ALTREPO):$(VERSION)
+	docker push $(ALTREPO):latest
+
+push-e2e: build-e2e
+	docker push $(E2EALTREPO):$(VERSION)
+
+clean:
+	rm -f $(BIN_DIR)/$(PROJECT_NAME)*
+
+check: check-format
+
+check-format:
+	@test -z "$$(gofmt -s -l . 2>&1 | grep -v -e vendor/ | tee /dev/stderr)"

Makefile

@@ -1,4 +1,4 @@
-# redis-operator
+# redis-cluster-operator
 
 ## Overview
 
@@ -8,10 +8,39 @@ The operator itself is built with the [Operator framework](https://github.com/op
 
 ![Redis Cluster atop Kubernetes](/static/redis-cluster.png)
 
+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+.
-* Access to a Kubernetes v1.13.3 cluster.
+* Access to a Kubernetes v1.13.10 cluster.
 
 ## Features
 
@@ -29,7 +58,6 @@ The operator itself is built with the [Operator framework](https://github.com/op
 
 - __Prometheus Discovery__
 
-
 ## Quick Start
 
 ### Deploy redis cluster operator
@@ -76,33 +104,41 @@ NAME                              MASTERSIZE   STATUS    AGE
 example-distributedrediscluster   3            Scaling   11s
 
 $ kubectl get all -l redis.kun/name=example-distributedrediscluster
-NAME                                        READY   STATUS    RESTARTS   AGE
-pod/drc-example-distributedrediscluster-0   1/1     Running   0          4m5s
-pod/drc-example-distributedrediscluster-1   1/1     Running   0          3m31s
-pod/drc-example-distributedrediscluster-2   1/1     Running   0          2m54s
-pod/drc-example-distributedrediscluster-3   1/1     Running   0          2m20s
-pod/drc-example-distributedrediscluster-4   1/1     Running   0          103s
-pod/drc-example-distributedrediscluster-5   1/1     Running   0          62s
-
-NAME                                      TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)              AGE
-service/example-distributedrediscluster   ClusterIP   None         <none>        6379/TCP,16379/TCP   4m5s
-
-NAME                                                   READY   AGE
-statefulset.apps/drc-example-distributedrediscluster   6/6     4m5s
+NAME                                          READY   STATUS    RESTARTS   AGE
+pod/drc-example-distributedrediscluster-0-0   1/1     Running   0          2m48s
+pod/drc-example-distributedrediscluster-0-1   1/1     Running   0          2m8s
+pod/drc-example-distributedrediscluster-1-0   1/1     Running   0          2m48s
+pod/drc-example-distributedrediscluster-1-1   1/1     Running   0          2m13s
+pod/drc-example-distributedrediscluster-2-0   1/1     Running   0          2m48s
+pod/drc-example-distributedrediscluster-2-1   1/1     Running   0          2m15s
+
+NAME                                        TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)              AGE
+service/example-distributedrediscluster     ClusterIP   172.17.132.71   <none>        6379/TCP,16379/TCP   2m48s
+service/example-distributedrediscluster-0   ClusterIP   None            <none>        6379/TCP,16379/TCP   2m48s
+service/example-distributedrediscluster-1   ClusterIP   None            <none>        6379/TCP,16379/TCP   2m48s
+service/example-distributedrediscluster-2   ClusterIP   None            <none>        6379/TCP,16379/TCP   2m48s
+
+NAME                                                     READY   AGE
+statefulset.apps/drc-example-distributedrediscluster-0   2/2     2m48s
+statefulset.apps/drc-example-distributedrediscluster-1   2/2     2m48s
+statefulset.apps/drc-example-distributedrediscluster-2   2/2     2m48s
 
 $ kubectl get distributedrediscluster
 NAME                              MASTERSIZE   STATUS    AGE
 example-distributedrediscluster   3            Healthy   4m
 ```
 
-#### Scaling the Redis Cluster
+#### Scaling Up the Redis Cluster
 
-Increase the masterSize to trigger the scaling.
+Increase the masterSize to trigger the scaling up.
 
 ```
 apiVersion: redis.kun/v1alpha1
 kind: DistributedRedisCluster
 metadata:
+  annotations:
+    # if your operator run as cluster-scoped, add this annotations
+    redis.kun/scope: cluster-scoped
   name: example-distributedrediscluster
 spec:
   # Increase the masterSize to trigger the scaling.
@@ -111,8 +147,29 @@ spec:
   image: redis:5.0.4-alpine
 ```
 
+#### Scaling Down the Redis Cluster
+
+Decrease the masterSize to trigger the scaling down.
+
+```
+apiVersion: redis.kun/v1alpha1
+kind: DistributedRedisCluster
+metadata:
+  annotations:
+    # if your operator run as cluster-scoped, add this annotations
+    redis.kun/scope: cluster-scoped
+  name: example-distributedrediscluster
+spec:
+  # Increase the masterSize to trigger the scaling.
+  masterSize: 3
+  ClusterReplicas: 1
+  image: redis:5.0.4-alpine
+```
+
 #### Backup and Restore
 
+**Only Ceph object storage is supported now**
+
 Backup
 ```
 $ kubectl create -f deploy/example/backup-restore/redisclusterbackup_cr.yaml
@@ -147,7 +204,7 @@ $ kubectl create -f deploy/example/persistent.yaml
 $ kubectl create -f deploy/example/custom-config.yaml
 ```
 
-#### Custom Headless Service
+#### Custom Service
 
 ```
 $ kubectl create -f deploy/example/custom-service.yaml
@@ -157,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)

README.md

@@ -27,8 +27,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 
 	"github.com/ucloud/redis-cluster-operator/pkg/apis"
+	redisv1alpha1 "github.com/ucloud/redis-cluster-operator/pkg/apis/redis/v1alpha1"
 	config2 "github.com/ucloud/redis-cluster-operator/pkg/config"
 	"github.com/ucloud/redis-cluster-operator/pkg/controller"
+	"github.com/ucloud/redis-cluster-operator/pkg/controller/distributedrediscluster"
+	"github.com/ucloud/redis-cluster-operator/pkg/controller/redisclusterbackup"
+	"github.com/ucloud/redis-cluster-operator/pkg/utils"
 	"github.com/ucloud/redis-cluster-operator/version"
 )
 
@@ -52,6 +56,9 @@ func main() {
 	// be added before calling pflag.Parse().
 	pflag.CommandLine.AddFlagSet(zap.FlagSet())
 
+	pflag.CommandLine.AddFlagSet(distributedrediscluster.FlagSet())
+	pflag.CommandLine.AddFlagSet(redisclusterbackup.FlagSet())
+
 	// Add flags registered by imported packages (e.g. glog and
 	// controller-runtime)
 	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
@@ -78,6 +85,8 @@ func main() {
 		os.Exit(1)
 	}
 
+	utils.SetClusterScoped(namespace)
+
 	// Get a config to talk to the apiserver
 	cfg, err := config.GetConfig()
 	if err != nil {
@@ -146,6 +155,17 @@ func main() {
 		}
 	}
 
+	if os.Getenv("ENABLE_WEBHOOKS") == "true" {
+		log.Info("Starting the WebHook.")
+		ws := mgr.GetWebhookServer()
+		ws.CertDir = "/etc/webhook/certs"
+		ws.Port = 7443
+		if err = (&redisv1alpha1.DistributedRedisCluster{}).SetupWebhookWithManager(mgr); err != nil {
+			log.Error(err, "unable to create webHook", "webHook", "DistributedRedisCluster")
+			os.Exit(1)
+		}
+	}
+
 	log.Info("Starting the Cmd.")
 
 	// Start the Cmd

cmd/manager/main.go

@@ -14,6 +14,7 @@ rules:
       - get
       - list
       - watch
+      - delete
   - apiGroups:
       - ""
     resources:
@@ -29,6 +30,7 @@ rules:
       - patch
       - update
       - watch
+      - delete
   - apiGroups:
       - ""
     resources:
@@ -48,6 +50,7 @@ rules:
       - patch
       - update
       - watch
+      - delete
   - apiGroups:
       - apps
     resources:
@@ -61,6 +64,7 @@ rules:
       - patch
       - update
       - watch
+      - delete
   - apiGroups:
       - policy
     resources:
@@ -72,6 +76,7 @@ rules:
       - patch
       - update
       - watch
+      - delete
   - apiGroups:
       - apps
     resourceNames: