feat: improve UX and maintainability by auto-uncommenting webhook blocks

This change enhances the user experience by automatically uncommenting
webhook-related code blocks during scaffolding. It also improves
maintainability by eliminating the need to manually uncomment code when
running end-to-end tests for examples and mocks.

Author: camilamacedo86

.github/workflows/test-e2e-samples.yml

@@ -39,12 +39,10 @@ jobs:
 
       - name: Prepare project-v4
         run: |
+          # Enable [METRICS-WITH-CERTS] by uncommenting the lines in kustomization.yaml
           KUSTOMIZATION_FILE_PATH="testdata/project-v4/config/default/kustomization.yaml"
-          sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
           sed -i '47,49s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment all cert-manager injections
-          sed -i '59,234s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '236,251s/^#//' $KUSTOMIZATION_FILE_PATH
+          sed -i '60,118s/^#//' $KUSTOMIZATION_FILE_PATH
           cd testdata/project-v4/
           go mod tidy
 
@@ -81,17 +79,6 @@ jobs:
 
       - name: Prepare project-v4-with-plugins
         run: |
-          KUSTOMIZATION_FILE_PATH="testdata/project-v4-with-plugins/config/default/kustomization.yaml"
-          sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment only ValidatingWebhookConfiguration
-          # from cert-manager replaces; we are leaving defaulting uncommented
-          # since this sample has no defaulting webhooks
-          sed -i '59,77s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '90,107s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '120,186s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment only --conversion webhooks CA injection
-          sed -i '219,234s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '236,251s/^#//' $KUSTOMIZATION_FILE_PATH
           cd testdata/project-v4-with-plugins/
           go mod tidy
 
@@ -128,13 +115,6 @@ jobs:
 
       - name: Prepare project-v4-multigroup
         run: |
-          KUSTOMIZATION_FILE_PATH="testdata/project-v4-multigroup/config/default/kustomization.yaml"
-          sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
-          # Uncomment all cert-manager injections for webhooks only
-          sed -i '59,77s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '90,107s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '120,234s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '236,251s/^#//' $KUSTOMIZATION_FILE_PATH
           cd testdata/project-v4-multigroup
           go mod tidy
 

docs/book/src/cronjob-tutorial/testdata/project/config/default/kustomization.yaml

@@ -116,7 +116,7 @@ replacements:
          delimiter: '.'
          index: 1
          create: true
-
+#
  - source: # Uncomment the following block if you have any webhook
      kind: Service
      version: v1
@@ -135,25 +135,26 @@ replacements:
          delimiter: '.'
          index: 0
          create: true
- - source:
-     kind: Service
-     version: v1
-     name: webhook-service
-     fieldPath: .metadata.namespace # Namespace of the service
-   targets:
-     - select:
-         kind: Certificate
-         group: cert-manager.io
-         version: v1
-         name: serving-cert
-       fieldPaths:
-         - .spec.dnsNames.0
-         - .spec.dnsNames.1
-       options:
-         delimiter: '.'
-         index: 1
-         create: true
 
+# - source:
+#     kind: Service
+#     version: v1
+#     name: webhook-service
+#     fieldPath: .metadata.namespace # Namespace of the service
+#   targets:
+#     - select:
+#         kind: Certificate
+#         group: cert-manager.io
+#         version: v1
+#         name: serving-cert
+#       fieldPaths:
+#         - .spec.dnsNames.0
+#         - .spec.dnsNames.1
+#       options:
+#         delimiter: '.'
+#         index: 1
+#         create: true
+#
  - source: # Uncomment the following block if you have a ValidatingWebhook (--programmatic-validation)
      kind: Certificate
      group: cert-manager.io
@@ -169,22 +170,23 @@ replacements:
          delimiter: '/'
          index: 0
          create: true
- - source:
-     kind: Certificate
-     group: cert-manager.io
-     version: v1
-     name: serving-cert
-     fieldPath: .metadata.name
-   targets:
-     - select:
-         kind: ValidatingWebhookConfiguration
-       fieldPaths:
-         - .metadata.annotations.[cert-manager.io/inject-ca-from]
-       options:
-         delimiter: '/'
-         index: 1
-         create: true
 
+# - source:
+#     kind: Certificate
+#     group: cert-manager.io
+#     version: v1
+#     name: serving-cert
+#     fieldPath: .metadata.name
+#   targets:
+#     - select:
+#         kind: ValidatingWebhookConfiguration
+#       fieldPaths:
+#         - .metadata.annotations.[cert-manager.io/inject-ca-from]
+#       options:
+#         delimiter: '/'
+#         index: 1
+#         create: true
+#
  - source: # Uncomment the following block if you have a DefaultingWebhook (--defaulting )
      kind: Certificate
      group: cert-manager.io
@@ -200,21 +202,22 @@ replacements:
          delimiter: '/'
          index: 0
          create: true
