(go/v4): add support to distribute projects

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:

docs/book/src/component-config-tutorial/testdata/project/Makefile

@@ -123,6 +123,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

docs/book/src/component-config-tutorial/testdata/project/README.md

@@ -66,6 +66,27 @@ make uninstall
 make undeploy
 ```
 
+## Distributing your project
+
+Following the steps for you build the installer and to distribute this project for users.
+
+### Build the installer
+To build the installer for the image built and published in the registry:
+
+make build-installer IMG=<some-registry>/project:tag
+
+NOTE: The above makefile target will generate the install.yaml in the directory dist contains all resources
+build with Kustomize to install this project.
+
+### To install via the installer
+
+You must just run kubectl apply -f dist/install.yaml.
+Therefore, users can install this project if they have access to the repository by running:
+
+```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
 

docs/book/src/cronjob-tutorial/testdata/project/Makefile

@@ -123,6 +123,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

docs/book/src/cronjob-tutorial/testdata/project/README.md

@@ -66,6 +66,27 @@ make uninstall
 make undeploy
 ```
 
+## Distributing your project
+
+Following the steps for you build the installer and to distribute this project for users.
+
+### Build the installer
+To build the installer for the image built and published in the registry:
+
+make build-installer IMG=<some-registry>/project:tag
+
+NOTE: The above makefile target will generate the install.yaml in the directory dist contains all resources
+build with Kustomize to install this project.
+
+### To install via the installer
+
+You must just run kubectl apply -f dist/install.yaml.
+Therefore, users can install this project if they have access to the repository by running:
+
+```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
 

pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go

@@ -187,6 +187,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

pkg/plugins/golang/v4/scaffolds/internal/templates/readme.go

@@ -44,14 +44,18 @@ func (f *Readme) SetTemplateDefaults() error {
 		strings.Replace(f.Boilerplate, "/*", "", 1),
 		"*/", "", 1)
 
+	distCommand := "kubectl apply -f https://raw.githubusercontent.com/<org>/" + f.ProjectName + "/<tag or branch>/dist/install.yaml"
+
 	f.TemplateBody = fmt.Sprintf(readmeFileTemplate,
 		codeFence("make docker-build docker-push IMG=<some-registry>/{{ .ProjectName }}:tag"),
 		codeFence("make install"),
 		codeFence("make deploy IMG=<some-registry>/{{ .ProjectName }}:tag"),
 		codeFence("kubectl apply -k config/samples/"),
 		codeFence("kubectl delete -k config/samples/"),
 		codeFence("make uninstall"),
-		codeFence("make undeploy"))
+		codeFence("make undeploy"),
+		codeFence(distCommand),
+	)
 
 	return nil
 }
@@ -111,6 +115,25 @@ You can apply the samples (examples) from the config/sample:
 
 %s
 
+## Distributing your project
+
+Following the steps for you build the installer and to distribute this project for users.
+
+### Build the installer
+To build the installer for the image built and published in the registry:
+
+make build-installer IMG=<some-registry>/{{ .ProjectName }}:tag
+
+NOTE: The above makefile target will generate the install.yaml in the directory dist contains all resources
+build with Kustomize to install this project.
+
+### To install via the installer
+
+You must just run kubectl apply -f dist/install.yaml.
+Therefore, users can install this project if they have access to the repository by running:
+
+%s
+
 ## Contributing
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 

test/e2e/v4/plugin_cluster_test.go

@@ -93,9 +93,135 @@ var _ = Describe("kubebuilder", func() {
 			GenerateV4WithoutWebhooks(kbc)
 			Run(kbc, false)
 		})
+		It("should generate a runnable project"+
+			" with the Installer", func() {
+			GenerateV4WithoutWebhooks(kbc)
+			RunWithInstaller(kbc)
+		})
 	})
 })
 
