🐛 (kustomize/v1 and kustomize/v2-alpha) : ComponentConfig scaffolds s…

…hould not be done by default (#2826)

ComponentConfig scaffolds should not be done by default

updated testdata

update v2-alpha and modified tests and added component-confit flag in it

modified tests and enables componenet config flag

removed unnecessary addition componenent config flag in v2 whenre this flag is not available

removed for tests

modified kustomization.yml file

modified testdata

added end to end tests with component config field marked as true

line length is more than 122 characters

mis spell

updated doc

modified docs

modified docs

modified default kustomization file too

updated scaffold condition

worked on review comments

updated according to code review comments

docs/book/src/component-config-tutorial/api-changes.md

@@ -67,3 +67,68 @@ mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options)
 With that out of the way, we can get on to defining our new config!
 
 [tutorial-source]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs/book/src/component-config-tutorial/testdata/project
+
+Create the file `/config/manager/controller_manager_config.yaml` with the following content:
+
+```yaml
+apiVersion: controller-runtime.sigs.k8s.io/v1alpha1
+kind: ControllerManagerConfig
+health:
+  healthProbeBindAddress: :8081
+metrics:
+  bindAddress: 127.0.0.1:8080
+webhook:
+  port: 9443
+leaderElection:
+  leaderElect: true
+  resourceName: ecaf1259.tutorial.kubebuilder.io
+# leaderElectionReleaseOnCancel defines if the leader should step down volume
+# when the Manager ends. This requires the binary to immediately end when the
+# Manager is stopped, otherwise, this setting is unsafe. Setting this significantly
+# speeds up voluntary leader transitions as the new leader don't have to wait
+# LeaseDuration time first.
+# In the default scaffold provided, the program ends immediately after
+# the manager stops, so would be fine to enable this option. However,
+# if you are doing or is intended to do any operation such as perform cleanups
+# after the manager stops then its usage might be unsafe.
+# leaderElectionReleaseOnCancel: true
+```
+
+Update the file `/config/manager/kustomization.yaml` by adding at the bottom the following content:
+
+```yaml
+generatorOptions:
+  disableNameSuffixHash: true
+
+configMapGenerator:
+- name: manager-config
+  files:
+  - controller_manager_config.yaml
+```
+
+Update the file `default/kustomization.yaml` by adding under the patchesStrategicMerge: the following patch:
+
+# Mount the controller config file for loading manager configurations
+# through a ComponentConfig type
+- manager_config_patch.yaml
+
+Update the file `default/manager_config_patch.yaml` by adding under the spec: the following patch:
+
+```yaml
+spec:
+  template:
+    spec:
+      containers:
+      - name: manager
+        args:
+        - "--config=controller_manager_config.yaml"
+        volumeMounts:
+        - name: manager-config
+          mountPath: /controller_manager_config.yaml
+          subPath: controller_manager_config.yaml
+      volumes:
+      - name: manager-config
+        configMap:
+          name: manager-config
+```
+

pkg/plugins/common/kustomize/v1/scaffolds/init.go

@@ -62,7 +62,7 @@ func (s *initScaffolder) Scaffold() error {
 		machinery.WithConfig(s.config),
 	)
 
-	return scaffold.Execute(
+	templates := []machinery.Builder{
 		&rbac.Kustomization{},
 		&rbac.AuthProxyRole{},
 		&rbac.AuthProxyRoleBinding{},
@@ -74,11 +74,16 @@ func (s *initScaffolder) Scaffold() error {
 		&rbac.ServiceAccount{},
 		&manager.Kustomization{},
 		&manager.Config{Image: imageName},
-		&manager.ControllerManagerConfig{},
 		&kdefault.Kustomization{},
 		&kdefault.ManagerAuthProxyPatch{},
 		&kdefault.ManagerConfigPatch{},
 		&prometheus.Kustomization{},
 		&prometheus.Monitor{},
-	)
+	}
+
+	if s.config.IsComponentConfig() {
+		templates = append(templates, &manager.ControllerManagerConfig{})
+	}
+
+	return scaffold.Execute(templates...)
 }

pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/kustomization.go

@@ -76,9 +76,10 @@ patchesStrategicMerge:
 # endpoint w/o any authn/z, please comment the following line.
 - manager_auth_proxy_patch.yaml
 
+{{ if .ComponentConfig }}
 # Mount the controller config file for loading manager configurations
 # through a ComponentConfig type
-{{ if not .ComponentConfig }}#{{ end }}- manager_config_patch.yaml
+- manager_config_patch.yaml{{ end }}
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/kdefault/manager_config_patch.go

@@ -27,6 +27,7 @@ var _ machinery.Template = &ManagerConfigPatch{}
 // ManagerConfigPatch scaffolds a ManagerConfigPatch for a Resource
 type ManagerConfigPatch struct {
 	machinery.TemplateMixin
+	machinery.ComponentConfigMixin
 }
 
 // SetTemplateDefaults implements input.Template
