Implement ImagePrefetch controller

Signed-off-by: zeroalphat <taichi-takemura@cybozu.co.jp>

Author: zeroalphat

Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM ghcr.io/cybozu/golang:1.23-noble AS builder
+FROM ghcr.io/cybozu/golang:1.24-noble AS builder
 ARG TARGETOS
 ARG TARGETARCH
 
@@ -11,7 +11,7 @@ RUN go mod download
 # Copy the go source
 COPY cmd/main.go cmd/main.go
 COPY api/ api/
-COPY internal/controller/ internal/controller/
+COPY internal/ internal/
 
 # Build
 RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go

Makefile

@@ -1,4 +1,4 @@
-IMG ?= controller:latest
+IMG ?= image-prefetch:dev
 ENVTEST_K8S_VERSION = 1.31.0
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
@@ -28,6 +28,22 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
+# refer to https://github.com/statnett/image-scanner-operator/pull/668/files
+GO_MODULE = $(shell go list -m)
+API_DIRS = $(shell find api -mindepth 1 -type d | sed "s|^|$(shell go list -m)/|" | paste -sd " " )
+.PHONY: k8s-client-gen
+k8s-client-gen: applyconfiguration-gen models-schema
+	@echo "generating"
+	$(MODELS_SCHEMA) > /tmp/schema.json
+	rm -rf internal/client/applyconfigurations
+	$(APPLYCONFIGURATION_GEN) \
+        --go-header-file hack/boilerplate.go.txt \
+		--output-dir internal/applyconfigurations \
+		--output-pkg $(GO_MODULE)/internal/applyconfigurations \
+		--openapi-schema /tmp/schema.json \
+		$(API_DIRS)
+	rm -f /tmp/schema.json
+
 .PHONY: fmt
 fmt: ## Run go fmt against code.
 	go fmt ./...
@@ -37,8 +53,8 @@ vet: ## Run go vet against code.
 	go vet ./...
 
 .PHONY: test
-test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out
+test: manifests generate fmt vet envtest ginkgo ## Run tests.
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" $(GINKGO) run --skip-file e2e.* -r --coverprofile cover.out
 
 # Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
 .PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
@@ -111,12 +127,18 @@ KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
 GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
+GINKGO = $(LOCALBIN)/ginkgo
+APPLYCONFIGURATION_GEN = $(LOCALBIN)/applyconfiguration-gen
+MODELS_SCHEMA = $(LOCALBIN)/models-schema
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v5.6.0
 CONTROLLER_TOOLS_VERSION ?= v0.17.2
 ENVTEST_VERSION ?= release-0.20
 GOLANGCI_LINT_VERSION ?= v1.64.5
+GINKGO_VERSION ?= v2.1.4
+CODE_GENERATOR_VERSION ?= v0.31.1
+MODELS_SCHEMA_VERSION ?= v1.31.1
 
 .PHONY: kustomize
 kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
@@ -138,6 +160,26 @@ golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
 $(GOLANGCI_LINT): $(LOCALBIN)
 	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
 
