refactor(operator)!: Migrate project layout to kubebuilder go/v4 (#14447)

Author: periklis

operator/.bingo/Variables.mk

@@ -77,11 +77,11 @@ $(KIND): $(BINGO_DIR)/kind.mod
 	@echo "(re)installing $(GOBIN)/kind-v0.23.0"
 	@cd $(BINGO_DIR) && GOWORK=off $(GO) build -mod=mod -modfile=kind.mod -o=$(GOBIN)/kind-v0.23.0 "sigs.k8s.io/kind"
 
-KUSTOMIZE := $(GOBIN)/kustomize-v4.5.7
+KUSTOMIZE := $(GOBIN)/kustomize-v5.4.3
 $(KUSTOMIZE): $(BINGO_DIR)/kustomize.mod
 	@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies.
-	@echo "(re)installing $(GOBIN)/kustomize-v4.5.7"
-	@cd $(BINGO_DIR) && GOWORK=off $(GO) build -mod=mod -modfile=kustomize.mod -o=$(GOBIN)/kustomize-v4.5.7 "sigs.k8s.io/kustomize/kustomize/v4"
+	@echo "(re)installing $(GOBIN)/kustomize-v5.4.3"
+	@cd $(BINGO_DIR) && GOWORK=off $(GO) build -mod=mod -modfile=kustomize.mod -o=$(GOBIN)/kustomize-v5.4.3 "sigs.k8s.io/kustomize/kustomize/v5"
 
 OPERATOR_SDK := $(GOBIN)/operator-sdk-v1.37.0
 $(OPERATOR_SDK): $(BINGO_DIR)/operator-sdk.mod

operator/.bingo/kustomize.mod

@@ -1,9 +1,5 @@
 module _ // Auto generated by https://github.com/bwplotka/bingo. DO NOT EDIT
 
-go 1.17
+go 1.22.5
 
-exclude sigs.k8s.io/kustomize/api v0.2.0
-
-exclude sigs.k8s.io/kustomize/cmd/config v0.2.0
-
-require sigs.k8s.io/kustomize/kustomize/v4 v4.5.7
+require sigs.k8s.io/kustomize/kustomize/v5 v5.4.3

operator/.bingo/kustomize.sum

@@ -1,5 +1,5 @@
 module _ // Auto generated by https://github.com/bwplotka/bingo. DO NOT EDIT
 
-go 1.22.8
+go 1.22.5
 
 require github.com/operator-framework/operator-sdk v1.37.0 // cmd/operator-sdk

operator/.bingo/operator-sdk.mod

@@ -28,7 +28,7 @@ JSONNETFMT="${GOBIN}/jsonnetfmt-v0.20.0"
 
 KIND="${GOBIN}/kind-v0.23.0"
 
-KUSTOMIZE="${GOBIN}/kustomize-v4.5.7"
+KUSTOMIZE="${GOBIN}/kustomize-v5.4.3"
 
 OPERATOR_SDK="${GOBIN}/operator-sdk-v1.37.0"
 

operator/.bingo/variables.env

@@ -3,20 +3,19 @@ FROM golang:1.22.8 as builder
 
 WORKDIR /workspace
 # Copy the Go Modules manifests
-COPY apis/ apis/
+COPY api/ api/
 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 controllers/ controllers/
+COPY cmd/loki-operator/main.go cmd/loki-operator/main.go
 COPY internal/ internal/
 
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GO111MODULE=on go build -mod=readonly -a -o manager main.go
+RUN CGO_ENABLED=0 GOOS=linux GO111MODULE=on go build -mod=readonly -a -o manager cmd/loki-operator/main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

operator/Dockerfile

@@ -8,20 +8,19 @@ FROM --platform=linux/amd64 $BUILD_IMAGE as builder
 COPY --from=goenv /goarch /goarm /
 WORKDIR /workspace
 # Copy the Go Modules manifests
-COPY apis/ apis/
+COPY api/ api/
 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 controllers/ controllers/
+COPY cmd/loki-operator/main.go cmd/loki-operator/main.go
 COPY internal/ internal/
 
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GO111MODULE=on GOARCH=$(cat /goarch) GOARM=$(cat /goarm) go build -a -o manager main.go
+RUN CGO_ENABLED=0 GOOS=linux GO111MODULE=on GOARCH=$(cat /goarch) GOARM=$(cat /goarm) go build -a -o manager cmd/loki-operator/main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

operator/Dockerfile.cross

@@ -126,10 +126,10 @@ deps: go.mod go.sum
 	go mod verify
 
 .PHONY: deps-api
-deps-api: apis/loki/go.mod apis/loki/go.sum
-	@cd ./apis/loki/ && go mod tidy
-	@cd ./apis/loki/ && go mod download
-	@cd ./apis/loki/ && go mod verify
+deps-api: api/loki/go.mod api/loki/go.sum
+	@cd ./api/loki/ && go mod tidy
+	@cd ./api/loki/ && go mod download
+	@cd ./api/loki/ && go mod verify
 
 .PHONY: cli
 cli: deps bin/loki-broker ## Build loki-broker CLI binary
@@ -138,7 +138,7 @@ bin/loki-broker: $(GO_FILES) | generate
 
 .PHONY: manager
 manager: deps generate ## Build manager binary
-	go build -o bin/manager main.go
+	go build -o bin/manager ./cmd/loki-operator/main.go
 
 .PHONY: size-calculator
 size-calculator: deps generate ## Build size-calculator binary
@@ -163,7 +163,7 @@ test: $(GO_FILES)
 
 .PHONY: test-unit-api
 test-unit-api: $(GO_FILES)
-	@cd ./apis/loki/ && go test ./... -coverprofile cover.out
+	@cd ./api/loki/ && go test ./... -coverprofile cover.out
 
 .PHONY: test-unit-prometheus
 test-unit-prometheus: $(PROMTOOL) ## Run prometheus unit tests
@@ -237,7 +237,7 @@ quickstart-cleanup: $(KIND) ## Cleanup for quickstart set up
 
 .PHONY: run
 run: generate manifests ## Run against the configured Kubernetes cluster in ~/.kube/config
-	go run ./main.go
+	go run ./cmd/loki-operator/main.go
 
 .PHONY: install
 install: manifests $(KUSTOMIZE) ## Install CRDs into a cluster
@@ -312,17 +312,17 @@ oci-push-calculator: ## Push the calculator image
 	$(OCI_RUNTIME) push $(CALCULATOR_IMG)
 
 ##@ Website
-TYPES_TARGET := $(shell find apis/loki -type f -iname "*_types.go")
+TYPES_TARGET := $(shell find api/loki -type f -iname "*_types.go")
 docs/operator/api.md: $(TYPES_TARGET) $(GEN_CRD_API_REFERENCE_DOCS)
 	$(GEN_CRD_API_REFERENCE_DOCS) -api-dir "github.com/grafana/loki/operator/apis/loki/" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates" -out-file "$(PWD)/$@"
 	sed -i 's/+docs:/  docs:/' $@
 	sed -i 's/+parent:/    parent:/' $@
 	sed -i 's/##/\n##/' $@
 	sed -i 's/+newline/\n/' $@
 
-FEATURE_GATES_TARGET := $(shell find apis/config -type f -iname "*_types.go")
+FEATURE_GATES_TARGET := $(shell find api/config -type f -iname "*_types.go")
 docs/operator/feature-gates.md: $(FEATURE_GATES_TARGET) $(GEN_CRD_API_REFERENCE_DOCS)
-	$(GEN_CRD_API_REFERENCE_DOCS) -api-dir "github.com/grafana/loki/operator/apis/config/v1/" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates" -out-file "$(PWD)/$@"
+	$(GEN_CRD_API_REFERENCE_DOCS) -api-dir "github.com/grafana/loki/operator/api/config/v1/" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates" -out-file "$(PWD)/$@"
 	sed -i 's/title: "API"/title: "Feature Gates"/' $@
 	sed -i 's/+docs:/  docs:/' $@
 	sed -i 's/+parent:/    parent:/' $@

operator/Makefile

@@ -1,7 +1,7 @@
 componentConfig: true
 domain: grafana.com
 layout:
-- go.kubebuilder.io/v3
+- go.kubebuilder.io/v4
 multigroup: true
 plugins:
   manifests.sdk.operatorframework.io/v2: {}
@@ -16,7 +16,7 @@ resources:
   domain: grafana.com
   group: loki
   kind: LokiStack
-  path: github.com/grafana/loki/operator/apis/loki/v1beta1
+  path: github.com/grafana/loki/operator/api/loki/v1beta1
   version: v1beta1
 - api:
     crdVersion: v1
@@ -25,7 +25,7 @@ resources:
   domain: grafana.com
   group: loki
   kind: LokiStack
-  path: github.com/grafana/loki/operator/apis/loki/v1
+  path: github.com/grafana/loki/operator/api/loki/v1
   version: v1
   webhooks:
     conversion: true
@@ -38,7 +38,7 @@ resources:
   domain: grafana.com
   group: loki
   kind: AlertingRule
-  path: github.com/grafana/loki/operator/apis/loki/v1
+  path: github.com/grafana/loki/operator/api/loki/v1
   version: v1
   webhooks:
     conversion: true
@@ -51,7 +51,7 @@ resources:
   domain: grafana.com
   group: loki
   kind: AlertingRule
-  path: github.com/grafana/loki/operator/apis/loki/v1beta1
+  path: github.com/grafana/loki/operator/api/loki/v1beta1
   version: v1beta1
   webhooks:
     validation: true
@@ -63,7 +63,7 @@ resources:
   domain: grafana.com
   group: loki
   kind: RecordingRule
-  path: github.com/grafana/loki/operator/apis/loki/v1
+  path: github.com/grafana/loki/operator/api/loki/v1
   version: v1
   webhooks:
     validation: true
@@ -76,7 +76,7 @@ resources:
   domain: grafana.com
   group: loki
   kind: RecordingRule
-  path: github.com/grafana/loki/operator/apis/loki/v1beta1
+  path: github.com/grafana/loki/operator/api/loki/v1beta1
   version: v1beta1
   webhooks:
     validation: true
@@ -88,7 +88,7 @@ resources:
   domain: grafana.com
   group: loki
   kind: RulerConfig
-  path: github.com/grafana/loki/operator/apis/loki/v1
+  path: github.com/grafana/loki/operator/api/loki/v1
   version: v1
 - api:
     crdVersion: v1
@@ -97,6 +97,6 @@ resources:
   domain: grafana.com
   group: loki
   kind: RulerConfig
-  path: github.com/grafana/loki/operator/apis/loki/v1beta1
+  path: github.com/grafana/loki/operator/api/loki/v1beta1
   version: v1beta1
 version: "3"

operator/PROJECT

@@ -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-unknown
 LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
-LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3
+LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v4
 
 # Labels for testing.
 LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1