@@ -50,6 +51,7 @@ spec:
     spec:
       containers:
       - name: manager
+{{- if .ComponentConfig }}
         args:
         - "--config=controller_manager_config.yaml"
         volumeMounts:
@@ -60,4 +62,5 @@ spec:
       - name: manager-config
         configMap:
           name: manager-config
+{{- end }}
 `

pkg/plugins/common/kustomize/v1/scaffolds/internal/templates/config/manager/kustomization.go

@@ -27,6 +27,7 @@ var _ machinery.Template = &Kustomization{}
 // Kustomization scaffolds a file that defines the kustomization scheme for the manager folder
 type Kustomization struct {
 	machinery.TemplateMixin
+	machinery.ComponentConfigMixin
 }
 
 // SetTemplateDefaults implements file.Template
@@ -45,11 +46,14 @@ func (f *Kustomization) SetTemplateDefaults() error {
 const kustomizeManagerTemplate = `resources:
 - manager.yaml
 
+{{- if .ComponentConfig }}
+
 generatorOptions:
   disableNameSuffixHash: true
 
 configMapGenerator:
 - name: manager-config
   files:
   - controller_manager_config.yaml
+{{- end }}
 `

pkg/plugins/common/kustomize/v2-alpha/scaffolds/init.go

@@ -62,7 +62,7 @@ func (s *initScaffolder) Scaffold() error {
 		machinery.WithConfig(s.config),
 	)
 
-	return scaffold.Execute(
+	templates := []machinery.Builder{
 		&rbac.Kustomization{},
 		&rbac.AuthProxyRole{},
 		&rbac.AuthProxyRoleBinding{},
@@ -74,11 +74,16 @@ func (s *initScaffolder) Scaffold() error {
 		&rbac.ServiceAccount{},
 		&manager.Kustomization{},
 		&manager.Config{Image: imageName},
-		&manager.ControllerManagerConfig{},
 		&kdefault.Kustomization{},
 		&kdefault.ManagerAuthProxyPatch{},
 		&kdefault.ManagerConfigPatch{},
 		&prometheus.Kustomization{},
 		&prometheus.Monitor{},
-	)
+	}
+
+	if s.config.IsComponentConfig() {
+		templates = append(templates, &manager.ControllerManagerConfig{})
+	}
+
+	return scaffold.Execute(templates...)
 }

pkg/plugins/common/kustomize/v2-alpha/scaffolds/internal/templates/config/kdefault/kustomization.go

@@ -78,9 +78,10 @@ patchesStrategicMerge:
 # endpoint w/o any authn/z, please comment the following line.
 - manager_auth_proxy_patch.yaml
 
+{{ if .ComponentConfig }}
 # Mount the controller config file for loading manager configurations
 # through a ComponentConfig type
-{{ if not .ComponentConfig }}#{{ end }}- manager_config_patch.yaml
+- manager_config_patch.yaml{{ end }}
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

pkg/plugins/common/kustomize/v2-alpha/scaffolds/internal/templates/config/kdefault/manager_config_patch.go

@@ -27,6 +27,7 @@ var _ machinery.Template = &ManagerConfigPatch{}
 // ManagerConfigPatch scaffolds a ManagerConfigPatch for a Resource
 type ManagerConfigPatch struct {
 	machinery.TemplateMixin
+	machinery.ComponentConfigMixin
 }
 
 // SetTemplateDefaults implements input.Template
@@ -50,6 +51,7 @@ spec:
     spec:
       containers:
       - name: manager
+{{- if .ComponentConfig }}
         args:
         - "--config=controller_manager_config.yaml"
         volumeMounts:
@@ -60,4 +62,5 @@ spec:
       - name: manager-config
         configMap:
           name: manager-config
+{{- end }}
 `

pkg/plugins/common/kustomize/v2-alpha/scaffolds/internal/templates/config/manager/kustomization.go

@@ -27,6 +27,7 @@ var _ machinery.Template = &Kustomization{}
 // Kustomization scaffolds a file that defines the kustomization scheme for the manager folder
 type Kustomization struct {
 	machinery.TemplateMixin
+	machinery.ComponentConfigMixin
 }
 
 // SetTemplateDefaults implements file.Template
@@ -45,11 +46,14 @@ func (f *Kustomization) SetTemplateDefaults() error {
 const kustomizeManagerTemplate = `resources:
 - manager.yaml
 
+{{- if .ComponentConfig }}
+
 generatorOptions:
   disableNameSuffixHash: true
 
 configMapGenerator:
 - name: manager-config
   files:
   - controller_manager_config.yaml
+{{- end }}
 `

test/e2e/v3/generate_test.go

@@ -235,6 +235,113 @@ Count int `+"`"+`json:"count,omitempty"`+"`"+`
 	}
 }
 
