Merge pull request #1100 from percona/K8SPG-750_add_cluster_name_to_pmm

nmarukovich · web-flow · commit 988cd8a7ef01 · 2025-03-27T15:29:26.000+01:00
K8SPG-750 add cluster name to pmm
diff --git a/build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml b/build/crd/percona/generated/pgv2.percona.com_perconapgclusters.yaml
@@ -13617,6 +13617,8 @@ spec:
                             type: string
                         type: object
                     type: object
+                  customClusterName:
+                    type: string
                   enabled:
                     type: boolean
                   image:
diff --git a/config/crd/bases/pgv2.percona.com_perconapgclusters.yaml b/config/crd/bases/pgv2.percona.com_perconapgclusters.yaml
@@ -14022,6 +14022,8 @@ spec:
                             type: string
                         type: object
                     type: object
+                  customClusterName:
+                    type: string
                   enabled:
                     type: boolean
                   image:
diff --git a/deploy/bundle.yaml b/deploy/bundle.yaml
@@ -14315,6 +14315,8 @@ spec:
                             type: string
                         type: object
                     type: object
+                  customClusterName:
+                    type: string
                   enabled:
                     type: boolean
                   image:
diff --git a/deploy/cr.yaml b/deploy/cr.yaml
@@ -471,6 +471,7 @@ spec:
 #    imagePullPolicy: IfNotPresent
     secret: cluster1-pmm-secret
     serverHost: monitoring-service
+#   customClusterName: "<string>"
 #    querySource: pgstatmonitor
 #  patroni:
 #    # Some values of the Liveness/Readiness probes of the patroni container are calculated using syncPeriodSeconds by the following formulas:
diff --git a/deploy/crd.yaml b/deploy/crd.yaml
@@ -14315,6 +14315,8 @@ spec:
                             type: string
                         type: object
                     type: object
+                  customClusterName:
+                    type: string
                   enabled:
                     type: boolean
                   image:
diff --git a/deploy/cw-bundle.yaml b/deploy/cw-bundle.yaml
@@ -14315,6 +14315,8 @@ spec:
                             type: string
                         type: object
                     type: object
+                  customClusterName:
+                    type: string
                   enabled:
                     type: boolean
                   image:
diff --git a/e2e-tests/functions b/e2e-tests/functions
@@ -181,7 +181,8 @@ get_cr() {
 		.spec.backups.pgbackrest.image = "'$IMAGE_BACKREST'" |
 		.spec.proxy.pgBouncer.image = "'$IMAGE_PGBOUNCER'" |
 		.spec.pmm.image = "'$IMAGE_PMM_CLIENT'" |
-		.spec.pmm.secret = "'${cr_name}'-pmm-secret"
+		.spec.pmm.secret = "'${cr_name}'-pmm-secret" |
+		.spec.pmm.customClusterName = "'${cr_name}'-pmm-custom-name"
 		' $DEPLOY_DIR/cr.yaml >$TEMP_DIR/cr.yaml
 
 	if [[ $OPENSHIFT ]]; then
diff --git a/e2e-tests/tests/monitoring-pmm3/03-assert.yaml b/e2e-tests/tests/monitoring-pmm3/03-assert.yaml
@@ -39,6 +39,7 @@ spec:
     enabled: true
     secret: monitoring-pmm3-pmm-secret
     serverHost: monitoring-service
+    customClusterName: monitoring-pmm3-pmm-custom-name
   port: 5432
   proxy:
     pgBouncer:
diff --git a/e2e-tests/tests/monitoring/03-assert.yaml b/e2e-tests/tests/monitoring/03-assert.yaml
@@ -39,6 +39,7 @@ spec:
     enabled: true
     secret: monitoring-pmm-secret
     serverHost: monitoring-service
+    customClusterName: monitoring-pmm-custom-name
   port: 5432
   proxy:
     pgBouncer:
diff --git a/percona/pmm/pmm.go b/percona/pmm/pmm.go
@@ -224,15 +224,23 @@ func sidecarContainerV2(pgc *v2.PerconaPGCluster) corev1.Container {
 			},
 			{
 				Name:  "PMM_AGENT_PRERUN_SCRIPT",
-				Value: agentPrerunScript(pgc.Spec.PMM.QuerySource),
+				Value: agentPrerunScript(pgc.Spec.PMM.QuerySource, pgc),
+			},
+			{
+				Name:  "PMM_AGENT_PATHS_TEMPDIR",
+				Value: "/tmp",
 			},
 		},
 	}
 
