Added configurability of hazelcast/clusteringservice name

charts/pega/README.md

@@ -1475,6 +1475,7 @@ here: [Additional Parameters](charts/hazelcast/README.md)
 
 Parameter   | Description                                                                                                                                                                                                                                                                                                  | Default value
 ---         |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ---
+`hazelcast.deployment.name` | Name used for the hazelcast deployment. | `pega-hazelcast`
 `hazelcast.image` | Reference the `platform/clustering-service` Docker image that you downloaded and pushed to your Docker registry that your deployment can access.                                                                                                                                                             | `YOUR_HAZELCAST_IMAGE:TAG`
 `hazelcast.clusteringServiceImage` | Reference the `platform/clustering-service` Docker image that you downloaded and pushed to your Docker registry that your deployment can access.                                                                                                                                                             | `YOUR_CLUSTERING_SERVICE_IMAGE:TAG`
 `hazelcast.enabled` | Set to `true` if client-server deployment of Pega Platform is required; otherwise leave set to `false`. Note: To avoid an installation failure, you must set this value to `false` for Pega platform deployments using versions before 8.6.                                                                  | `true`
@@ -1492,6 +1493,8 @@ Parameter   | Description
 #### Example
 ```yaml
 hazelcast:
+  deployment:
+    name: "pega-hazelcast"
   image: "YOUR_HAZELCAST_IMAGE:TAG"
   clusteringServiceImage: "YOUR_CLUSTERING_SERVICE_IMAGE:TAG"
   enabled: true

charts/pega/charts/hazelcast/README.md

@@ -53,6 +53,8 @@ Name                                           | Description
 #### Example
 
 ```yaml
+deployment:
+  name: pega-hazelcast
 image: "YOUR_HAZELCAST_IMAGE:TAG"
 clusteringServiceImage: "YOUR_CLUSTERING_SERVICE_IMAGE:TAG"
 imagePullPolicy: "Always"

charts/pega/charts/hazelcast/templates/_helpers.tpl

@@ -1,9 +1,10 @@
-{{- define "hazelcastName" -}} pega-hazelcast {{- end -}}
-{{- define "hazelcastEnvironmentConfig" -}} pega-hz-env-config {{- end -}}
+{{- define "hazelcastDeploymentName" }}{{ $hazelcastDeploymentName := .defaultname }}{{ if (.root.deployment) }}{{ if (.root.deployment.name) }}{{ $hazelcastDeploymentName = .root.deployment.name }}{{ end }}{{ end }}{{ $hazelcastDeploymentName }}{{- end -}}
 
-{{- define "clusteringServiceName" -}} clusteringservice {{- end -}}
-{{- define "clusteringServiceEnvironmentConfig" -}} clusteringservice-env-config {{- end -}}
+{{- define "hazelcastName" -}}{{ include "hazelcastDeploymentName" (dict "root" .Values "defaultname" "pega-hazelcast" )}}{{- end -}}
+{{- define "hazelcastEnvironmentConfig" -}}{{include "hazelcastName" .}}-env-config {{- end -}}
 
+{{- define "clusteringServiceName" -}}{{ include "hazelcastDeploymentName" (dict "root" .Values "defaultname" "clusteringservice" )}}{{- end -}}
+{{- define "clusteringServiceEnvironmentConfig" -}}{{include "clusteringServiceName" .}}-env-config {{- end -}}
 
 {{- define "isHazelcastEnabled" }}
  {{- if .Values.enabled -}}

charts/pega/charts/hazelcast/templates/clustering-service-deployment.yaml

@@ -43,7 +43,7 @@ spec:
       {{- end }}
         envFrom:
         - configMapRef:
-            name: {{ template "clusteringServiceEnvironmentConfig" }}
+            name: {{ template "clusteringServiceEnvironmentConfig" .}}
 {{- if .Values.containerSecurityContext }}
         securityContext:
 {{ toYaml .Values.containerSecurityContext | indent 10 }}

charts/pega/charts/hazelcast/templates/clustering-service-environment-config.yaml

@@ -2,7 +2,7 @@
 kind: ConfigMap
 apiVersion: v1
 metadata:
-  name: {{ template "clusteringServiceEnvironmentConfig" }}
+  name: {{ template "clusteringServiceEnvironmentConfig" . }}
   namespace: {{ .Release.Namespace }}
 data:
   # Key Value pairs

charts/pega/charts/hazelcast/templates/pega-hz-deployment.yaml

@@ -35,7 +35,7 @@ spec:
           mountPath: "/opt/hazelcast/secrets"
         envFrom:
         - configMapRef:
-            name: {{ template "hazelcastEnvironmentConfig" }}
+            name: {{ template "hazelcastEnvironmentConfig" . }}
         resources:
           requests:
             cpu: "{{ .Values.resources.requests.cpu }}"

charts/pega/charts/hazelcast/templates/pega-hz-environment-config.yaml

@@ -2,13 +2,13 @@
 kind: ConfigMap
 apiVersion: v1
 metadata:
