build: setups for API generations

Signed-off-by: Takeshi Yoneda <[email protected]>

Author: mathetake

Makefile

@@ -1,11 +1,13 @@
 # The Go-based tools are defined in Makefile.tools.mk.
 include Makefile.tools.mk
 
+# This runs the linter, formatter, and tidy on the codebase.
 .PHONY: lint
 lint: golangci-lint
 	@echo "lint => ./..."
-	@$(GOLANGCI_LINT) run --build-tags=$(LINT_BUILD_TAGS) ./...
+	@$(GOLANGCI_LINT) run ./...
 
+# This runs the formatter on the codebase as well as goimports via gci.
 .PHONY: format
 format: gci gofumpt
 	@echo "format => *.go"
@@ -14,16 +16,25 @@ format: gci gofumpt
 	@echo "gci => *.go"
 	@$(GCI) write -s standard -s default -s "prefix(github.com/envoyproxy/ai-gateway)" `find . -name '*.go'`
 
+# This runs go mod tidy on every module.
 .PHONY: tidy
-tidy: ## Runs go mod tidy on every module
+tidy:
 	@find . -name "go.mod" \
 	| grep go.mod \
 	| xargs -I {} bash -c 'dirname {}' \
 	| xargs -I {} bash -c 'echo "tidy => {}"; cd {}; go mod tidy -v; '
 
+# This re-generates the CRDs for the API defined in the api/v1alpha1 directory.
+.PHONY: apigen
+apigen: controller-gen
+	@echo "apigen => ./api/v1alpha1/..."
+	@$(CONTROLLER_GEN) object crd paths="./api/v1alpha1/..." output:dir=./api/v1alpha1 output:crd:dir=./manifests/charts/ai-gateway-helm/crds
+
+# This runs all necessary steps to prepare for a commit.
 .PHONY: precommit
-precommit: format tidy lint
+precommit: apigen format tidy lint
 
+# This runs precommit and checks for any differences in the codebase, failing if there are any.
 .PHONY: check
 check:
 	@$(MAKE) precommit
@@ -32,6 +43,7 @@ check:
 		git diff --exit-code; \
 	fi
 
+# This runs the unit tests for the codebase.
 .PHONY: test
 test:
 	@echo "test => ./..."

Makefile.tools.mk

@@ -3,11 +3,13 @@ $(LOCALBIN):
 	mkdir -p $(LOCALBIN)
 
 ## Tool binary names.
+CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
 GO_FUMPT = $(LOCALBIN)/gofumpt
 GCI = $(LOCALBIN)/gci
 
 ## Tool versions.
+CONTROLLER_TOOLS_VERSION ?= v0.16.2
 GOLANGCI_LINT_VERSION ?= v1.60.1
 GO_FUMPT_VERSION ?= v0.6.0
 GCI_VERSION ?= v0.13.5
@@ -27,6 +29,11 @@ gci: $(GCI)
 $(GCI): $(LOCALBIN)
 	$(call go-install-tool,$(GCI),github.com/daixiang0/gci,$(GCI_VERSION))
 
+.PHONY: controller-gen
+controller-gen: $(CONTROLLER_GEN)
+$(CONTROLLER_GEN): $(LOCALBIN)
+	$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen,$(CONTROLLER_TOOLS_VERSION))
+
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary
 # $2 - package url which can be installed

api/v1alpha1/api.go

@@ -0,0 +1,3 @@
+package v1alpha1
+
+// +kubebuilder:object:root=true

api/v1alpha1/doc.go

@@ -0,0 +1,6 @@
+// Package v1alpha1 contains API schema definitions for the aigateway.envoyproxy.io
+// API group.
+//
+// +kubebuilder:object:generate=true
+// +groupName=aigateway.envoyproxy.io
+package v1alpha1

api/v1alpha1/registry.go

@@ -0,0 +1,19 @@
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+const GroupName = "aigateway.envoyproxy.io"
+
+var (
+	// schemeGroupVersion is group version used to register these objects
+	schemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: schemeGroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

go.mod

@@ -1,3 +1,29 @@
 module github.com/envoyproxy/ai-gateway
 
 go 1.23.2
+
+require (
+	k8s.io/apimachinery v0.31.0
+	sigs.k8s.io/controller-runtime v0.19.2
+)
+
+require (
+	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
+	github.com/go-logr/logr v1.4.2 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/x448/float16 v0.8.4 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	k8s.io/klog/v2 v2.130.1 // indirect
+	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
+	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
+)