fix place where the metrics service should be scaffolded

.github/workflows/test-sample-go.yml

@@ -24,9 +24,9 @@ jobs:
         run: |
           KUSTOMIZATION_FILE_PATH="testdata/project-v4/config/default/kustomization.yaml"
           sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '39s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '44s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '48,144s/^#//' $KUSTOMIZATION_FILE_PATH
+          sed -i '41s/^#//' $KUSTOMIZATION_FILE_PATH
+          sed -i '46s/^#//' $KUSTOMIZATION_FILE_PATH
+          sed -i '50,146s/^#//' $KUSTOMIZATION_FILE_PATH
       
       - name: Test
         run: |

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

@@ -33,6 +33,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

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

@@ -9,7 +9,6 @@ resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml
 # For each CRD, "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
 # not used by the Project itself. You can comment the following lines

docs/book/src/getting-started/testdata/project/config/default/kustomization.yaml

@@ -33,6 +33,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

docs/book/src/getting-started/testdata/project/config/rbac/kustomization.yaml

@@ -9,7 +9,6 @@ resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml
 # For each CRD, "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
 # not used by the Project itself. You can comment the following lines

docs/book/src/reference/metrics.md

@@ -52,6 +52,8 @@ in the file `config/default/kustomization.yaml`, see:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+# - path: metrics_service_patch.yaml
 ```
 
 Note that projects are scaffolded by default passing the flag `--metrics-bind-address=0`

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

@@ -64,7 +64,7 @@ func (s *initScaffolder) Scaffold() error {
 
 	templates := []machinery.Builder{
 		&rbac.Kustomization{},
-		&rbac.MetricsService{},
+		&kdefault.MetricsService{},
 		&rbac.RoleBinding{},
 		// We need to create a Role because if the project
 		// has not CRD define the controller-gen will not generate this file

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

@@ -78,6 +78,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/rbac/metrics_service.go → pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/metrics_service_patch.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package rbac
+package kdefault
 
 import (
 	"path/filepath"
@@ -33,7 +33,7 @@ type MetricsService struct {
 // SetTemplateDefaults implements file.Template
 func (f *MetricsService) SetTemplateDefaults() error {
 	if f.Path == "" {
-		f.Path = filepath.Join("config", "rbac", "metrics_service.yaml")
+		f.Path = filepath.Join("config", "default", "metrics_service_patch.yaml")
 	}
 
 	f.TemplateBody = metricsServiceTemplate

pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/rbac/kustomization.go

@@ -53,5 +53,4 @@ const kustomizeRBACTemplate = `resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml
 `

test/e2e/v4/generate_test.go

@@ -66,6 +66,9 @@ func GenerateV4(kbc *utils.TestContext) {
 	ExpectWithOffset(1, pluginutil.UncommentCode(
 		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
 		metricsTarget, "#")).To(Succeed())
+	ExpectWithOffset(1, pluginutil.UncommentCode(
+		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		"#- path: metrics_service_patch.yaml", "#")).To(Succeed())
 
 	ExpectWithOffset(1, pluginutil.UncommentCode(filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
 		certManagerTarget, "#")).To(Succeed())
@@ -126,6 +129,9 @@ func GenerateV4WithoutWebhooks(kbc *utils.TestContext) {
 	ExpectWithOffset(1, pluginutil.UncommentCode(
 		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
 		metricsTarget, "#")).To(Succeed())
+	ExpectWithOffset(1, pluginutil.UncommentCode(
+		filepath.Join(kbc.Dir, "config", "default", "kustomization.yaml"),
+		"#- path: metrics_service_patch.yaml", "#")).To(Succeed())
 
 	if kbc.IsRestricted {
 		By("uncomment kustomize files to ensure that pods are restricted")

testdata/project-v4-multigroup-with-deploy-image/config/default/kustomization.yaml

@@ -33,6 +33,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

testdata/project-v4-multigroup-with-deploy-image/config/rbac/kustomization.yaml

@@ -9,7 +9,6 @@ resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml
 # For each CRD, "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
 # not used by the Project itself. You can comment the following lines

testdata/project-v4-multigroup-with-deploy-image/dist/install.yaml

@@ -1474,24 +1474,6 @@ subjects:
 ---
 apiVersion: v1
 kind: Service
-metadata:
-  labels:
-    app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/name: project-v4-multigroup-with-deploy-image
-    control-plane: controller-manager
-  name: project-v4-multigroup-with-deploy-image-controller-manager-metrics-service
-  namespace: project-v4-multigroup-with-deploy-image-system
-spec:
-  ports:
-  - name: http
-    port: 8080
-    protocol: TCP
-    targetPort: 8080
-  selector:
-    control-plane: controller-manager
----
-apiVersion: v1
-kind: Service
 metadata:
   labels:
     app.kubernetes.io/managed-by: kustomize

testdata/project-v4-multigroup/config/default/kustomization.yaml

@@ -33,6 +33,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

testdata/project-v4-multigroup/config/rbac/kustomization.yaml

@@ -9,7 +9,6 @@ resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml
 # For each CRD, "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
 # not used by the Project itself. You can comment the following lines

testdata/project-v4-multigroup/dist/install.yaml

@@ -1474,24 +1474,6 @@ subjects:
 ---
 apiVersion: v1
 kind: Service
-metadata:
-  labels:
-    app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/name: project-v4-multigroup
-    control-plane: controller-manager
-  name: project-v4-multigroup-controller-manager-metrics-service
-  namespace: project-v4-multigroup-system
-spec:
-  ports:
-  - name: http
-    port: 8080
-    protocol: TCP
-    targetPort: 8080
-  selector:
-    control-plane: controller-manager
----
-apiVersion: v1
-kind: Service
 metadata:
   labels:
     app.kubernetes.io/managed-by: kustomize

testdata/project-v4-with-deploy-image/config/default/kustomization.yaml

@@ -33,6 +33,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

testdata/project-v4-with-deploy-image/config/rbac/kustomization.yaml

@@ -9,7 +9,6 @@ resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml
 # For each CRD, "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
 # not used by the Project itself. You can comment the following lines

testdata/project-v4-with-deploy-image/dist/install.yaml

@@ -550,24 +550,6 @@ subjects:
 ---
 apiVersion: v1
 kind: Service
-metadata:
-  labels:
-    app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/name: project-v4-with-deploy-image
-    control-plane: controller-manager
-  name: project-v4-with-deploy-image-controller-manager-metrics-service
-  namespace: project-v4-with-deploy-image-system
-spec:
-  ports:
-  - name: http
-    port: 8080
-    protocol: TCP
-    targetPort: 8080
-  selector:
-    control-plane: controller-manager
----
-apiVersion: v1
-kind: Service
 metadata:
   labels:
     app.kubernetes.io/managed-by: kustomize

testdata/project-v4-with-grafana/config/default/kustomization.yaml

@@ -33,6 +33,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

testdata/project-v4-with-grafana/config/rbac/kustomization.yaml

@@ -9,4 +9,3 @@ resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml

testdata/project-v4-with-grafana/dist/install.yaml

@@ -107,24 +107,6 @@ subjects:
   name: project-v4-with-grafana-controller-manager
   namespace: project-v4-with-grafana-system
 ---
-apiVersion: v1
-kind: Service
-metadata:
-  labels:
-    app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/name: project-v4-with-grafana
-    control-plane: controller-manager
-  name: project-v4-with-grafana-controller-manager-metrics-service
-  namespace: project-v4-with-grafana-system
-spec:
-  ports:
-  - name: http
-    port: 8080
-    protocol: TCP
-    targetPort: 8080
-  selector:
-    control-plane: controller-manager
----
 apiVersion: apps/v1
 kind: Deployment
 metadata:

testdata/project-v4/config/default/kustomization.yaml

@@ -33,6 +33,8 @@ patches:
 #- path: manager_metrics_patch.yaml
 #  target:
 #    kind: Deployment
+# If you want to expose the metrics endpoint without TLS/HTTP protection, uncomment the following line.
+#- path: metrics_service_patch.yaml
 
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml

testdata/project-v4/config/rbac/kustomization.yaml

@@ -9,7 +9,6 @@ resources:
 - role_binding.yaml
 - leader_election_role.yaml
 - leader_election_role_binding.yaml
-- metrics_service.yaml
 # For each CRD, "Editor" and "Viewer" roles are scaffolded by
 # default, aiding admins in cluster management. Those roles are
 # not used by the Project itself. You can comment the following lines

testdata/project-v4/dist/install.yaml

@@ -544,24 +544,6 @@ subjects:
 ---
 apiVersion: v1
 kind: Service
-metadata:
-  labels:
-    app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/name: project-v4
-    control-plane: controller-manager
-  name: project-v4-controller-manager-metrics-service
-  namespace: project-v4-system
-spec:
-  ports:
-  - name: http
-    port: 8080
-    protocol: TCP
-    targetPort: 8080
-  selector:
-    control-plane: controller-manager
----
-apiVersion: v1
-kind: Service
 metadata:
   labels:
     app.kubernetes.io/managed-by: kustomize