SUBMARINE-1382. Upgrade go k8s client to 1.25+

.github/workflows/master.yml

@@ -32,8 +32,10 @@ jobs:
  # We mainly support the last 3-4 releases of kubernetes
  steps:
  - id: set-matrix
+ # We used kind as the test k8s environment software support, 
+ # its k8s support version can be referred to: https:/kubernetes-sigs/kind/releases
  run: |
- echo "::set-output name=matrix::[\"v1.22.17\", \"v1.23.17\", \"v1.24.12\", \"v1.25.3\"]"
+ echo "::set-output name=matrix::[\"v1.24.15\", \"v1.25.11\", \"v1.26.6\", \"v1.27.3\"]"
  submarine-operator-verify:
  runs-on: ubuntu-latest
  timeout-minutes: 10
@@ -44,10 +46,10 @@ jobs:
  with:
  fetch-depth: 0
  path: ${{ env.working-directory }}
- - name: Setup Golang 1.17.2
- uses: actions/setup-go@v2
+ - name: Setup Golang 1.19
+ uses: actions/setup-go@v4
  with:
- go-version: "1.17.2"
+ go-version: "1.19"
  - name: Check golang version
  working-directory: ${{ env.working-directory }}/submarine-cloud-v3
  run: go version
@@ -80,10 +82,10 @@ jobs:
  uses: stCarolas/setup-maven@v4
  with:
  maven-version: 3.6.3
- - name: Setup Golang 1.17.2
- uses: actions/setup-go@v2
+ - name: Setup Golang 1.19
+ uses: actions/setup-go@v4
  with:
- go-version: "1.17.2"
+ go-version: "1.19"
  - uses: actions/cache@v2
  with:
  path: ~/.m2/repository
@@ -582,10 +584,10 @@ jobs:
  uses: stCarolas/setup-maven@v4
  with:
  maven-version: 3.6.3
- - name: Setup Golang 1.16.2
- uses: actions/setup-go@v2
+ - name: Setup Golang 1.19
+ uses: actions/setup-go@v4
  with:
- go-version: "1.16.2"
+ go-version: "1.19"
  - uses: actions/setup-node@v3
  with:
  node-version: "14"

submarine-cloud-v3/Makefile

@@ -66,7 +66,7 @@ endif
 # Image URL to use all building/pushing image targets
 IMG ?= $(IMAGE_TAG_BASE):$(VERSION)
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
-ENVTEST_K8S_VERSION = 1.23
+ENVTEST_K8S_VERSION = 1.27.8
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -76,16 +76,10 @@ GOBIN=$(shell go env GOBIN)
 endif
 
 # 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
 
-# We define a FAIL_ON_STDOUT awk command that detects if an error message is output,
-# which we will use several times later.
-# NR is a built-in variable for the number of record.
-FAIL_ON_STDOUT := awk '{ print } END { if (NR > 0) { exit 1 } }'
-
 .PHONY: all
 all: build
 
@@ -109,26 +103,24 @@ help: ## Display this help.
 ##@ Development
 
 .PHONY: manifests