-  name: {{ template "hazelcastEnvironmentConfig" }}
+  name: {{ template "hazelcastEnvironmentConfig" .}}
   namespace: {{ .Release.Namespace }}
 data:
   # Key Value pairs
   NAMESPACE: {{ .Release.Namespace }}
   JAVA_OPTS: {{ .Values.server.java_opts | quote }}
-  SERVICE_NAME: {{ template "hazelcastName" }}-service
+  SERVICE_NAME: {{ template "hazelcastName" .}}-service
   MIN_CLUSTER_SIZE: {{ .Values.replicas | quote }}
 {{- if .Values.server.jmx_enabled }}
   JMX_ENABLED: {{ .Values.server.jmx_enabled | quote }}

charts/pega/charts/hazelcast/values.yaml

@@ -1,5 +1,8 @@
 ---
 image: "YOUR_HAZELCAST_IMAGE:TAG"
+# Change the name of the hazelcast deployment
+# deployment:
+#     name: "pega-hazelcast"
 clusteringServiceImage: "YOUR_CLUSTERING_SERVICE_IMAGE:TAG"
 imagePullPolicy: "Always"
 # Enter the number of initial members in Hazelcast cluster.

charts/pega/templates/_helpers.tpl

@@ -480,10 +480,11 @@ servicePort: use-annotation
 {{- end -}}
 
 {{- define "hzServiceName" -}}
+{{- $hzDict := dict "Values" .Values.hazelcast -}}
   {{- if and (not .Values.hazelcast.enabled)  .Values.hazelcast.clusteringServiceEnabled -}}
-    {{ template "clusteringServiceName" }}
+    {{ template "clusteringServiceName" $hzDict }}
   {{- else -}}
-    {{ template "hazelcastName" }}
+    {{ template "hazelcastName" $hzDict }}
   {{- end -}}
 {{- end -}}
 

terratest/src/test/pega/clustering-service-deployment_test.go

@@ -103,6 +103,47 @@ func VerifyClusteringServiceDeployment(t *testing.T, yamlContent string, ssl boo
 	}
 }
 
+func TestClusteringServiceDeploymentName(t *testing.T) {
+	var supportedVendors = []string{"k8s", "openshift", "eks", "gke", "aks", "pks"}
+	var supportedOperations = []string{"deploy", "install-deploy"}
+
+	helmChartPath, err := filepath.Abs(PegaHelmChartPath)
+	require.NoError(t, err)
+
+	for _, vendor := range supportedVendors {
+
+		for _, operation := range supportedOperations {
+
+			fmt.Println(vendor + "-" + operation)
+
+			var options = &helm.Options{
+				SetValues: map[string]string{
+					"global.provider":                    vendor,
+					"global.actions.execute":             operation,
+					"hazelcast.clusteringServiceEnabled": "true",
+					"hazelcast.deployment.name":          "clusteringservice-test",
+				},
+			}
+
+			yamlContent := RenderTemplate(t, options, helmChartPath, []string{"charts/hazelcast/templates/clustering-service-deployment.yaml"})
+			VerifyClusteringServiceDeploymentName(t, yamlContent)
+
+		}
+	}
+}
+
+func VerifyClusteringServiceDeploymentName(t *testing.T, yamlContent string) {
+	var statefulsetObj appsv1beta2.StatefulSet
+	statefulSlice := strings.Split(yamlContent, "---")
+	for index, statefulInfo := range statefulSlice {
+		if index >= 1 {
+			UnmarshalK8SYaml(t, statefulInfo, &statefulsetObj)
+			require.Equal(t, statefulsetObj.Name, "clusteringservice-test")
+			require.Equal(t, statefulsetObj.Spec.ServiceName, "clusteringservice-test-service")
+		}
+	}
+}
+
 func TestClusteringServiceDeploymentSecurityContext(t *testing.T) {
 	var supportedVendors = []string{"k8s", "openshift", "eks", "gke", "aks", "pks"}
 	var supportedOperations = []string{"deploy", "install-deploy"}

terratest/src/test/pega/clustering-service-service_test.go

@@ -1,42 +1,40 @@
 package pega
 
 import (
+	"fmt"
+	"path/filepath"
+	"strings"
+	"testing"
+
 	"github.com/gruntwork-io/terratest/modules/helm"
 	"github.com/stretchr/testify/require"
 	k8score "k8s.io/api/core/v1"
 	intstr "k8s.io/apimachinery/pkg/util/intstr"
-	"path/filepath"
-	"strings"
-	"testing"
-	"fmt"
 )
 
-
-
-func TestClusteringService(t *testing.T){
-	var supportedVendors = []string{"k8s","openshift","eks","gke","aks","pks"}
-	var supportedOperations =  []string{"deploy","install-deploy"}
+func TestClusteringService(t *testing.T) {
+	var supportedVendors = []string{"k8s", "openshift", "eks", "gke", "aks", "pks"}
+	var supportedOperations = []string{"deploy", "install-deploy"}
 
 	helmChartPath, err := filepath.Abs(PegaHelmChartPath)
 	require.NoError(t, err)
 
+	for _, vendor := range supportedVendors {
 
-	for _,vendor := range supportedVendors{
-
-		for _,operation := range supportedOperations{
+		for _, operation := range supportedOperations {
 
 			fmt.Println(vendor + "-" + operation)
 
 			var options = &helm.Options{
 				SetValues: map[string]string{
-					"global.provider":        vendor,
-					"global.actions.execute": operation,
-					"hazelcast.clusteringServiceEnabled":  "true",
+					"global.provider":                    vendor,
+					"global.actions.execute":             operation,
+					"hazelcast.clusteringServiceEnabled": "true",
 				},
 			}
 
 			yamlContent := RenderTemplate(t, options, helmChartPath, []string{"charts/hazelcast/templates/clustering-service-service.yaml"})
-			VerifyClusteringService(t,yamlContent,options)
+			VerifyClusteringService(t, yamlContent, options)
 		}
 	}
 }
@@ -55,4 +53,45 @@ func VerifyClusteringService(t *testing.T, yamlContent string, options *helm.Opt
 			require.Equal(t, intstr.FromInt(5701), clusteringServiceObj.Spec.Ports[0].TargetPort)
 		}
 	}
-}
+}
+
+func TestClusteringServiceName(t *testing.T) {
+	var supportedVendors = []string{"k8s", "openshift", "eks", "gke", "aks", "pks"}
+	var supportedOperations = []string{"deploy", "install-deploy"}
+
+	helmChartPath, err := filepath.Abs(PegaHelmChartPath)
+	require.NoError(t, err)
+
+	for _, vendor := range supportedVendors {
+
+		for _, operation := range supportedOperations {
+
+			fmt.Println(vendor + "-" + operation)
+
+			var options = &helm.Options{
+				SetValues: map[string]string{
+					"global.provider":                    vendor,
+					"global.actions.execute":             operation,
+					"hazelcast.clusteringServiceEnabled": "true",
+					"hazelcast.deployment.name":          "clustering-test",
+				},
+			}
+
+			yamlContent := RenderTemplate(t, options, helmChartPath, []string{"charts/hazelcast/templates/clustering-service-service.yaml"})
+			VerifyClusteringServiceName(t, yamlContent, options)
+		}
+	}
+}
+
+func VerifyClusteringServiceName(t *testing.T, yamlContent string, options *helm.Options) {
+	var clusteringServiceObj k8score.Service
+	serviceSlice := strings.Split(yamlContent, "---")
+	for index, serviceInfo := range serviceSlice {
+		if index >= 1 {
+			UnmarshalK8SYaml(t, serviceInfo, &clusteringServiceObj)
+			require.Equal(t, "clustering-test-service", clusteringServiceObj.Name)
+			require.Equal(t, "Hazelcast", clusteringServiceObj.Spec.Selector["component"])
+			require.Equal(t, "clustering-test", clusteringServiceObj.Spec.Selector["app"])
+		}
+	}
+}

terratest/src/test/pega/pega-hz-deployment_test.go

@@ -65,6 +65,47 @@ func VerifyHazelcastDeployment(t *testing.T, yamlContent string) {
 	}
 }
 
