Merge pull request #3626 from camilamacedo86/add-distro-mode

✨ (go/v4): Add method to allow users distribute the project
kubernetes-sigs · Jan 26, 2024 · 1e495ea · 1e495ea
2 parents 93d8fb8 + f39e53e
commit 1e495ea
Show file tree

Hide file tree

Showing 25 changed files with 2,430 additions and 15 deletions.
diff --git a/Makefile b/Makefile
@@ -91,7 +91,8 @@ lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 
 .PHONY: yamllint
 yamllint:
-	@docker run --rm $$(tty -s && echo "-it" || echo) -v $(PWD):/data cytopia/yamllint:latest testdata -d '{extends: relaxed, rules: {line-length: {max: 120}}, ignore: "/testdata/project-v2/\n/testdata/project-v3/"}'
+	@files=$$(find testdata -name '*.yaml' ! -path 'testdata/*/dist/install.yaml'); \
+    	docker run --rm $$(tty -s && echo "-it" || echo) -v $(PWD):/data cytopia/yamllint:latest $$files -d "{extends: relaxed, rules: {line-length: {max: 120}}}" --no-warnings
 
 GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint
 golangci-lint:

diff --git a/docs/book/src/component-config-tutorial/testdata/project/Makefile b/docs/book/src/component-config-tutorial/testdata/project/Makefile
@@ -115,6 +115,16 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	- $(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
+.PHONY: build-installer
+build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
+	mkdir -p dist
+	@if [ -d "config/crd" ]; then \
+		$(KUSTOMIZE) build config/crd > dist/install.yaml; \
+	fi
+	echo "---" >> dist/install.yaml  # Add a document separator before appending
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default >> dist/install.yaml
+
 ##@ Deployment
 
 ifndef ignore-not-found

diff --git a/docs/book/src/component-config-tutorial/testdata/project/README.md b/docs/book/src/component-config-tutorial/testdata/project/README.md
@@ -66,6 +66,29 @@ make uninstall
 make undeploy
 ```
 
+## Project Distribution
+
+Following are the steps to build the installer and distribute this project to users.
+
+1. Build the installer for the image built and published in the registry:
+
+```sh
+make build-installer IMG=<some-registry>/project:tag
+```
+
+NOTE: The makefile target mentioned above generates an 'install.yaml'
+file in the dist directory. This file contains all the resources built
+with Kustomize, which are necessary to install this project without
+its dependencies.
+
+2. Using the installer
+
+Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/<org>/project/<tag or branch>/dist/install.yaml
+```
+
 ## Contributing
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 

diff --git a/docs/book/src/cronjob-tutorial/testdata/project/Makefile b/docs/book/src/cronjob-tutorial/testdata/project/Makefile
@@ -115,6 +115,16 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	- $(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
+.PHONY: build-installer
+build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
+	mkdir -p dist
+	@if [ -d "config/crd" ]; then \
+		$(KUSTOMIZE) build config/crd > dist/install.yaml; \
+	fi
+	echo "---" >> dist/install.yaml  # Add a document separator before appending
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default >> dist/install.yaml
+
 ##@ Deployment
 
 ifndef ignore-not-found

diff --git a/docs/book/src/cronjob-tutorial/testdata/project/README.md b/docs/book/src/cronjob-tutorial/testdata/project/README.md
@@ -66,6 +66,29 @@ make uninstall
 make undeploy
 ```
 
+## Project Distribution
+
+Following are the steps to build the installer and distribute this project to users.
+
+1. Build the installer for the image built and published in the registry:
+
+```sh
+make build-installer IMG=<some-registry>/project:tag
+```
+
+NOTE: The makefile target mentioned above generates an 'install.yaml'
+file in the dist directory. This file contains all the resources built
+with Kustomize, which are necessary to install this project without
+its dependencies.
+
+2. Using the installer
+
+Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/<org>/project/<tag or branch>/dist/install.yaml
+```
+
 ## Contributing
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 

diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go
@@ -204,6 +204,16 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	- $(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
+.PHONY: build-installer
+build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
+	mkdir -p dist
+	@if [ -d "config/crd" ]; then \
+		$(KUSTOMIZE) build config/crd > dist/install.yaml; \
+	fi
+	echo "---" >> dist/install.yaml  # Add a document separator before appending
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default >> dist/install.yaml
+
 ##@ Deployment
 
 ifndef ignore-not-found

diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/readme.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/readme.go
@@ -51,7 +51,11 @@ func (f *Readme) SetTemplateDefaults() error {
 		codeFence("kubectl apply -k config/samples/"),
 		codeFence("kubectl delete -k config/samples/"),
 		codeFence("make uninstall"),
-		codeFence("make undeploy"))
+		codeFence("make undeploy"),
+		codeFence("make build-installer IMG=<some-registry>/{{ .ProjectName }}:tag"),
+		codeFence("kubectl apply -f https://raw.githubusercontent.com/<org>/{{ .ProjectName }}/"+
+			"<tag or branch>/dist/install.yaml"),
+	)
 
 	return nil
 }
@@ -111,6 +115,25 @@ You can apply the samples (examples) from the config/sample:
 
 %s
 
+## Project Distribution
+
+Following are the steps to build the installer and distribute this project to users.
+
+1. Build the installer for the image built and published in the registry:
+
+%s
+
+NOTE: The makefile target mentioned above generates an 'install.yaml'
+file in the dist directory. This file contains all the resources built
+with Kustomize, which are necessary to install this project without
+its dependencies.
+
+2. Using the installer
+
+Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+
+%s
+
 ## Contributing
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 

diff --git a/test/e2e/v4/plugin_cluster_test.go b/test/e2e/v4/plugin_cluster_test.go
@@ -85,19 +85,24 @@ var _ = Describe("kubebuilder", func() {
 			" with restricted pods", func() {
 			kbc.IsRestricted = true
 			GenerateV4(kbc)
-			Run(kbc, true)
+			Run(kbc, true, false)
 		})
 		It("should generate a runnable project without webhooks"+
 			" with restricted pods", func() {
 			kbc.IsRestricted = true
 			GenerateV4WithoutWebhooks(kbc)
-			Run(kbc, false)
+			Run(kbc, false, false)
+		})
+		It("should generate a runnable project"+
+			" with the Installer", func() {
+			GenerateV4(kbc)
+			Run(kbc, false, true)
 		})
 	})
 })
 
 // Run runs a set of e2e tests for a scaffolded project defined by a TestContext.
