Upgrade layout from Kubebuilder v2 to Kubebuilder v3.1 (fluent#147)

* Upgrade layout from Kubebuilder v2 to Kubebuilder v3.1

Signed-off-by: chengdehao <[email protected]>

* update and Resolve the conflict

Signed-off-by: chengdehao <[email protected]>

Author: Elon Cheng

.dockerignore

@@ -0,0 +1,5 @@
+# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
+# Ignore all files which are not go type
+!**/*.go
+!**/*.mod
+!**/*.sum

.github/workflows/main.yaml

@@ -25,20 +25,20 @@ jobs:
         with:
           go-version: 1.16.x
 
-      - name: Checkout code
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-
       - uses: actions/cache@v2
         with:
           path: ~/go/pkg/mod
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
 
-      - name: Install kubebuilder-2.3.2
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Install kubebuilder-3.1.0
         run: |
-          curl -L "https://github.com/kubernetes-sigs/kubebuilder/releases/download/v2.3.2/kubebuilder_2.3.2_linux_amd64.tar.gz" | tar -xz -C /tmp/
-          sudo mv /tmp/kubebuilder_2.3.2_linux_amd64 /usr/local/kubebuilder
+          curl -L -o kubebuilder "https://github.com/kubernetes-sigs/kubebuilder/releases/download/v3.1.0/kubebuilder_linux_amd64"
+          chmod +x kubebuilder && mv kubebuilder /usr/local/bin/
 
       - name: Run basic test
         run: make test

Makefile

@@ -4,7 +4,7 @@ FB_IMG ?= kubesphere/fluent-bit:v1.8.3
 OP_IMG ?= kubesphere/fluentbit-operator:$(VERSION)
 AMD64 ?= -amd64
 # 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))
@@ -13,70 +13,76 @@ 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 cmd/manager/main.go
-
-binary: 
-	go build -o bin/manager cmd/manager/main.go
-	go build -o bin/watcher cmd/fluent-bit-watcher/main.go
-
-verify: verify-crds
-
-verify-crds:
-	sudo chmod a+x ./hack/verify-crds.sh && ./hack/verify-crds.sh
+##@ General
 
-# Run against the configured Kubernetes cluster in ~/.kube/config
-run: generate fmt vet manifests
-	go run cmd/manager/main.go
-
-# 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
 
-# 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
 	kubectl kustomize config/crd | sed -e '/creationTimestamp/d' > manifests/setup/fluentbit-operator-crd.yaml
 	kubectl kustomize manifests/setup | sed -e '/creationTimestamp/d' > manifests/setup/setup.yaml
 
-# 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="./..."
+	./hack/update-codegen.sh
+
+fmt: ## Run go fmt against code.
 	go fmt ./...
 
-# Run go vet against code
-vet:
+vet: ## Run go vet against code.
 	go vet ./...
 
-# Generate code
-generate: controller-gen
-	$(CONTROLLER_GEN) object:headerFile=./hack/boilerplate.go.txt paths="./..."
-	./hack/update-codegen.sh
+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
+
+binary:
+	go build -o bin/manager cmd/manager/main.go
+	go build -o bin/watcher cmd/fluent-bit-watcher/main.go
 
-# Build all amd64/arm64 docker images
-build: test build-op
+verify: verify-crds
+
+verify-crds:
+	sudo chmod a+x ./hack/verify-crds.sh && ./hack/verify-crds.sh
+
+build: generate fmt vet ## Build manager binary.
+	go build -o bin/manager cmd/manager/main.go
+
+run: manifests generate fmt vet ## Run a controller from your host.
+	go run cmd/manager/main.go
 
 # Build amd64/arm64 Fluent Bit container image
 build-fb:
 	docker buildx build --push --platform linux/amd64,linux/arm64 -f cmd/fluent-bit-watcher/Dockerfile . -t ${FB_IMG}
 
 # Build amd64/arm64 Fluent Bit Operator container image
-build-op: 
+build-op:
 	docker buildx build --push --platform linux/amd64,linux/arm64 -f cmd/manager/Dockerfile . -t ${OP_IMG}
 
 # Build all amd64 docker images
@@ -87,26 +93,47 @@ build-fb-amd64:
 	docker build -f cmd/fluent-bit-watcher/Dockerfile . -t ${FB_IMG}${AMD64}
 
 # Build amd64 Fluent Bit Operator container image
-build-op-amd64: 
+build-op-amd64:
 	docker build -f cmd/manager/Dockerfile . -t ${OP_IMG}${AMD64}
 
 # Push the amd64 docker image
 push-amd64:
 	docker push ${OP_IMG}${AMD64}
 
-# 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 install -v 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
+##@ Deployment
+
+install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build config/crd | kubectl apply -f -
+
+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

PROJECT

@@ -1,22 +1,56 @@
 domain: kubesphere.io
+layout:
+- go.kubebuilder.io/v3
+projectName: fluentbit-operator
 repo: kubesphere.io/fluentbit-operator
 resources:
-- group: logging
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: kubesphere.io
+  group: logging
   kind: FluentBitConfig
+  path: kubesphere.io/fluentbit-operator/api/v1alpha2
   version: v1alpha2
-- group: logging
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: kubesphere.io
+  group: logging
   kind: FluentBit
+  path: kubesphere.io/fluentbit-operator/api/v1alpha2
   version: v1alpha2
-- group: logging
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: kubesphere.io
+  group: logging
   kind: Input
+  path: kubesphere.io/fluentbit-operator/api/v1alpha2
   version: v1alpha2
-- group: logging
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: kubesphere.io
+  group: logging
   kind: Filter
+  path: kubesphere.io/fluentbit-operator/api/v1alpha2
   version: v1alpha2
-- group: logging
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: kubesphere.io
+  group: logging
   kind: Output
+  path: kubesphere.io/fluentbit-operator/api/v1alpha2
   version: v1alpha2
-- group: logging
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: kubesphere.io
+  group: logging
   kind: Parser
+  path: kubesphere.io/fluentbit-operator/api/v1alpha2
   version: v1alpha2
-version: "2"
+version: "3"

api/fluentbitoperator/v1alpha2/filter_types.go

@@ -1,4 +1,5 @@
 /*
+Copyright 2021.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

api/fluentbitoperator/v1alpha2/fluentbit_types.go

@@ -1,4 +1,5 @@
 /*
+Copyright 2021.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

api/fluentbitoperator/v1alpha2/fluentbitconfig_types.go

@@ -1,4 +1,5 @@
 /*
+Copyright 2021.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

api/fluentbitoperator/v1alpha2/groupversion_info.go

@@ -1,4 +1,5 @@
 /*
+Copyright 2021.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -14,8 +15,8 @@ limitations under the License.
 */
 
 // Package v1alpha2 contains API Schema definitions for the logging v1alpha2 API group
-// +kubebuilder:object:generate=true
-// +groupName=logging.kubesphere.io
+//+kubebuilder:object:generate=true
+//+groupName=logging.kubesphere.io
 package v1alpha2
 
 import (

api/fluentbitoperator/v1alpha2/input_types.go

@@ -1,4 +1,5 @@
 /*
+Copyright 2021.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

api/fluentbitoperator/v1alpha2/output_types.go

@@ -1,4 +1,5 @@
 /*
+Copyright 2021.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

api/fluentbitoperator/v1alpha2/parser_types.go

@@ -1,4 +1,5 @@
 /*
+Copyright 2021.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.