-# controller-gen does not add headerFile to the yaml, so we need to add it manually for now
-# https:/kubernetes-sigs/controller-tools/issues/464
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
- $(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases && sed -i '' '1r ./hack/boilerplate.yaml.txt' config/crd/bases/*.yaml && sed -i '' '1r ./hack/boilerplate.yaml.txt' config/rbac/role.yaml
+ $(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 
 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
  $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
 .PHONY: fmt
 fmt: ## Run go fmt against code.
- go fmt ./... 2>&1 | $(FAIL_ON_STDOUT)
+ go fmt ./...
 
 .PHONY: vet
 vet: ## Run go vet against code.
- go vet ./... 2>&1 | $(FAIL_ON_STDOUT)
+ go vet ./...
 
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
- KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
+ KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
 
 ##@ Build
 
@@ -140,14 +132,34 @@ build: generate fmt vet ## Build manager binary.
 run: manifests generate fmt vet ## Run a controller from your host.
  go run ./main.go
 
+# If you wish built the manager image targeting other platforms you can use the --platform flag.
+# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
+# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
 .PHONY: docker-build
-docker-build: ## Build docker image with the manager.
+docker-build: test ## Build docker image with the manager.
  docker build -t ${IMG} .
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.
  docker push ${IMG}
 
+# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
+# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
+# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
+# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
+# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> than the export will fail)
+# To properly provided solutions that supports more than one platform you should use this option.
+PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
+.PHONY: docker-buildx
+docker-buildx: test ## Build and push docker image for the manager for cross-platform support
+ # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
+ sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
+ - docker buildx create --name project-v3-builder
+ docker buildx use project-v3-builder
+ - docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross
+ - docker buildx rm project-v3-builder
+ rm Dockerfile.cross
+
 ##@ Deployment
 
 ifndef ignore-not-found
@@ -171,34 +183,37 @@ deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in
 undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
  $(KUSTOMIZE) build config/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f -
 
-CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
-.PHONY: controller-gen
-controller-gen: ## Download controller-gen locally if necessary.
- $(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected])
+##@ Build Dependencies
+
+## Location to install dependencies to
+LOCALBIN ?= $(shell pwd)/bin
+$(LOCALBIN):
+ mkdir -p $(LOCALBIN)
 
-KUSTOMIZE = $(shell pwd)/bin/kustomize
+## Tool Binaries
+KUSTOMIZE ?= $(LOCALBIN)/kustomize
+CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
+ENVTEST ?= $(LOCALBIN)/setup-envtest
+
+## Tool Versions
+KUSTOMIZE_VERSION ?= v3.8.7
+CONTROLLER_TOOLS_VERSION ?= v0.10.0
+
+KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
 .PHONY: kustomize
-kustomize: ## Download kustomize locally if necessary.
- $(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected])
+kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
+$(KUSTOMIZE): $(LOCALBIN)
+ test -s $(LOCALBIN)/kustomize || { curl -Ss $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); }
+
+.PHONY: controller-gen
+controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
+$(CONTROLLER_GEN): $(LOCALBIN)
+ test -s $(LOCALBIN)/controller-gen || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
 
-ENVTEST = $(shell pwd)/bin/setup-envtest
 .PHONY: envtest
-envtest: ## Download envtest-setup locally if necessary.
- $(call go-get-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@latest)
-
-# 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
+envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
+$(ENVTEST): $(LOCALBIN)
+ test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
 
 .PHONY: bundle
 bundle: manifests kustomize ## Generate bundle manifests and metadata, then validate generated files.
@@ -224,7 +239,7 @@ 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:/operator-framework/operator-registry/releases/download/v1.19.1/$${OS}-$${ARCH}-opm ;\
+ curl -sSLo $(OPM) https:/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm ;\
  chmod +x $(OPM) ;\
  }
 else

submarine-cloud-v3/README.md

@@ -19,6 +19,12 @@
 
 `submarine-cloud-v3`, i.e. **submarine-operator**, implements the operator for Submarine application. The operator provides a new option for users to deploy the Submarine service to their Kubernetes clusters. The **submarine-operator** can fix some errors automatically. However, if the Submarine service is deployed with Helm, the errors need to be fixed by human operators.
 
+The `submarine-cloud-v3` project to use [operator-sdk](https://sdk.operatorframework.io/) to create, and the operator-sdk version is 1.25.0. 
+The build command is this:
+```shell
+operator-sdk init --domain submarine.apache.org --repo github.com/apache.org/submarine-cloud-v3
+```
+
 # Development
 
 Please check out the [Developer Guide](./docs/developer-guide.md).

submarine-cloud-v3/controllers/suite_test.go

@@ -30,7 +30,6 @@ import (
  "k8s.io/client-go/rest"
  "sigs.k8s.io/controller-runtime/pkg/client"
  "sigs.k8s.io/controller-runtime/pkg/envtest"
- "sigs.k8s.io/controller-runtime/pkg/envtest/printer"
  logf "sigs.k8s.io/controller-runtime/pkg/log"
  "sigs.k8s.io/controller-runtime/pkg/log/zap"
 
@@ -53,9 +52,7 @@ var cancel context.CancelFunc
 func TestAPIs(t *testing.T) {
  RegisterFailHandler(Fail)
 
- RunSpecsWithDefaultAndCustomReporters(t,
- "Controller Suite",
- []Reporter{printer.NewlineReporter{}})
+ RunSpecs(t, "Controller Suite")
 }
 
 var _ = BeforeSuite(func() {

submarine-cloud-v3/docs/developer-guide.md

@@ -17,8 +17,8 @@
 
 # Developer Guide
 
-Golang version: `1.17`
-Kubernetes version: `1.22` - `1.24`
+Golang version: `1.19`
+Kubernetes version: `1.24` - `1.27`
 
 ## Prerequisites
 

submarine-cloud-v3/go.mod

@@ -1,77 +1,75 @@
 module github.com/apache/submarine/submarine-cloud-v3
 
-go 1.17
+go 1.19
 
 require (
- github.com/go-logr/logr v1.2.0
+ github.com/go-logr/logr v1.2.3
  github.com/onsi/ginkgo v1.16.5
- github.com/onsi/gomega v1.17.0
+ github.com/onsi/gomega v1.27.4
  github.com/pkg/errors v0.9.1
- go.uber.org/zap v1.19.1
- istio.io/client-go v1.13.4
- k8s.io/api v0.23.1
- k8s.io/apimachinery v0.23.1
- k8s.io/client-go v0.23.1
- sigs.k8s.io/controller-runtime v0.11.0
+ go.uber.org/zap v1.24.0
+ istio.io/client-go v1.17.6
+ k8s.io/api v0.26.10
+ k8s.io/apimachinery v0.26.10
+ k8s.io/client-go v0.26.10
+ sigs.k8s.io/controller-runtime v0.14.7
 )
 
 require (
- cloud.google.com/go v0.81.0 // indirect
- github.com/Azure/go-autorest v14.2.0+incompatible // indirect
- github.com/Azure/go-autorest/autorest v0.11.18 // indirect
- github.com/Azure/go-autorest/autorest/adal v0.9.13 // indirect
- github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect
- github.com/Azure/go-autorest/logger v0.2.1 // indirect
- github.com/Azure/go-autorest/tracing v0.6.0 // indirect
  github.com/beorn7/perks v1.0.1 // indirect
- github.com/cespare/xxhash/v2 v2.1.1 // indirect
+ github.com/cespare/xxhash/v2 v2.1.2 // indirect
  github.com/davecgh/go-spew v1.1.1 // indirect
- github.com/evanphx/json-patch v4.12.0+incompatible // indirect
- github.com/form3tech-oss/jwt-go v3.2.3+incompatible // indirect
- github.com/fsnotify/fsnotify v1.5.1 // indirect
- github.com/go-logr/zapr v1.2.0 // indirect
+ github.com/emicklei/go-restful/v3 v3.9.0 // indirect
+ github.com/evanphx/json-patch/v5 v5.6.0 // indirect
+ github.com/fsnotify/fsnotify v1.6.0 // indirect
+ github.com/go-logr/zapr v1.2.3 // indirect
+ github.com/go-openapi/jsonpointer v0.19.6 // indirect
+ github.com/go-openapi/jsonreference v0.20.1 // indirect
+ github.com/go-openapi/swag v0.22.3 // indirect
  github.com/gogo/protobuf v1.3.2 // indirect
  github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
- github.com/golang/protobuf v1.5.2 // indirect
- github.com/google/go-cmp v0.5.5 // indirect
+ github.com/golang/protobuf v1.5.3 // indirect
+ github.com/google/gnostic v0.5.7-v3refs // indirect
+ github.com/google/go-cmp v0.5.9 // indirect
  github.com/google/gofuzz v1.1.0 // indirect
- github.com/google/uuid v1.1.2 // indirect
- github.com/googleapis/gnostic v0.5.5 // indirect
+ github.com/google/uuid v1.3.0 // indirect
  github.com/imdario/mergo v0.3.12 // indirect
+ github.com/josharian/intern v1.0.0 // indirect
  github.com/json-iterator/go v1.1.12 // indirect
- github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
+ github.com/mailru/easyjson v0.7.7 // indirect
+ github.com/matttproud/golang_protobuf_extensions v1.0.2 // indirect
  github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
  github.com/modern-go/reflect2 v1.0.2 // indirect
+ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
  github.com/nxadm/tail v1.4.8 // indirect
- github.com/prometheus/client_golang v1.11.0 // indirect
- github.com/prometheus/client_model v0.2.0 // indirect
- github.com/prometheus/common v0.28.0 // indirect
- github.com/prometheus/procfs v0.6.0 // indirect
+ github.com/prometheus/client_golang v1.14.0 // indirect
+ github.com/prometheus/client_model v0.3.0 // indirect
+ github.com/prometheus/common v0.37.0 // indirect
+ github.com/prometheus/procfs v0.8.0 // indirect
  github.com/spf13/pflag v1.0.5 // indirect
  go.uber.org/atomic v1.7.0 // indirect
  go.uber.org/multierr v1.6.0 // indirect
- golang.org/x/crypto v0.1.0 // indirect
- golang.org/x/net v0.1.0 // indirect
- golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f // indirect
- golang.org/x/sys v0.1.0 // indirect
- golang.org/x/term v0.1.0 // indirect
- golang.org/x/text v0.4.0 // indirect
- golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect
+ golang.org/x/net v0.17.0 // indirect
+ golang.org/x/oauth2 v0.7.0 // indirect
+ golang.org/x/sys v0.13.0 // indirect
+ golang.org/x/term v0.13.0 // indirect
+ golang.org/x/text v0.13.0 // indirect
+ golang.org/x/time v0.3.0 // indirect
  gomodules.xyz/jsonpatch/v2 v2.2.0 // indirect
  google.golang.org/appengine v1.6.7 // indirect
- google.golang.org/protobuf v1.27.1 // indirect
+ google.golang.org/genproto v0.0.0-20221018160656-63c7b68cfc55 // indirect
+ google.golang.org/protobuf v1.31.0 // indirect
  gopkg.in/inf.v0 v0.9.1 // indirect
  gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
  gopkg.in/yaml.v2 v2.4.0 // indirect
- gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
- istio.io/api v0.0.0-20220512212136-561ffec82582 // indirect
- istio.io/gogo-genproto v0.0.0-20211208193508-5ab4acc9eb1e // indirect
- k8s.io/apiextensions-apiserver v0.23.0 // indirect
- k8s.io/component-base v0.23.0 // indirect
- k8s.io/klog/v2 v2.30.0 // indirect
- k8s.io/kube-openapi v0.0.0-20211115234752-e816edb12b65 // indirect
- k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b // indirect
- sigs.k8s.io/json v0.0.0-20211020170558-c049b76a60c6 // indirect
- sigs.k8s.io/structured-merge-diff/v4 v4.2.0 // indirect
+ gopkg.in/yaml.v3 v3.0.1 // indirect
+ istio.io/api v0.0.0-20230908073555-ebb470951d3a // indirect
+ k8s.io/apiextensions-apiserver v0.26.10 // indirect
+ k8s.io/component-base v0.26.10 // indirect
+ k8s.io/klog/v2 v2.90.1 // indirect
+ k8s.io/kube-openapi v0.0.0-20230501164219-8b0f38b5fd1f // indirect
+ k8s.io/utils v0.0.0-20230209194617-a36077c30491 // indirect
+ sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
+ sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
  sigs.k8s.io/yaml v1.3.0 // indirect
 )