Merge pull request #39 from kubernetes-sigs/setup-auto-build-publish-images

setup auto-build/publish setup with cloudbuild

Author: k8s-ci-robot

Makefile

@@ -59,7 +59,9 @@ CONTROLLER_GEN := $(abspath $(TOOLS_BIN_DIR)/$(CONTROLLER_GEN_BIN)-$(CONTROLLER_
 CONTROLLER_GEN_PKG := sigs.k8s.io/controller-tools/cmd/controller-gen
 
 # Image URL to use all building/pushing image targets
-IMG ?= controller:latest
+IMG_PREFIX ?= controller
+IMG_TAG ?= latest
+
 
 # Default value for ignore-not-found flag in undeploy target
 ignore-not-found ?= true
@@ -170,17 +172,17 @@ run: manifests generate fmt vet ## Run a controller from your host.
 # More info: https://docs.docker.com/develop/develop-images/build_enhancements/
 .PHONY: docker-build
 docker-build: ## Build docker image with the manager.
-	$(CONTAINER_TOOL) build -t ${IMG} .
+	$(CONTAINER_TOOL) build -t ${IMG_PREFIX}:${IMG_TAG} .
 
 .PHONY: docker-push
 docker-push: ## Push docker image with the manager.
-	$(CONTAINER_TOOL) push ${IMG}
+	$(CONTAINER_TOOL) push ${IMG_PREFIX}:${IMG_TAG}
 
 # PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
-# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
+# architectures. (i.e. make docker-buildx IMG_PREFIX=myregistry/mypoperator IMG_TAG=0.0.1). To use this option you need to:
 # - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
 # - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
-# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
+# - be able to push the image to your registry (i.e. if you do not set a valid value via ${IMG_PREFIX}:${IMG_TAG} then the export will fail)
 # To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
 PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 .PHONY: docker-buildx
@@ -189,14 +191,14 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
 	- $(CONTAINER_TOOL) buildx create --name nrrcontroller-builder
 	$(CONTAINER_TOOL) buildx use nrrcontroller-builder
-	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
+	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG_PREFIX}:${IMG_TAG} -f Dockerfile.cross .
 	- $(CONTAINER_TOOL) buildx rm nrrcontroller-builder
 	rm Dockerfile.cross
 
 .PHONY: build-installer
 build-installer: manifests generate $(KUSTOMIZE) ## Generate a consolidated YAML with CRDs and deployment.
 	mkdir -p dist
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG_PREFIX}:${IMG_TAG}
 	$(KUSTOMIZE) build config/default > dist/install.yaml
 
 ## --------------------------------------
@@ -221,7 +223,7 @@ uninstall: manifests $(KUSTOMIZE) ## Uninstall CRDs from the K8s cluster specifi
 
 .PHONY: deploy
 deploy: manifests $(KUSTOMIZE) ## Deploy controller to the K8s cluster specified in ~/.kube/config.
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG_PREFIX}:${IMG_TAG}
 	$(KUSTOMIZE) build config/default | $(KUBECTL) apply -f -
 
 .PHONY: undeploy

cloudbuild.yaml

@@ -0,0 +1,9 @@
+# See https://cloud.google.com/cloud-build/docs/build-config
+
+options:
+  substitution_option: ALLOW_LOOSE
+steps:
+  - name: gcr.io/k8s-staging-test-infra/gcb-docker-gcloud:v20251211-3eba3d0954
+    entrypoint: ./scripts/build-and-publish-image.sh
+    env:
+    - IMG_PREFIX=us-central1-docker.pkg.dev/k8s-staging-images/node-readiness-controller

docs/TEST_README.md

@@ -40,7 +40,7 @@ Build the controller image and load it into the Kind cluster nodes.
 
 ```bash
 # Build the image
-make docker-build IMG=controller:latest
+make docker-build IMG_PREFIX=controller IMG_TAG=latest
 
 # Load the image into the kind cluster
 kind load docker-image controller:latest --name nrr-test
@@ -50,7 +50,7 @@ kind load docker-image controller:latest --name nrr-test
 
 Deploy the controller image to nrr-test-worker
 ```bash
-make deploy IMG=controller:latest
+make deploy IMG_PREFIX=controller IMG_TAG=latest
 ```
 
 Verify the controller is running on the platform node (`nrr-test-worker`):
@@ -128,4 +128,4 @@ This section tests how the controller handles new nodes being added to the clust
 
 ```bash
 kind delete cluster --name nrr-test
-```
+```

docs/getting-started.draft.md

