Migrate to kubebuilder multigroup support (#207)

* move api to multigroup support * move controller to multigroup support * update to golang 1.21 for now we can't move to 1.22 due to a controler-gen panic issue, see: kubernetes-sigs/controller-tools#880
DataDog · Jul 5, 2024 · dbe256f · dbe256f
1 parent 23fea1d
commit dbe256f
Show file tree

Hide file tree

Showing 43 changed files with 113 additions and 127 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -3,12 +3,12 @@
 {
 	"name": "Go",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/go:0-1.19",
+	"image": "mcr.microsoft.com/devcontainers/go:1-1.21",
 	"features": {
 		"ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {},
 		"ghcr.io/devcontainers-contrib/features/kubectx-kubens": {},
 		"ghcr.io/mpriscella/features/kind": {}
-	}
+	},
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	// "features": {},
@@ -24,4 +24,5 @@
 
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 	// "remoteUser": "root"
+	"postStartCommand": ["git", "config", "--global", "--add", "safe.directory", "/workspaces/watermarkpodautoscaler"]
 }
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -1,7 +1,7 @@
 name: build
 
 env:
-  GO_VERSION: 1.19
+  GO_VERSION: 1.21
 
 on:
   push:

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -1,7 +1,7 @@
 name: "CodeQL"
 
 env:
-  GO_VERSION: 1.19
+  GO_VERSION: 1.21
 
 on:
   push:

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -1,7 +1,7 @@
 name: Release
 
 env:
-  GO_VERSION: 1.19
+  GO_VERSION: 1.21
 
 on:
   push:

diff --git a/.github/workflows/validation.yaml b/.github/workflows/validation.yaml
@@ -3,7 +3,7 @@ on: [push, pull_request]
 env:
   GO111MODULE: "on"
   PROJECTNAME: "watermarkpodautoscaler"
-  GO_VERSION: 1.19
+  GO_VERSION: 1.21
 jobs:
   build:
     runs-on: ubuntu-latest

diff --git a/.golangci.toml b/.golangci.toml
@@ -75,6 +75,8 @@
     "varcheck",
     "rowserrcheck",
     "sqlclosecheck",
+    "depguard",
+    "perfsprint",
   ]
 
 [issues]

diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.19 as builder
+FROM golang:1.21 as builder
 
 WORKDIR /workspace
 # Copy the Go Modules manifests
@@ -11,7 +11,7 @@ RUN go mod download
 
 # Copy the go source
 COPY main.go main.go
-COPY api/ api/
+COPY apis/ apis/
 COPY controllers/ controllers/
 COPY pkg/ pkg/
 COPY third_party/ third_party/

diff --git a/Makefile b/Makefile
@@ -55,7 +55,7 @@ e2e: manager manifests verify-license goe2e
 
 # Runs e2e tests (expects a configured cluster)
 goe2e:
-	KUBEBUILDER_ASSETS="$(ROOT)/bin/$(PLATFORM)/" go test --tags=e2e ./controllers/test
+	KUBEBUILDER_ASSETS="$(ROOT)/bin/$(PLATFORM)/" go test --tags=e2e ./controllers/datadoghq/test
 
 # Build manager binary
 .PHONY: manager