-	if pgc.CompareVersion("2.3.0") >= 0 {
+	if pgc.CompareVersion("2.7.0") >= 0 {
+		clusterName := pgc.Name
+		if pgc.Spec.PMM.CustomClusterName != "" {
+			clusterName = pgc.Spec.PMM.CustomClusterName
+		}
 		container.Env = append(container.Env, corev1.EnvVar{
-			Name:  "PMM_AGENT_PATHS_TEMPDIR",
-			Value: "/tmp",
+			Name:  "CLUSTER_NAME",
+			Value: clusterName,
 		})
 	}
 
@@ -249,8 +257,12 @@ func sidecarContainerV3(pgc *v2.PerconaPGCluster) corev1.Container {
 	}
 
 	pmmSpec := pgc.Spec.PMM
+	clusterName := pgc.Name
+	if pgc.Spec.PMM.CustomClusterName != "" {
+		clusterName = pgc.Spec.PMM.CustomClusterName
+	}
 
-	return corev1.Container{
+	container := corev1.Container{
 		Name:            "pmm-client",
 		Image:           pmmSpec.Image,
 		ImagePullPolicy: pmmSpec.ImagePullPolicy,
@@ -412,17 +424,23 @@ func sidecarContainerV3(pgc *v2.PerconaPGCluster) corev1.Container {
 			},
 			{
 				Name:  "PMM_AGENT_PRERUN_SCRIPT",
-				Value: agentPrerunScript(pgc.Spec.PMM.QuerySource),
+				Value: agentPrerunScript(pgc.Spec.PMM.QuerySource, pgc),
 			},
 			{
 				Name:  "PMM_AGENT_PATHS_TEMPDIR",
 				Value: "/tmp",
 			},
+			{
+				Name:  "CLUSTER_NAME",
+				Value: clusterName,
+			},
 		},
 	}
+
+	return container
 }
 