-func Run(kbc *utils.TestContext, hasWebhook bool) {
+func Run(kbc *utils.TestContext, hasWebhook, isToUseInstaller bool) {
 	var controllerPodName string
 	var err error
 
@@ -129,18 +134,35 @@ func Run(kbc *utils.TestContext, hasWebhook bool) {
 	err = kbc.LoadImageToKindCluster()
 	ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-	// NOTE: If you want to run the test against a GKE cluster, you will need to grant yourself permission.
-	// Otherwise, you may see "... is forbidden: attempt to grant extra privileges"
-	// $ kubectl create clusterrolebinding myname-cluster-admin-binding \
-	// --clusterrole=cluster-admin [email protected]
-	// https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control
-	By("deploying the controller-manager")
+	var output []byte
+	if !isToUseInstaller {
+		// NOTE: If you want to run the test against a GKE cluster, you will need to grant yourself permission.
+		// Otherwise, you may see "... is forbidden: attempt to grant extra privileges"
+		// $ kubectl create clusterrolebinding myname-cluster-admin-binding \
+		// --clusterrole=cluster-admin [email protected]
+		// https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control
+		By("deploying the controller-manager")
+
+		cmd := exec.Command("make", "deploy", "IMG="+kbc.ImageName)
+		output, err = kbc.Run(cmd)
+		ExpectWithOffset(1, err).NotTo(HaveOccurred())
+	} else {
+		By("building the installer")
+		err = kbc.Make("build-installer", "IMG="+kbc.ImageName)
+		ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-	cmd := exec.Command("make", "deploy", "IMG="+kbc.ImageName)
-	output, err := kbc.Run(cmd)
-	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+		// NOTE: If you want to run the test against a GKE cluster, you will need to grant yourself permission.
+		// Otherwise, you may see "... is forbidden: attempt to grant extra privileges"
+		// $ kubectl create clusterrolebinding myname-cluster-admin-binding \
+		// --clusterrole=cluster-admin [email protected]
+		// https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control
+		By("deploying the controller-manager with the installer")
+
+		_, err = kbc.Kubectl.Apply(true, "-f", "dist/install.yaml")
+		ExpectWithOffset(1, err).NotTo(HaveOccurred())
+	}
 
-	if kbc.IsRestricted {
+	if kbc.IsRestricted && !isToUseInstaller {
 		By("validating that manager Pod/container(s) are restricted")
 		ExpectWithOffset(1, output).NotTo(ContainSubstring("Warning: would violate PodSecurity"))
 	}

diff --git a/test/testdata/generate.sh b/test/testdata/generate.sh
@@ -116,6 +116,15 @@ function scaffold_test_project {
   fi
 
   make generate manifests
+  # TODO fix the error with multigroup layout and allow it be generated
+  # with this one.
+  # Error: trouble configuring builtin PatchTransformer with config: `
+  # path: patches/webhook_in_sea-creatures_krakens.yaml
+  # `: failed to get the patch file from path(patches/webhook_in_sea-creatures_krakens.yaml): evalsymlink failure on '/Users/camiladeomacedo/go/src/sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/config/crd/patches/webhook_in_sea-creatures_krakens.yaml' : lstat go/src/sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/config/crd/patches/webhook_in_sea-creatures_krakens.yaml: no such file or directory
+  if [[ $project =~ v4 && ! $project =~ multigroup ]]; then
+    make build-installer
+  fi
+
   rm -f go.sum
   go mod tidy
   popd

diff --git a/testdata/project-v4-multigroup-with-deploy-image/Makefile b/testdata/project-v4-multigroup-with-deploy-image/Makefile
@@ -115,6 +115,16 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	- $(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
+.PHONY: build-installer
+build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
+	mkdir -p dist
+	@if [ -d "config/crd" ]; then \
+		$(KUSTOMIZE) build config/crd > dist/install.yaml; \
+	fi
+	echo "---" >> dist/install.yaml  # Add a document separator before appending
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default >> dist/install.yaml
+
 ##@ Deployment
 
 ifndef ignore-not-found

diff --git a/testdata/project-v4-multigroup-with-deploy-image/README.md b/testdata/project-v4-multigroup-with-deploy-image/README.md
@@ -66,6 +66,29 @@ make uninstall
 make undeploy
 ```
 
+## Project Distribution
+
+Following are the steps to build the installer and distribute this project to users.
+
+1. Build the installer for the image built and published in the registry:
+
+```sh
+make build-installer IMG=<some-registry>/project-v4-multigroup-with-deploy-image:tag
+```
+
+NOTE: The makefile target mentioned above generates an 'install.yaml'
+file in the dist directory. This file contains all the resources built
+with Kustomize, which are necessary to install this project without
+its dependencies.
+
+2. Using the installer
+
+Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/<org>/project-v4-multigroup-with-deploy-image/<tag or branch>/dist/install.yaml
+```
+
 ## Contributing
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 

diff --git a/testdata/project-v4-multigroup/Makefile b/testdata/project-v4-multigroup/Makefile
@@ -115,6 +115,16 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	- $(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
+.PHONY: build-installer
+build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
+	mkdir -p dist
+	@if [ -d "config/crd" ]; then \
+		$(KUSTOMIZE) build config/crd > dist/install.yaml; \
+	fi
+	echo "---" >> dist/install.yaml  # Add a document separator before appending
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default >> dist/install.yaml
+
 ##@ Deployment
 
 ifndef ignore-not-found

diff --git a/testdata/project-v4-multigroup/README.md b/testdata/project-v4-multigroup/README.md
@@ -66,6 +66,29 @@ make uninstall
 make undeploy
 ```
 
+## Project Distribution
+
+Following are the steps to build the installer and distribute this project to users.
+
+1. Build the installer for the image built and published in the registry:
+
+```sh
+make build-installer IMG=<some-registry>/project-v4-multigroup:tag
+```
+
+NOTE: The makefile target mentioned above generates an 'install.yaml'
+file in the dist directory. This file contains all the resources built
+with Kustomize, which are necessary to install this project without
+its dependencies.
+
+2. Using the installer
+
+Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/<org>/project-v4-multigroup/<tag or branch>/dist/install.yaml
+```
+
 ## Contributing
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 

diff --git a/testdata/project-v4-with-deploy-image/Makefile b/testdata/project-v4-with-deploy-image/Makefile
@@ -115,6 +115,16 @@ docker-buildx: ## Build and push docker image for the manager for cross-platform
 	- $(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
+.PHONY: build-installer
+build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
+	mkdir -p dist
+	@if [ -d "config/crd" ]; then \
+		$(KUSTOMIZE) build config/crd > dist/install.yaml; \
+	fi
+	echo "---" >> dist/install.yaml  # Add a document separator before appending
+	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	$(KUSTOMIZE) build config/default >> dist/install.yaml
+
 ##@ Deployment
 
 ifndef ignore-not-found

diff --git a/testdata/project-v4-with-deploy-image/README.md b/testdata/project-v4-with-deploy-image/README.md
@@ -66,6 +66,29 @@ make uninstall
 make undeploy
 ```
 
+## Project Distribution
+
+Following are the steps to build the installer and distribute this project to users.
+
+1. Build the installer for the image built and published in the registry:
+
+```sh
+make build-installer IMG=<some-registry>/project-v4-with-deploy-image:tag
+```
+
+NOTE: The makefile target mentioned above generates an 'install.yaml'
+file in the dist directory. This file contains all the resources built
+with Kustomize, which are necessary to install this project without
+its dependencies.
+
+2. Using the installer
+
+Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/<org>/project-v4-with-deploy-image/<tag or branch>/dist/install.yaml
+```
+
 ## Contributing
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 

diff --git a/testdata/project-v4-with-deploy-image/config/manager/kustomization.yaml b/testdata/project-v4-with-deploy-image/config/manager/kustomization.yaml
@@ -1,2 +1,8 @@
 resources:
 - manager.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+images:
+- name: controller
+  newName: controller
+  newTag: latest