@@ -47,10 +47,10 @@ spec:
 
 ### Deployment
 
-**Build and push your image to the location specified by `IMG`:**
+**Build and push your image to the location specified by `IMG_PREFIX`:`IMG_TAG` :**
 
 ```sh
-make docker-build docker-push IMG=<some-registry>/nrr-controller:tag
+make docker-build docker-push IMG_PREFIX=<some-registry>/nrr-controller IMG_TAG=tag
 ```
 
 #### Option 1: Deploy Using Make Commands
@@ -60,7 +60,7 @@ make docker-build docker-push IMG=<some-registry>/nrr-controller:tag
 make install
 
 # Deploy the controller
-make deploy IMG=<some-registry>/nrr-controller:tag
+make deploy IMG_PREFIX=<some-registry>/nrr-controller IMG_TAG=tag
 
 # Create sample rules
 kubectl apply -k examples/network-readiness-rule.yaml

scripts/build-and-publish-image.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+
+REPO_ROOT=$(git rev-parse --show-toplevel)
+cd "$REPO_ROOT"
+
+if [[ -z ${IMG_PREFIX:-} ]]; then
+  echo "IMG_PREFIX is not set"
+  exit 1
+fi
+
+if [[ -z ${IMG_TAG:-} ]]; then
+  # Use a tag if the current commit is a tag, otherwise use a date+git-hash tag
+  if git describe --exact-match --tags HEAD >/dev/null 2>&1; then
+    IMG_TAG=$(git describe --exact-match --tags HEAD)
+  else
+    IMG_TAG="$(date +v%Y%m%d)-$(git rev-parse --short HEAD)"
+  fi
+fi
+echo "Using IMG_TAG=${IMG_TAG}"
+
+IMG_TAG=${IMG_TAG} IMG_PREFIX=${IMG_PREFIX%/} make docker-build
+
+IMG_TAG=${IMG_TAG} IMG_PREFIX=${IMG_PREFIX%/} make docker-push

test/e2e/e2e_suite_test.go

@@ -40,9 +40,12 @@ var (
 	// isCertManagerAlreadyInstalled will be set true when CertManager CRDs be found on the cluster
 	isCertManagerAlreadyInstalled = false
 
-	// projectImage is the name of the image which will be build and loaded
+	// imagePrefix is the name of the image which will be build and loaded
 	// with the code source changes to be tested.
-	projectImage = "controller:latest"
+	imagePrefix = "controller"
+	// imageTag is the tag of the image which will be build and loaded
+	// with the code source changes to be tested.
+	imageTag = "latest"
 )
 
 // TestE2E runs the end-to-end (e2e) test suite for the project. These tests execute in an isolated,
@@ -57,14 +60,15 @@ func TestE2E(t *testing.T) {
 
 var _ = BeforeSuite(func() {
 	By("building the manager(Operator) image")
-	cmd := exec.Command("make", "docker-build", fmt.Sprintf("IMG=%s", projectImage))
+	cmd := exec.Command("make", "docker-build", fmt.Sprintf("IMG_PREFIX=%s", imagePrefix), fmt.Sprintf("IMG_TAG=%s", imageTag))
 	_, err := utils.Run(cmd)
 	ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to build the manager(Operator) image")
 
 	// TODO(user): If you want to change the e2e test vendor from Kind, ensure the image is
 	// built and available before running the tests. Also, remove the following block.
 	By("loading the manager(Operator) image on Kind")
-	err = utils.LoadImageToKindClusterWithName(projectImage)
+	//err = utils.LoadImageToKindClusterWithName(projectImage)
+	err = utils.LoadImageToKindClusterWithName(fmt.Sprintf("%s:%s", imagePrefix, imageTag))
 	ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to load the manager(Operator) image into Kind")
 
 	// The tests-e2e are intended to run on a temporary cluster that is created and destroyed for testing.

test/e2e/e2e_test.go

@@ -70,7 +70,7 @@ var _ = Describe("Manager", Ordered, func() {
 		Expect(err).NotTo(HaveOccurred(), "Failed to install CRDs")
 
 		By("deploying the controller-manager")
-		cmd = exec.Command("make", "deploy", fmt.Sprintf("IMG=%s", projectImage))
+		cmd = exec.Command("make", "deploy", fmt.Sprintf("IMG_PREFIX=%s", imagePrefix), fmt.Sprintf("IMG_TAG=%s", imageTag))
 		_, err = utils.Run(cmd)
 		Expect(err).NotTo(HaveOccurred(), "Failed to deploy the controller-manager")