+// TODO: We need to clean up and refactor these tests.
+// Remove duplicates and ensure cohesion and encapsulation
+// For Example: Run should not have make generate and manifests it should be part of the build of the project
+// Also we can encapsulate the checks such as: checkManager, checkPrometheus, checkCertManager so that we can reuse them
+// when or not is required and create many scenarios.
+
+// RunWithInstaller runs a set of e2e tests for a scaffolded project defined by a TestContext.
+func RunWithInstaller(kbc *utils.TestContext) {
+	var controllerPodName string
+	var err error
+
+	By("creating manager namespace")
+	err = kbc.CreateManagerNamespace()
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("updating the go.mod")
+	err = kbc.Tidy()
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("run make manifests")
+	err = kbc.Make("manifests")
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("run make generate")
+	err = kbc.Make("generate")
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("building the controller image")
+	err = kbc.Make("docker-build", "IMG="+kbc.ImageName)
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("loading the controller docker image into the kind cluster")
+	err = kbc.LoadImageToKindCluster()
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("building the installer")
+	err = kbc.Make("build-installer", "IMG="+kbc.ImageName)
+	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 --user=myname@mycompany.com
+	// 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())
+
+	By("validating that the controller-manager pod is running as expected")
+	verifyControllerUp := func() error {
+		// Get pod name
+		podOutput, err := kbc.Kubectl.Get(
+			true,
+			"pods", "-l", "control-plane=controller-manager",
+			"-o", "go-template={{ range .items }}{{ if not .metadata.deletionTimestamp }}{{ .metadata.name }}"+
+				"{{ \"\\n\" }}{{ end }}{{ end }}")
+		ExpectWithOffset(2, err).NotTo(HaveOccurred())
+		podNames := util.GetNonEmptyLines(podOutput)
+		if len(podNames) != 1 {
+			return fmt.Errorf("expect 1 controller pods running, but got %d", len(podNames))
+		}
+		controllerPodName = podNames[0]
+		ExpectWithOffset(2, controllerPodName).Should(ContainSubstring("controller-manager"))
+
+		// Validate pod status
+		status, err := kbc.Kubectl.Get(
+			true,
+			"pods", controllerPodName, "-o", "jsonpath={.status.phase}")
+		ExpectWithOffset(2, err).NotTo(HaveOccurred())
+		if status != "Running" {
+			return fmt.Errorf("controller pod in %s status", status)
+		}
+		return nil
+	}
+	defer func() {
+		out, err := kbc.Kubectl.CommandInNamespace("describe", "all")
+		ExpectWithOffset(1, err).NotTo(HaveOccurred())
+		fmt.Fprintln(GinkgoWriter, out)
+	}()
+	EventuallyWithOffset(1, verifyControllerUp, time.Minute, time.Second).Should(Succeed())
+
+	By("granting permissions to access the metrics")
+	_, err = kbc.Kubectl.Command(
+		"create", "clusterrolebinding", fmt.Sprintf("metrics-%s", kbc.TestSuffix),
+		fmt.Sprintf("--clusterrole=e2e-%s-metrics-reader", kbc.TestSuffix),
+		fmt.Sprintf("--serviceaccount=%s:%s", kbc.Kubectl.Namespace, kbc.Kubectl.ServiceAccount))
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	_ = curlMetrics(kbc)
+
+	By("validating that cert-manager has provisioned the certificate Secret")
+	EventuallyWithOffset(1, func() error {
+		_, err := kbc.Kubectl.Get(
+			true,
+			"secrets", "webhook-server-cert")
+		return err
+	}, time.Minute, time.Second).Should(Succeed())
+
+	By("validating that the Prometheus manager has provisioned the Service")
+	EventuallyWithOffset(1, func() error {
+		_, err := kbc.Kubectl.Get(
+			false,
+			"Service", "prometheus-operator")
+		return err
+	}, time.Minute, time.Second).Should(Succeed())
+
+	By("validating that the ServiceMonitor for Prometheus is applied in the namespace")
+	_, err = kbc.Kubectl.Get(
+		true,
+		"ServiceMonitor")
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("validating that the created resource object gets reconciled in the controller")
+	metricsOutput := curlMetrics(kbc)
+	ExpectWithOffset(1, metricsOutput).To(ContainSubstring(fmt.Sprintf(
+		`controller_runtime_reconcile_total{controller="%s",result="success"} 1`,
+		strings.ToLower(kbc.Kind),
+	)))
+}
+
 // Run runs a set of e2e tests for a scaffolded project defined by a TestContext.
 func Run(kbc *utils.TestContext, hasWebhook bool) {
 	var controllerPodName string

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

testdata/project-v4-multigroup-with-deploy-image/Makefile

@@ -123,6 +123,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

testdata/project-v4-multigroup-with-deploy-image/README.md

@@ -66,6 +66,27 @@ make uninstall
 make undeploy
 ```
 
+## Distributing your project
+
+Following the steps for you build the installer and to distribute this project for users.
+
+### Build the installer
+To build the installer for the image built and published in the registry:
+
+make build-installer IMG=<some-registry>/project-v4-multigroup-with-deploy-image:tag
+
+NOTE: The above makefile target will generate the install.yaml in the directory dist contains all resources
+build with Kustomize to install this project.
+
+### To install via the installer
+
+You must just run kubectl apply -f dist/install.yaml.
+Therefore, users can install this project if they have access to the repository by running:
+
+```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
 

testdata/project-v4-multigroup/Makefile

@@ -123,6 +123,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