- - source:
-     kind: Certificate
-     group: cert-manager.io
-     version: v1
-     name: serving-cert
-     fieldPath: .metadata.name
-   targets:
-     - select:
-         kind: MutatingWebhookConfiguration
-       fieldPaths:
-         - .metadata.annotations.[cert-manager.io/inject-ca-from]
-       options:
-         delimiter: '/'
-         index: 1
-         create: true
+
+# - source:
+#     kind: Certificate
+#     group: cert-manager.io
+#     version: v1
+#     name: serving-cert
+#     fieldPath: .metadata.name
+#   targets:
+#     - select:
+#         kind: MutatingWebhookConfiguration
+#       fieldPaths:
+#         - .metadata.annotations.[cert-manager.io/inject-ca-from]
+#       options:
+#         delimiter: '/'
+#         index: 1
+#         create: true
 #
 # - source: # Uncomment the following block if you have a ConversionWebhook (--conversion)
 #     kind: Certificate

docs/book/src/cronjob-tutorial/testdata/project/dist/install.yaml

@@ -4253,8 +4253,8 @@ metadata:
   namespace: project-system
 spec:
   dnsNames:
-  - project-webhook-service.project-system.svc
-  - project-webhook-service.project-system.svc.cluster.local
+  - project-webhook-service.SERVICE_NAMESPACE.svc
+  - project-webhook-service.SERVICE_NAMESPACE.svc.cluster.local
   issuerRef:
     kind: Issuer
     name: project-selfsigned-issuer
@@ -4309,7 +4309,7 @@ apiVersion: admissionregistration.k8s.io/v1
 kind: MutatingWebhookConfiguration
 metadata:
   annotations:
-    cert-manager.io/inject-ca-from: project-system/project-serving-cert
+    cert-manager.io/inject-ca-from: project-system
   name: project-mutating-webhook-configuration
 webhooks:
 - admissionReviewVersions:
@@ -4337,7 +4337,7 @@ apiVersion: admissionregistration.k8s.io/v1
 kind: ValidatingWebhookConfiguration
 metadata:
   annotations:
-    cert-manager.io/inject-ca-from: project-system/project-serving-cert
+    cert-manager.io/inject-ca-from: project-system
   name: project-validating-webhook-configuration
 webhooks:
 - admissionReviewVersions:

docs/book/src/multiversion-tutorial/testdata/project/config/default/kustomization.yaml

@@ -116,7 +116,7 @@ replacements:
          delimiter: '.'
          index: 1
          create: true
-
+#
  - source: # Uncomment the following block if you have any webhook
      kind: Service
      version: v1
@@ -135,6 +135,7 @@ replacements:
          delimiter: '.'
          index: 0
          create: true
+
  - source:
      kind: Service
      version: v1
@@ -154,6 +155,7 @@ replacements:
          index: 1
          create: true
 
+
  - source: # Uncomment the following block if you have a ValidatingWebhook (--programmatic-validation)
      kind: Certificate
      group: cert-manager.io
@@ -169,6 +171,7 @@ replacements:
          delimiter: '/'
          index: 0
          create: true
+
  - source:
      kind: Certificate
      group: cert-manager.io
@@ -185,6 +188,7 @@ replacements:
          index: 1
          create: true
 
+
  - source: # Uncomment the following block if you have a DefaultingWebhook (--defaulting )
      kind: Certificate
      group: cert-manager.io
@@ -200,6 +204,7 @@ replacements:
          delimiter: '/'
          index: 0
          create: true
+
  - source:
      kind: Certificate
      group: cert-manager.io
@@ -216,6 +221,7 @@ replacements:
          index: 1
          create: true
 
+
  - source: # Uncomment the following block if you have a ConversionWebhook (--conversion)
      kind: Certificate
      group: cert-manager.io
@@ -250,3 +256,4 @@ replacements:
          index: 1
          create: true
 # +kubebuilder:scaffold:crdkustomizecainjectionname
+

hack/docs/internal/cronjob-tutorial/generate_cronjob.go

@@ -610,11 +610,6 @@ var _ = AfterSuite(func() {
 
 func (sp *Sample) updateKustomization() {
 	var err error
-	err = pluginutil.UncommentCode(
-		filepath.Join(sp.ctx.Dir, "config/default/kustomization.yaml"),
-		`#- ../certmanager`, `#`)
-	hackutils.CheckError("fixing default/kustomization", err)
-
 	err = pluginutil.UncommentCode(
 		filepath.Join(sp.ctx.Dir, "config/default/kustomization.yaml"),
 		`#- ../prometheus`, `#`)
@@ -637,7 +632,7 @@ func (sp *Sample) updateKustomization() {
 
 	err = pluginutil.UncommentCode(
 		filepath.Join(sp.ctx.Dir, "config/default/kustomization.yaml"),
-		certManagerForMetricsAndWebhooks, `#`)
+		certManagerForMetrics, `#`)
 	hackutils.CheckError("fixing default/kustomization", err)
 }