+// GenerateV3 implements a go/v3(-alpha) plugin project defined by a TestContext.
+func GenerateV3ComponentConfig(kbc *utils.TestContext, crdAndWebhookVersion string) {
+	var err error
+
+	By("initializing a project")
+	err = kbc.Init(
+		"--plugins", "go/v3",
+		"--project-version", "3",
+		"--domain", kbc.Domain,
+		"--fetch-deps=false",
+		"--component-config=true",
+	)
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("creating API definition")
+	err = kbc.CreateAPI(
+		"--group", kbc.Group,
+		"--version", kbc.Version,
+		"--kind", kbc.Kind,
+		"--namespaced",
+		"--resource",
+		"--controller",
+		"--make=false",
+		"--crd-version", crdAndWebhookVersion,
+	)
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("implementing the API")
+	ExpectWithOffset(1, pluginutil.InsertCode(
+		filepath.Join(kbc.Dir, "api", kbc.Version, fmt.Sprintf("%s_types.go", strings.ToLower(kbc.Kind))),
+		fmt.Sprintf(`type %sSpec struct {
+`, kbc.Kind),
+		`	// +optional
+Count int `+"`"+`json:"count,omitempty"`+"`"+`
+`)).Should(Succeed())
+
+	By("scaffolding mutating and validating webhooks")
+	err = kbc.CreateWebhook(
+		"--group", kbc.Group,
+		"--version", kbc.Version,
+		"--kind", kbc.Kind,
+		"--defaulting",
+		"--programmatic-validation",
+		"--webhook-version", crdAndWebhookVersion,
+	)
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("implementing the mutating and validating webhooks")
+	err = pluginutil.ImplementWebhooks(filepath.Join(
+		kbc.Dir, "api", kbc.Version,
+		fmt.Sprintf("%s_webhook.go", strings.ToLower(kbc.Kind))))
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+
+	By("uncomment kustomization.yaml to enable webhook and ca injection")
+	ExpectWithOffset(1, pluginutil.UncommentCode(
+		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		"#- ../webhook", "#")).To(Succeed())
+	ExpectWithOffset(1, pluginutil.UncommentCode(
+		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		"#- ../certmanager", "#")).To(Succeed())
+	ExpectWithOffset(1, pluginutil.UncommentCode(
+		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		"#- ../prometheus", "#")).To(Succeed())
+	ExpectWithOffset(1, pluginutil.UncommentCode(
+		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		"#- manager_webhook_patch.yaml", "#")).To(Succeed())
+	ExpectWithOffset(1, pluginutil.UncommentCode(
+		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		"#- webhookcainjection_patch.yaml", "#")).To(Succeed())
+	ExpectWithOffset(1, pluginutil.UncommentCode(filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		`#- name: CERTIFICATE_NAMESPACE # namespace of the certificate CR
+#  objref:
+#    kind: Certificate
+#    group: cert-manager.io
+#    version: v1
+#    name: serving-cert # this name should match the one in certificate.yaml
+#  fieldref:
+#    fieldpath: metadata.namespace
+#- name: CERTIFICATE_NAME
+#  objref:
+#    kind: Certificate
+#    group: cert-manager.io
+#    version: v1
+#    name: serving-cert # this name should match the one in certificate.yaml
+#- name: SERVICE_NAMESPACE # namespace of the service
+#  objref:
+#    kind: Service
+#    version: v1
+#    name: webhook-service
+#  fieldref:
+#    fieldpath: metadata.namespace
+#- name: SERVICE_NAME
+#  objref:
+#    kind: Service
+#    version: v1
+#    name: webhook-service`, "#")).To(Succeed())
+
+	if crdAndWebhookVersion == "v1beta1" {
+		_ = pluginutil.RunCmd("Update dependencies", "go", "mod", "tidy")
+	}
+
+	if kbc.IsRestricted {
+		By("uncomment kustomize files to ensure that pods are restricted")
+		uncommentPodStandards(kbc)
+	}
+}
+
 func uncommentPodStandards(kbc *utils.TestContext) {
 	configManager := filepath.Join(kbc.Dir, "config", "manager", "manager.yaml")
 

test/e2e/v3/plugin_cluster_test.go

@@ -174,6 +174,17 @@ var _ = Describe("kubebuilder", func() {
 				GenerateV3(kbc, "v1beta1")
 				Run(kbc)
 			})
+			It("should generate a runnable project go/v3 with v1 CRDs and Webhooks"+
+				"with --component-config flag enabled", func() {
+				// Skip if cluster version < 1.16, when v1 CRDs and webhooks did not exist.
+				if srvVer := kbc.K8sVersion.ServerVersion; srvVer.GetMajorInt() <= 1 && srvVer.GetMinorInt() < 16 {
+					Skip(fmt.Sprintf("cluster version %s does not support v1 CRDs or webhooks",
+						srvVer.GitVersion))
+				}
+
+				GenerateV3ComponentConfig(kbc, "v1")
+				Run(kbc)
+			})
 		})
 	})
 })