+.PHONY: ginkgo
+ginkgo: $(GINKGO) ## Download ginkgo locally if necessary.
+$(GINKGO): $(LOCALBIN)
+	$(call go-install-tool,$(GINKGO),github.com/onsi/ginkgo/v2/ginkgo,$(GINKGO_VERSION))
+
+.PHONY: models-schema ## Download models-schema locally if necessary.
+models-schema: $(LOCALBIN)
+	test -s $(LOCALBIN)/models-schema || \
+	( \
+		mkdir -p /tmp/work-models-schema/pkg/generated/openapi/cmd/models-schema && \
+		curl -sSfL https://github.com/kubernetes/kubernetes/archive/$(MODELS_SCHEMA_VERSION).tar.gz | tar -C /tmp/work-models-schema -xzf - --strip-components=1 &&\
+		cd /tmp/work-models-schema/pkg/generated/openapi/cmd/models-schema &&\
+		GOBIN=$(LOCALBIN) go install \
+	)
+
+.PHONY: applyconfiguration-gen ## Download applyconfiguration-gen locally if necessary.
+applyconfiguration-gen: $(APPLYCONFIGURATION_GEN) ## Download applyconfiguration-gen locally if necessary.
+$(APPLYCONFIGURATION_GEN): $(LOCALBIN)
+	$(call go-install-tool,$(APPLYCONFIGURATION_GEN),k8s.io/code-generator/cmd/applyconfiguration-gen,$(CODE_GENERATOR_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/v1/doc.go

@@ -0,0 +1,2 @@
+// +groupName=ofen.cybozu.io
+package v1

api/v1/groupversion_info.go

@@ -10,10 +10,10 @@ import (
 
 var (
 	// GroupVersion is group version used to register these objects
-	GroupVersion = schema.GroupVersion{Group: "ofen.cybozu.io", Version: "v1"}
+	SchemeGroupVersion = schema.GroupVersion{Group: "ofen.cybozu.io", Version: "v1"}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
-	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
 
 	// AddToScheme adds the types in this group-version to the given scheme.
 	AddToScheme = SchemeBuilder.AddToScheme

api/v1/imageprefetch_types.go

@@ -54,6 +54,10 @@ type ImagePrefetchStatus struct {
 	// +optional
 	// +kubebuilder:default:=0
 	ImagePullFailedNodes int `json:"imagePullFailedNodes,omitempty"`
+
+	// SelectedNodes represents the nodes that have been selected to download the images
+	// +optional
+	SelectedNodes []string `json:"selectedNodes,omitempty"`
 }
 
 const (

api/v1/nodeimageset_types.go

@@ -80,6 +80,8 @@ const (
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:scope=Cluster
+// +genclient
+// +genclient:nonNamespaced
 
 // NodeImageSet is the Schema for the nodeimagesets API
 type NodeImageSet struct {

api/v1/zz_generated.deepcopy.go

@@ -40,6 +40,7 @@ func main() {
 	var probeAddr string
 	var secureMetrics bool
 	var enableHTTP2 bool
+	var imagePullNodeLimit int
 	var tlsOpts []func(*tls.Config)
 	flag.StringVar(&metricsAddr, "metrics-bind-address", "0", "The address the metrics endpoint binds to. "+
 		"Use :8443 for HTTPS or :8080 for HTTP, or leave as 0 to disable the metrics service.")
@@ -51,6 +52,8 @@ func main() {
 		"If set, the metrics endpoint is served securely via HTTPS. Use --metrics-secure=false to use HTTP instead.")
 	flag.BoolVar(&enableHTTP2, "enable-http2", false,
 		"If set, HTTP/2 will be enabled for the metrics and webhook servers")
+	flag.IntVar(&imagePullNodeLimit, "image-pull-node-limit", 1,
+		"The maximum number of nodes that can pull images concurrently.")
 	opts := zap.Options{
 		Development: true,
 	}
@@ -127,8 +130,9 @@ func main() {
 	}
 
 	if err = (&controller.ImagePrefetchReconciler{
-		Client: mgr.GetClient(),
-		Scheme: mgr.GetScheme(),
+		Client:             mgr.GetClient(),
+		Scheme:             mgr.GetScheme(),
+		ImagePullNodeLimit: imagePullNodeLimit,
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "ImagePrefetch")
 		os.Exit(1)

cmd/main.go

@@ -166,6 +166,12 @@ spec:
                 description: The generation observed by the controller.
                 format: int64
                 type: integer
+              selectedNodes:
+                description: SelectedNodes represents the nodes that have been selected
+                  to download the images
+                items:
+                  type: string
+                type: array
             type: object
         type: object
     served: true

config/crd/bases/ofen.cybozu.io_imageprefetches.yaml

@@ -1,2 +1,8 @@
 resources:
 - manager.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+images:
+- name: controller
+  newName: image-prefetch
+  newTag: dev