@@ -178,7 +178,7 @@ install-tools: bin/$(PLATFORM)/golangci-lint bin/$(PLATFORM)/operator-sdk bin/$(
 
 .PHONY: generate-openapi
 generate-openapi: bin/$(PLATFORM)/openapi-gen
-	bin/$(PLATFORM)/openapi-gen --logtostderr=true -o "" -i ./api/v1alpha1 -O zz_generated.openapi -p ./api/v1alpha1 -h ./hack/boilerplate.go.txt -r "-"
+	bin/$(PLATFORM)/openapi-gen --logtostderr=true -o "" -i ./apis/datadoghq/v1alpha1 -O zz_generated.openapi -p ./apis/datadoghq/v1alpha1 -h ./hack/boilerplate.go.txt -r "-"
 
 .PHONY: patch-crds
 patch-crds: bin/$(PLATFORM)/yq
@@ -206,7 +206,7 @@ bin/$(PLATFORM)/yq: Makefile
 	hack/install-yq.sh "bin/$(PLATFORM)" v4.31.2
 
 bin/$(PLATFORM)/golangci-lint: Makefile
-	hack/install-golangci-lint.sh -b "bin/$(PLATFORM)" v1.51.0
+	hack/install-golangci-lint.sh -b "bin/$(PLATFORM)" v1.56.0
 
 bin/$(PLATFORM)/operator-sdk: Makefile
 	hack/install-operator-sdk.sh v1.23.0

diff --git a/PROJECT b/PROJECT
@@ -1,17 +1,29 @@
 domain: datadoghq.com
-layout: go.kubebuilder.io/v2
+layout:
+- go.kubebuilder.io/v3
+multigroup: true
+plugins:
+  manifests.sdk.operatorframework.io/v2: {}
+  scorecard.sdk.operatorframework.io/v2: {}
 projectName: watermarkpodautoscaler
 repo: github.com/DataDog/watermarkpodautoscaler
 resources:
--
-  # TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
-  # controller: true
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
   domain: datadoghq.com
   group: datadoghq
   kind: WatermarkPodAutoscaler
-  # TODO(user): Update the package path for your API if the below value is incorrect.
-  path: github.com/DataDog/watermarkpodautoscaler/api/v1alpha1
+  path: github.com/DataDog/watermarkpodautoscaler/apis/datadoghq/v1alpha1
+  version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: datadoghq.com
+  group: datadoghq
+  kind: RecommendWatermarkPodAutoscaler
+  path: github.com/DataDog/watermarkpodautoscaler/apis/datadoghq/v1alpha1
   version: v1alpha1
 version: "3"
-plugins:
-  go.sdk.operatorframework.io/v2-alpha: {}
diff --git a/api/v1alpha1/const.go → apis/datadoghq/v1alpha1/const.go b/api/v1alpha1/const.go → apis/datadoghq/v1alpha1/const.go
diff --git a/api/v1alpha1/doc.go → apis/datadoghq/v1alpha1/doc.go b/api/v1alpha1/doc.go → apis/datadoghq/v1alpha1/doc.go
diff --git a/api/v1alpha1/groupversion_info.go → apis/datadoghq/v1alpha1/groupversion_info.go b/api/v1alpha1/groupversion_info.go → apis/datadoghq/v1alpha1/groupversion_info.go
diff --git a/api/v1alpha1/new.go → apis/datadoghq/v1alpha1/new.go b/api/v1alpha1/new.go → apis/datadoghq/v1alpha1/new.go
diff --git a/api/v1alpha1/register.go → apis/datadoghq/v1alpha1/register.go b/api/v1alpha1/register.go → apis/datadoghq/v1alpha1/register.go
diff --git a/api/v1alpha1/test/new.go → apis/datadoghq/v1alpha1/test/new.go b/api/v1alpha1/test/new.go → apis/datadoghq/v1alpha1/test/new.go
@@ -9,7 +9,7 @@ package test
 import (
 	"time"
 
-	"github.com/DataDog/watermarkpodautoscaler/api/v1alpha1"
+	"github.com/DataDog/watermarkpodautoscaler/apis/datadoghq/v1alpha1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 

diff --git a/...1alpha1/watermarkpodautoscaler_default.go → ...1alpha1/watermarkpodautoscaler_default.go b/...1alpha1/watermarkpodautoscaler_default.go → ...1alpha1/watermarkpodautoscaler_default.go
diff --git a/api/v1alpha1/watermarkpodautoscaler_types.go → .../v1alpha1/watermarkpodautoscaler_types.go b/api/v1alpha1/watermarkpodautoscaler_types.go → .../v1alpha1/watermarkpodautoscaler_types.go
diff --git a/api/v1alpha1/zz_generated.deepcopy.go → ...tadoghq/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go → ...tadoghq/v1alpha1/zz_generated.deepcopy.go
diff --git a/api/v1alpha1/zz_generated.openapi.go → ...atadoghq/v1alpha1/zz_generated.openapi.go b/api/v1alpha1/zz_generated.openapi.go → ...atadoghq/v1alpha1/zz_generated.openapi.go
diff --git a/bundle.Dockerfile b/bundle.Dockerfile
@@ -9,7 +9,7 @@ LABEL operators.operatorframework.io.bundle.channels.v1=alpha
 LABEL operators.operatorframework.io.bundle.channel.default.v1=alpha
 LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.23.0
 LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
-LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v2
+LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3
 
 # Labels for testing.
 LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1

diff --git a/bundle/manifests/watermarkpodautoscaler.clusterserviceversion.yaml b/bundle/manifests/watermarkpodautoscaler.clusterserviceversion.yaml
@@ -42,7 +42,7 @@ metadata:
       ]
     capabilities: Basic Install
     operators.operatorframework.io/builder: operator-sdk-v1.23.0
-    operators.operatorframework.io/project_layout: go.kubebuilder.io/v2
+    operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
   name: watermarkpodautoscaler.v0.5.2
   namespace: placeholder
 spec:

diff --git a/bundle/metadata/annotations.yaml b/bundle/metadata/annotations.yaml
@@ -8,7 +8,7 @@ annotations:
   operators.operatorframework.io.bundle.channel.default.v1: alpha
   operators.operatorframework.io.metrics.builder: operator-sdk-v1.23.0
   operators.operatorframework.io.metrics.mediatype.v1: metrics+v1
-  operators.operatorframework.io.metrics.project_layout: go.kubebuilder.io/v2
+  operators.operatorframework.io.metrics.project_layout: go.kubebuilder.io/v3
 
   # Annotations for testing.
   operators.operatorframework.io.test.mediatype.v1: scorecard+v1

diff --git a/cmd/kubectl-wpa/app/common/client.go b/cmd/kubectl-wpa/app/common/client.go
@@ -13,7 +13,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
 
-	"github.com/DataDog/watermarkpodautoscaler/api/v1alpha1"
+	"github.com/DataDog/watermarkpodautoscaler/apis/datadoghq/v1alpha1"
 )
 
 // NewClient returns new client instance.