+func TestHazelcastDeploymentName(t *testing.T) {
+	var supportedVendors = []string{"k8s", "openshift", "eks", "gke", "aks", "pks"}
+	var supportedOperations = []string{"deploy", "install-deploy"}
+
+	helmChartPath, err := filepath.Abs(PegaHelmChartPath)
+	require.NoError(t, err)
+
+	for _, vendor := range supportedVendors {
+
+		for _, operation := range supportedOperations {
+
+			var options = &helm.Options{
+				SetValues: map[string]string{
+					"global.provider":           vendor,
+					"global.actions.execute":    operation,
+					"hazelcast.enabled":         "true",
+					"hazelcast.deployment.name": "hz-test",
+				},
+			}
+
+			yamlContent := RenderTemplate(t, options, helmChartPath, []string{"charts/hazelcast/templates/pega-hz-deployment.yaml"})
+			VerifyHazelcastDeploymentName(t, yamlContent)
+
+		}
+	}
+}
+
+func VerifyHazelcastDeploymentName(t *testing.T, yamlContent string) {
+	var statefulsetObj appsv1beta2.StatefulSet
+	statefulSlice := strings.Split(yamlContent, "---")
+	for index, statefulInfo := range statefulSlice {
+		if index >= 1 {
+			UnmarshalK8SYaml(t, statefulInfo, &statefulsetObj)
+			require.Equal(t, statefulsetObj.Name, "hz-test")
+			require.Equal(t, statefulsetObj.Spec.ServiceName, "hz-test-service")
+			statefulsetSpec := statefulsetObj.Spec.Template.Spec
+			require.Equal(t, statefulsetSpec.Volumes[1].Projected.Sources[0].Secret.Name, "pega-hz-secret")
+		}
+	}
+}
+
 func TestHazelcastDeploymentWithPodAffinity(t *testing.T) {
 	var supportedVendors = []string{"k8s", "openshift", "eks", "gke", "aks", "pks"}
 	var supportedOperations = []string{"deploy", "install-deploy"}