Merge pull request #181 from atoato88/update-guestbook-operator

Update GuestbookOperator with kubebuiler v3

Author: k8s-ci-robot

docs/addon/walkthrough/README.md

@@ -7,7 +7,7 @@ This walkthrough is for creating an operator to run the [guestbook](https://gith
 Install the following depenencies:
 
 - [kubebuilder](https://book.kubebuilder.io/quick-start.html#installation) (tested with 3.1.0)
-- [kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/) (tested with v2.0.3)
+- [kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/) (tested with v3.8.7)
 - docker
 - kubectl
 - golang (>=1.11 for go modules)
@@ -298,7 +298,7 @@ EOF
 3. Reference the patch by adding `manager_resource_patch.yaml` to the `patches` section of `config/default/kustomization.yaml`:
 
 ```yaml
-patches:
+patchesStrategicMerge:
 - manager_resource_patch.yaml
 # ... existing patches
 ```
@@ -309,38 +309,36 @@ This is requried to run kubectl in the container.
    and run in a slim container:
 
 ```Dockerfile
-FROM ubuntu:latest as kubectl
-RUN apt-get update
-RUN apt-get install -y curl
-RUN curl -fsSL https://dl.k8s.io/release/v1.13.4/bin/linux/amd64/kubectl > /usr/bin/kubectl
-RUN chmod a+rx /usr/bin/kubectl
-
 # Build the manager binary
-FROM golang:1.15 as builder
+FROM golang:1.16 as builder
 
 # Copy in the go src
-WORKDIR /go/src/guestbook-operator
+WORKDIR /workspace
 # Copy the Go Modules manifests
 COPY go.mod go.mod
 COPY go.sum go.sum
 # cache deps before building and copying source so that we don't need to re-download as much
 # and so that source changes don't invalidate our downloaded layer
 RUN go mod download
-
 COPY vendor/   vendor/
+
 COPY main.go main.go
 COPY api/ api/
 COPY controllers/ controllers/
+COPY channels/ channels/
+RUN chmod -R a+rx channels/
 
 # Build
 RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o manager main.go
 
 # Copy the operator and dependencies into a thin image
 FROM gcr.io/distroless/static:latest
 WORKDIR /
-COPY --from=builder /go/src/guestbook-operator/manager .
-COPY --from=kubectl /usr/bin/kubectl /usr/bin/kubectl
-COPY channels/ channels/
+COPY --from=builder /workspace/manager .
+COPY --from=builder /workspace/channels/ channels/
+
+USER 65532:65532
+
 ENTRYPOINT ["./manager"]
 ```
 
@@ -426,7 +424,7 @@ You can verify that the operator has created the `kubernetes-guestbook`
 deployment:
 
 e.g. `kubectl get pods -n guestbook-operator-system` or
-`kubectl get deploy -n guestbook-operator-system`.
+`kubectl get deployments -n guestbook-operator-system`.
 
 ## Manifest simplification: Automatic labels
 

examples/guestbook-operator/Dockerfile

@@ -1,33 +1,31 @@
-FROM ubuntu:latest as kubectl
-RUN apt-get update
-RUN apt-get install -y curl
-RUN curl -fsSL https://dl.k8s.io/release/v1.13.4/bin/linux/amd64/kubectl > /usr/bin/kubectl
-RUN chmod a+rx /usr/bin/kubectl
-
 # Build the manager binary
-FROM golang:1.13 as builder
+FROM golang:1.16 as builder
 
 # Copy in the go src
-WORKDIR /go/src/guestbook-operator
+WORKDIR /workspace
 # Copy the Go Modules manifests
 COPY go.mod go.mod
 COPY go.sum go.sum
 # cache deps before building and copying source so that we don't need to re-download as much
 # and so that source changes don't invalidate our downloaded layer
 RUN go mod download
-
 COPY vendor/   vendor/
+
 COPY main.go main.go
 COPY api/ api/
 COPY controllers/ controllers/
+COPY channels/ channels/
+RUN chmod -R a+rx channels/
 
 # Build
 RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o manager main.go
 
 # Copy the operator and dependencies into a thin image
 FROM gcr.io/distroless/static:latest
 WORKDIR /
-COPY --from=builder /go/src/guestbook-operator/manager .
-COPY --from=kubectl /usr/bin/kubectl /usr/bin/kubectl
-COPY channels/ channels/
+COPY --from=builder /workspace/manager .
+COPY --from=builder /workspace/channels/ channels/
+
+USER 65532:65532
+
 ENTRYPOINT ["./manager"]

examples/guestbook-operator/Makefile

@@ -2,7 +2,7 @@
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest
 # Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
-CRD_OPTIONS ?= "crd:trivialVersions=true"
+CRD_OPTIONS ?= "crd:trivialVersions=true,preserveUnknownFields=false"
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -11,80 +11,101 @@ else
 GOBIN=$(shell go env GOBIN)
 endif
 
-all: manager
+# Setting SHELL to bash allows bash commands to be executed by recipes.
+# This is a requirement for 'setup-envtest.sh' in the test target.
+# Options are set to exit when a recipe line exits non-zero or a piped command fails.
+SHELL = /usr/bin/env bash -o pipefail
+.SHELLFLAGS = -ec
 
-# Run tests
-test: generate fmt vet manifests
-	go test ./... -coverprofile cover.out
+all: build
 
-# Build manager binary
-manager: generate fmt vet
-	go build -o bin/manager main.go
-
-# Run against the configured Kubernetes cluster in ~/.kube/config
-run: generate fmt vet manifests
-	go run ./main.go
+##@ General
 
-# Install CRDs into a cluster
-install: manifests
-	kustomize build config/crd | kubectl apply -f -
+# The help target prints out all targets with their descriptions organized
+# beneath their categories. The categories are represented by '##@' and the
+# target descriptions by '##'. The awk commands is responsible for reading the
+# entire set of makefiles included in this invocation, looking for lines of the
+# file as xyz: ## something, and then pretty-format the target and help. Then,
+# if there's a line with ##@ something, that gets pretty-printed as a category.
+# More info on the usage of ANSI control characters for terminal formatting:
+# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
+# More info on the awk command:
+# http://linuxcommand.org/lc3_adv_awk.php
 
-# Uninstall CRDs from a cluster
-uninstall: manifests
-	kustomize build config/crd | kubectl delete -f -
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
-# Deploy controller in the configured Kubernetes cluster in ~/.kube/config
-deploy: manifests
-	cd config/manager && kustomize edit set image controller=${IMG}
-	kustomize build config/default | kubectl apply -f -
+##@ Development
 
-# Teardown controller in the configured Kubernetes cluster in ~/.kube/config
-# This command does things that can't always re-run so the exit codes are ignored
-teardown: manifests
-	kustomize build config/default | kubectl delete -f - || true
-
-# Generate manifests e.g. CRD, RBAC etc.
-manifests: controller-gen
+manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 
-# Run go fmt against code
-fmt:
+generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
+	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
+
+fmt: ## Run go fmt against code.
 	go fmt ./...
 
-# Run go vet against code
-vet:
+vet: ## Run go vet against code.
 	go vet ./...
 
-# Run go mod vendor
+ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
+test: manifests generate fmt vet ## Run tests.
+	mkdir -p ${ENVTEST_ASSETS_DIR}
+	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v0.8.3/hack/setup-envtest.sh
+	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out
+
+##@ Build
+
+build: generate fmt vet ## Build manager binary.
+	go build -o bin/manager main.go
+
+run: manifests generate fmt vet ## Run a controller from your host.
+	go run ./main.go
+
+docker-build: vendor test ## Build docker image with the manager.
+	docker build -t ${IMG} .
+
 vendor:
 	go mod vendor
 
-# Generate code
-generate: controller-gen
-	$(CONTROLLER_GEN) object:headerFile=./hack/boilerplate.go.txt paths="./..."
+docker-push: ## Push docker image with the manager.
+	docker push ${IMG}
 
-# Build the docker image
-docker-build: vendor test
-	docker build . -t ${IMG}
+##@ Deployment
 
-# Push the docker image
-docker-push:
-	docker push ${IMG}
+install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build config/crd | kubectl apply -f -
 
-# find or download controller-gen
-# download controller-gen if necessary
-controller-gen:
-ifeq (, $(shell which controller-gen))
-	@{ \
-	set -e ;\
-	CONTROLLER_GEN_TMP_DIR=$$(mktemp -d) ;\
-	cd $$CONTROLLER_GEN_TMP_DIR ;\
-	go mod init tmp ;\
-	go get sigs.k8s.io/controller-tools/cmd/[email protected] ;\
-	rm -rf $$CONTROLLER_GEN_TMP_DIR ;\
-	}
-CONTROLLER_GEN=$(GOBIN)/controller-gen
-else
-CONTROLLER_GEN=$(shell which controller-gen)
-endif
+uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build config/crd | kubectl delete -f -
+
+deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default | kubectl apply -f -
+
+undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build config/default | kubectl delete -f -
+
+
+CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
+controller-gen: ## Download controller-gen locally if necessary.
+	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected])
+
+KUSTOMIZE = $(shell pwd)/bin/kustomize
+kustomize: ## Download kustomize locally if necessary.
+	$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected])
 
+# go-get-tool will 'go get' any package $2 and install it to $1.
+PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
+define go-get-tool
+@[ -f $(1) ] || { \
+set -e ;\
+TMP_DIR=$$(mktemp -d) ;\
+cd $$TMP_DIR ;\
+go mod init tmp ;\
+echo "Downloading $(2)" ;\
+GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
+rm -rf $$TMP_DIR ;\
+}
+endef

examples/guestbook-operator/PROJECT

@@ -1,7 +1,24 @@
 domain: example.org
-repo: sigs.k8s.io/kubebuilder-declarative-pattern
+layout:
+- go.kubebuilder.io/v3
+- declarative.go.kubebuilder.io/v1
+plugins:
+  declarative.go.kubebuilder.io/v1:
+    resources:
+    - domain: example.org
+      group: addons
+      kind: Guestbook
+      version: v1alpha1
+projectName: guestbook-operator
+repo: example.org/guestbook-operator
 resources:
-- group: addons
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: example.org
+  group: addons
   kind: Guestbook
+  path: example.org/guestbook-operator/api/v1alpha1
   version: v1alpha1
-version: "2"
+version: "3"