diff --git a/cmd/kubectl-wpa/app/dryrun/dryrun.go b/cmd/kubectl-wpa/app/dryrun/dryrun.go
@@ -19,7 +19,7 @@ import (
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/DataDog/watermarkpodautoscaler/api/v1alpha1"
+	"github.com/DataDog/watermarkpodautoscaler/apis/datadoghq/v1alpha1"
 	"github.com/DataDog/watermarkpodautoscaler/cmd/kubectl-wpa/app/common"
 )
 

diff --git a/config/manifests/bases/watermarkpodautoscaler.clusterserviceversion.yaml b/config/manifests/bases/watermarkpodautoscaler.clusterserviceversion.yaml
@@ -40,7 +40,7 @@ metadata:
       ]
     capabilities: Basic Install
     operators.operatorframework.io/builder: operator-sdk-v1.23.0
-    operators.operatorframework.io/project_layout: go.kubebuilder.io/v2
+    operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
   name: watermarkpodautoscaler.v0.6.0-rc.1
   namespace: placeholder
 spec:

diff --git a/controllers/datadoghq/doc.go b/controllers/datadoghq/doc.go
@@ -0,0 +1,2 @@
+// Package datadoghq containers all the WatermarkPodAutoscaler controller logic.
+package datadoghq
diff --git a/controllers/finalizer.go → controllers/datadoghq/finalizer.go b/controllers/finalizer.go → controllers/datadoghq/finalizer.go
@@ -3,12 +3,12 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-package controllers
+package datadoghq
 
 import (
 	"context"
 
-	datadoghqv1alpha1 "github.com/DataDog/watermarkpodautoscaler/api/v1alpha1"
+	datadoghqv1alpha1 "github.com/DataDog/watermarkpodautoscaler/apis/datadoghq/v1alpha1"
 	"github.com/DataDog/watermarkpodautoscaler/pkg/util"
 	logr "github.com/go-logr/logr"
 )

diff --git a/controllers/metrics.go → controllers/datadoghq/metrics.go b/controllers/metrics.go → controllers/datadoghq/metrics.go
@@ -3,13 +3,13 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-package controllers
+package datadoghq
 
 import (
 	"os"
 	"strings"
 
-	datadoghqv1alpha1 "github.com/DataDog/watermarkpodautoscaler/api/v1alpha1"
+	datadoghqv1alpha1 "github.com/DataDog/watermarkpodautoscaler/apis/datadoghq/v1alpha1"
 
 	"github.com/prometheus/client_golang/prometheus"