Update operator-sdk to 1.x from the old <0.19 structure (new kubebuil…

…der struct) (k8ssandra#120)

Update operator-sdk to 1.x from the old <0.19 structure (new kubebuilder struct). 

With the history of changes as it proceeded:

* Update to operator sdk 0.18.2, newer mage and rebuilding the client interface

Fix ResourceVersion conflict in CheckRackPodTemplate, remove dependency to deprecated k8sutil from operator-sdk and copy the relevant parts here

Upgrade generateSdk to use 0.18.2, changes CRD to apiextensions v1 instead of v1beta1

Fix CRD patching with new apiextensions version

The tests do not understand go mod tidy, so adding untied go.sum for tests

* Initial work for operator 1.x

* Build changes

* Fix RBAC generation, disable webhooks

* Fix watchNamespace deployment

* Fix some group names, add kustomize template for spec.config property

* Split the patch to a separate file

* Fix event filtering for CassandraDatacenter

* Remove Helm charts

* Change Makefile to use /bin/bash instead of /bin/sh for ubuntu-latest

* integ-test target runs kustomize install first

* Refactor dynamicSecretWatches to work again, migrate oldReconciler to controllers, remove more mage stuff (operator, k3d, k8s, kind, docker, integ-tests), update config-builder to 1.0.4

* Refactor validating webhook handling, remove old cert checks and replace with cert-manager in integration tests

* Fix RBAC rights for PersistentVolume and Nodes, add larger timeouts for scale down events

* Modify settings to use Role instead of ClusterRole by default, create kustomize template for cluster_wide_install scenario

* Add workaround for cluster_wide_install kustomize issue with deployment order and hopefully fix the scale down tests

* Move operator/pkg and internal to pkg/

* Update to kustomize 4.1.3 instead of 3.x

* Migrate crd.patch to kustomize

* Replace some Watches with Owns

* Set all as default integ-test target

.github/workflows/kindIntegTest.yml

@@ -25,7 +25,8 @@ jobs:
         id: docker_build
         uses: docker/build-push-action@v2
         with:
-          file: operator/docker/base/Dockerfile
+          file: Dockerfile
+          context: .
           push: false
           tags: k8ssandra/cass-operator:latest
           platforms: linux/amd64
@@ -106,6 +107,7 @@ jobs:
     env:
       GOPATH: /home/runner/go
       GOROOT: /usr/local/go1.16
+      CGO_ENABLED: 0
       M_LOAD_TEST_IMAGES: false
       M_INTEG_DIR: ${{ matrix.integration_test }}
       M_K8S_FLAVOR: kind
@@ -130,15 +132,11 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
-      - name: Install Helm
-        uses: azure/setup-helm@v1
-        with:
-          version: v3.5.3
       - name: Create Kind Cluster
         uses: helm/[email protected]
         with:
-          version: v0.10.0
-          node_image: kindest/node:v1.20.2
+          version: v0.11.1
+          node_image: kindest/node:v1.20.7
           cluster_name: kind
           config: tests/testdata/kind/kind_config_6_workers.yaml
       - name: Set up Docker Buildx
@@ -162,10 +160,12 @@ jobs:
           kind load docker-image --name=kind k8ssandra/cass-operator:latest
           kind load docker-image --name=kind k8ssandra/system-logger:latest
       - name: Run integration test ( ${{ matrix.integration_test }} )
-        uses: magefile/mage-action@v1
-        with:
-          version: latest
-          args: integ:run
+        run: |
+          make integ-test
+        # uses: magefile/mage-action@v1
+        # with:
+        #   version: latest
+        #   args: integ:run
       - name: Archive k8s logs
         if: ${{ failure() }}
         uses: actions/upload-artifact@v2

.github/workflows/operatorBuildAndDeploy.yml

@@ -12,6 +12,7 @@ jobs:
     env:
       GOPATH: /home/runner/go
       GOROOT: /usr/local/go1.16
+      CGO_ENABLED: 0
     steps:
       - uses: actions/checkout@v2
         if: github.event_name == 'pull_request'
@@ -38,21 +39,24 @@ jobs:
           key: ${{ runner.os }}-buildx-${{ github.sha }}
           restore-keys: |
             ${{ runner.os }}-buildx-
-      - name: Test Sdk Generate
-        uses: magefile/mage-action@v1
-        with:
-          version: latest
-          args: operator:testSdkGenerate
-      - name: Test Client Generate
-        uses: magefile/mage-action@v1
-        with:
-          version: latest
-          args: operator:testGenerateClient
+      # - name: Test Sdk Generate
+      #   uses: magefile/mage-action@v1
+      #   with:
+      #     version: latest
+      #     args: operator:testSdkGenerate
+      # - name: Test Client Generate
+      #   uses: magefile/mage-action@v1
+      #   with:
+      #     version: latest
+      #     args: operator:testGenerateClient
       - name: Unit Tests
-        uses: magefile/mage-action@v1
-        with:
-          version: latest
-          args: operator:testGo
+        run: |
+          export PATH=$GOROOT/bin:$GOPATH/bin:$PATH
+          make controller-gen test
+        # uses: magefile/mage-action@v1
+        # with:
+        #   version: latest
+        #   args: operator:testGo
   build_operator_docker:
     name: Build Cass Operator Docker Image
     runs-on: ubuntu-latest
@@ -84,7 +88,8 @@ jobs:
         id: docker_build
         uses: docker/build-push-action@v2
         with:
-          file: operator/docker/base/Dockerfile
+          file: Dockerfile
+          context: .
           push: ${{ github.event_name != 'pull_request' }}
           tags: k8ssandra/cass-operator:${{ steps.vars.outputs.sha_short }}, k8ssandra/cass-operator:latest
           platforms: linux/amd64

.gitignore

@@ -248,3 +248,8 @@ tags
 
 # Packet captures
 *.pcap
+
+# make temps
+bin/
+testbin/
+manager

Dockerfile

@@ -0,0 +1,29 @@
+# Build the manager binary
+FROM golang:1.15 as builder
+
+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 the go source
+COPY main.go main.go
+COPY api/ api/
+COPY controllers/ controllers/
+COPY pkg/ pkg/
+
+
+# Build
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o manager main.go
+
+# Use distroless as minimal base image to package the manager binary
+# Refer to https://github.com/GoogleContainerTools/distroless for more details
+FROM gcr.io/distroless/static:nonroot
+WORKDIR /
+COPY --from=builder /workspace/manager .
+USER 65532:65532
+
+ENTRYPOINT ["/manager"]

Makefile

@@ -0,0 +1,229 @@
+# Makefile uses sh by default, but Github Actions (ubuntu-latest) requires dash/bash to work.
+SHELL := /bin/bash
+
+# VERSION defines the project version for the bundle.
+# Update this value when you upgrade the version of your project.
+# To re-generate a bundle for another specific version without changing the standard setup, you can:
+# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
+# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
+VERSION ?= 1.8.0
+
+# CHANNELS define the bundle channels used in the bundle.
+# Add a new line here if you would like to change its default config. (E.g CHANNELS = "preview,fast,stable")
+# To re-generate a bundle for other specific channels without changing the standard setup, you can:
+# - use the CHANNELS as arg of the bundle target (e.g make bundle CHANNELS=preview,fast,stable)
+# - use environment variables to overwrite this value (e.g export CHANNELS="preview,fast,stable")
+ifneq ($(origin CHANNELS), undefined)
+BUNDLE_CHANNELS := --channels=$(CHANNELS)
+endif
+
+# DEFAULT_CHANNEL defines the default channel used in the bundle.
+# Add a new line here if you would like to change its default config. (E.g DEFAULT_CHANNEL = "stable")
+# To re-generate a bundle for any other default channel without changing the default setup, you can:
+# - use the DEFAULT_CHANNEL as arg of the bundle target (e.g make bundle DEFAULT_CHANNEL=stable)
+# - use environment variables to overwrite this value (e.g export DEFAULT_CHANNEL="stable")
+ifneq ($(origin DEFAULT_CHANNEL), undefined)
+BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
+endif
+BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
+
+# IMAGE_TAG_BASE defines the docker.io namespace and part of the image name for remote images.
+# This variable is used to construct full image tags for bundle and catalog images.
+#
+# For example, running 'make bundle-build bundle-push catalog-build catalog-push' will build and push both
+# cassandra.datastax.com/cass-oper-bundle:$VERSION and cassandra.datastax.com/cass-oper-catalog:$VERSION.
+IMAGE_TAG_BASE ?= k8ssandra/cass-operator
+
+M_INTEG_DIR ?= all
+
+# BUNDLE_IMG defines the image:tag used for the bundle.
+# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
+BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
+
+# Image URL to use all building/pushing image targets
+IMG ?= $(IMAGE_TAG_BASE):latest
+# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
+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))
+GOBIN=$(shell go env GOPATH)/bin
+else
+GOBIN=$(shell go env GOBIN)
+endif
+
+all: build
+
+##@ General
+
+# 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
+
+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)
+
+##@ Development
+
+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
+
+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 ./...
+
+vet: ## Run go vet against code.
+	go vet ./...
+
+ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
+test: manifests generate fmt vet ## Run unit tests (including envtest based ones)
+	# Old unit tests first - these use mocked client / fakeclient
+	go test ./pkg/... -coverprofile cover-operator.out
+	# These are not used yet
+	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.7.2/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 ./controllers/... -coverprofile cover.out
+
+integ-test: kustomize cert-manager ## Run integration tests from directory M_INTEG_DIR or set M_INTEG_DIR=all to run all the integration tests.
+ifeq ($(M_INTEG_DIR), all)
+	# Run all the tests (exclude kustomize & testdata directories)
+	cd tests && go test -v -timeout 300m --ginkgo.progress --ginkgo.v ./...
+else
+	cd tests/${M_INTEG_DIR} && go test -v -timeout 300m --ginkgo.progress --ginkgo.v ./...
+endif
+
+##@ 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: ## Build docker image with the manager.
+	docker buildx build -t ${IMG} . --load
+
+docker-kind: docker-build ## Build docker image and load to kind cluster
+	kind load docker-image ${IMG}
+
+docker-push: ## Build and push docker image with the manager.
+	docker buildx build -t ${IMG} . --push
+
+##@ 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 -
+
+deploy-test:
+ifneq ($(strip $(NAMESPACE)),)
+	cd tests/kustomize && $(KUSTOMIZE) edit set namespace $(NAMESPACE)
+endif
+	$(KUSTOMIZE) build tests/$(TEST_DIR) | kubectl apply -f -
+
+undeploy-test:
+ifneq ($(strip $(NAMESPACE)),)
+	cd tests/kustomize && $(KUSTOMIZE) edit set namespace $(NAMESPACE)
+endif
+	$(KUSTOMIZE) build tests/$(TEST_DIR) | kubectl delete -f -
+
+##@ Tools
+
+cert-manager: ## Install cert-manager to the cluster
+	kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.3.1/cert-manager.yaml
+
+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
+
+.PHONY: bundle
+bundle: manifests kustomize ## Generate bundle manifests and metadata, then validate generated files.
+	operator-sdk generate kustomize manifests -q
+	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
+	$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
+	operator-sdk bundle validate ./bundle
+
+.PHONY: bundle-build
+bundle-build: ## Build the bundle image.
+	docker buildx build -f bundle.Dockerfile -t $(BUNDLE_IMG) . --load
+
+.PHONY: bundle-push
+bundle-push: ## Push the bundle image.
+	$(MAKE) docker-push IMG=$(BUNDLE_IMG)
+
+.PHONY: opm
+OPM = ./bin/opm
+opm: ## Download opm locally if necessary.
+ifeq (,$(wildcard $(OPM)))
+ifeq (,$(shell which opm 2>/dev/null))
+	@{ \
+	set -e ;\
+	mkdir -p $(dir $(OPM)) ;\
+	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
+	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.15.1/$${OS}-$${ARCH}-opm ;\
+	chmod +x $(OPM) ;\
+	}
+else
+OPM = $(shell which opm)
+endif
+endif
+
+# A comma-separated list of bundle images (e.g. make catalog-build BUNDLE_IMGS=example.com/operator-bundle:v0.1.0,example.com/operator-bundle:v0.2.0).
+# These images MUST exist in a registry and be pull-able.
+BUNDLE_IMGS ?= $(BUNDLE_IMG)
+
+# The image tag given to the resulting catalog image (e.g. make catalog-build CATALOG_IMG=example.com/operator-catalog:v0.2.0).
+CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:v$(VERSION)
+
+# Set CATALOG_BASE_IMG to an existing catalog image tag to add $BUNDLE_IMGS to that image.
+ifneq ($(origin CATALOG_BASE_IMG), undefined)
+FROM_INDEX_OPT := --from-index $(CATALOG_BASE_IMG)
+endif
+
+# Build a catalog image by adding bundle images to an empty catalog using the operator package manager tool, 'opm'.
+# This recipe invokes 'opm' in 'semver' bundle add mode. For more information on add modes, see:
+# https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
+.PHONY: catalog-build
+catalog-build: opm ## Build a catalog image.
+	$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
+
+# Push the catalog image.
+.PHONY: catalog-push
+catalog-push: ## Push a catalog image.
+	$(MAKE) docker-push IMG=$(CATALOG_IMG)