-func agentPrerunScript(querySource v2.PMMQuerySource) string {
+func agentPrerunScript(querySource v2.PMMQuerySource, pgc *v2.PerconaPGCluster) string {
 	wait := "pmm-admin status --wait=10s"
 	annotate := "pmm-admin annotate --service-name=$(PMM_AGENT_SETUP_NODE_NAME) 'Service restarted'"
 
@@ -440,6 +458,12 @@ func agentPrerunScript(querySource v2.PMMQuerySource) string {
 		"--service-name=$(PMM_AGENT_SETUP_NODE_NAME)",
 		fmt.Sprintf("--query-source=%s", querySource),
 	}
+
+	if pgc.CompareVersion("2.7.0") >= 0 {
+		addServiceArgs = append(addServiceArgs,
+			"--cluster=$(CLUSTER_NAME)",
+		)
+	}
 	addService := fmt.Sprintf("pmm-admin add postgresql %s", strings.Join(addServiceArgs, " "))
 
 	return wait + "; " + addService + "; " + annotate
diff --git a/percona/pmm/pmm_test.go b/percona/pmm/pmm_test.go
@@ -150,7 +150,7 @@ func TestSidecarContainerV2(t *testing.T) {
 
 	pgc := &v2.PerconaPGCluster{
 		Spec: v2.PerconaPGClusterSpec{
-			CRVersion: "2.6.0",
+			CRVersion: "2.7.0",
 			PMM:       pmmSpec,
 		},
 		ObjectMeta: metav1.ObjectMeta{
@@ -179,7 +179,7 @@ func TestSidecarContainerV2(t *testing.T) {
 	assert.NotNil(t, container.Lifecycle.PreStop)
 	assert.Equal(t, []string{"bash", "-c", "pmm-admin unregister --force"}, container.Lifecycle.PreStop.Exec.Command)
 
-	assert.Len(t, container.Env, 31)
+	assert.Len(t, container.Env, 32)
 
 	expectedEnvVars := map[string]string{
 		"POD_NAME":                      "", // field reference is asserted separately
@@ -211,8 +211,9 @@ func TestSidecarContainerV2(t *testing.T) {
 		"DB_TYPE":                       "postgresql",
 		"DB_USER":                       v2.UserMonitoring,
 		"DB_PASS":                       "", // secret reference is asserted separately
-		"PMM_AGENT_PRERUN_SCRIPT":       "pmm-admin status --wait=10s; pmm-admin add postgresql --username=$(DB_USER) --password='$(DB_PASS)' --host=127.0.0.1 --port=5432 --tls-cert-file=/pgconf/tls/tls.crt --tls-key-file=/pgconf/tls/tls.key --tls-ca-file=/pgconf/tls/ca.crt --tls-skip-verify --skip-connection-check --metrics-mode=push --service-name=$(PMM_AGENT_SETUP_NODE_NAME) --query-source=; pmm-admin annotate --service-name=$(PMM_AGENT_SETUP_NODE_NAME) 'Service restarted'",
+		"PMM_AGENT_PRERUN_SCRIPT":       "pmm-admin status --wait=10s; pmm-admin add postgresql --username=$(DB_USER) --password='$(DB_PASS)' --host=127.0.0.1 --port=5432 --tls-cert-file=/pgconf/tls/tls.crt --tls-key-file=/pgconf/tls/tls.key --tls-ca-file=/pgconf/tls/ca.crt --tls-skip-verify --skip-connection-check --metrics-mode=push --service-name=$(PMM_AGENT_SETUP_NODE_NAME) --query-source= --cluster=$(CLUSTER_NAME); pmm-admin annotate --service-name=$(PMM_AGENT_SETUP_NODE_NAME) 'Service restarted'",
 		"PMM_AGENT_PATHS_TEMPDIR":       "/tmp",
+		"CLUSTER_NAME":                  "test-cluster",
 	}
 
 	for _, envVar := range container.Env {
@@ -290,7 +291,7 @@ func TestSidecarContainerV3(t *testing.T) {
 	assert.NotNil(t, container.Lifecycle.PreStop)
 	assert.Equal(t, []string{"bash", "-c", "pmm-admin unregister --force"}, container.Lifecycle.PreStop.Exec.Command)
 
-	assert.Len(t, container.Env, 26)
+	assert.Len(t, container.Env, 27)
 
 	expectedEnvVars := map[string]string{
 		"POD_NAME":                      "", // field reference is asserted separately
@@ -317,8 +318,9 @@ func TestSidecarContainerV3(t *testing.T) {
 		"DB_TYPE":                       "postgresql",
 		"DB_USER":                       v2.UserMonitoring,
 		"DB_PASS":                       "", // secret reference is asserted separately
-		"PMM_AGENT_PRERUN_SCRIPT":       "pmm-admin status --wait=10s; pmm-admin add postgresql --username=$(DB_USER) --password='$(DB_PASS)' --host=127.0.0.1 --port=5432 --tls-cert-file=/pgconf/tls/tls.crt --tls-key-file=/pgconf/tls/tls.key --tls-ca-file=/pgconf/tls/ca.crt --tls-skip-verify --skip-connection-check --metrics-mode=push --service-name=$(PMM_AGENT_SETUP_NODE_NAME) --query-source=; pmm-admin annotate --service-name=$(PMM_AGENT_SETUP_NODE_NAME) 'Service restarted'",
+		"PMM_AGENT_PRERUN_SCRIPT":       "pmm-admin status --wait=10s; pmm-admin add postgresql --username=$(DB_USER) --password='$(DB_PASS)' --host=127.0.0.1 --port=5432 --tls-cert-file=/pgconf/tls/tls.crt --tls-key-file=/pgconf/tls/tls.key --tls-ca-file=/pgconf/tls/ca.crt --tls-skip-verify --skip-connection-check --metrics-mode=push --service-name=$(PMM_AGENT_SETUP_NODE_NAME) --query-source= --cluster=$(CLUSTER_NAME); pmm-admin annotate --service-name=$(PMM_AGENT_SETUP_NODE_NAME) 'Service restarted'",
 		"PMM_AGENT_PATHS_TEMPDIR":       "/tmp",
+		"CLUSTER_NAME":                  "test-cluster",
 	}
 
 	for _, envVar := range container.Env {
diff --git a/pkg/apis/pgv2.percona.com/v2/perconapgcluster_types.go b/pkg/apis/pgv2.percona.com/v2/perconapgcluster_types.go
@@ -553,6 +553,9 @@ type PMMSpec struct {
 	// +kubebuilder:validation:Required
 	ServerHost string `json:"serverHost,omitempty"`
 
+	// +optional
+	CustomClusterName string `json:"customClusterName,omitempty"`
+
 	// +kubebuilder:validation:Required
 	Secret string `json:"secret,omitempty"`
 
