Ui integration

charts/pega/charts/constellation/Chart.yaml

@@ -0,0 +1,6 @@
+---
+apiVersion: v1
+name: cosmosUI
+version: 0.0.1
+description: Pega Constellation UI service
+appVersion: 8.5.0

charts/pega/charts/constellation/templates/clln-deployment.yaml

@@ -0,0 +1,34 @@
+#Deploy only when the cosmosUI flag has been enabled in the values yaml.
+{{ if and .Values.enabled (eq .Values.enabled true) }}
+kind: Deployment
+apiVersion: apps/v1
+metadata:
+  name: cosmosUI
+  labels:
+    app: cosmosUI
+    # component: cosmosUI
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: cosmosUI
+      # component: cosmosUI
+  template:
+    metadata:
+      labels:
+        app: cosmosUI
+        # component: cosmosUI
+    spec:
+      imagePullSecrets:
+      - name: {{ template "pegaRegistrySecret" }}
+      containers:
+      - name: cosmosUIUI
+        imagePullPolicy: {{ .Values.imagePullPolicy }}
+        image: {{ .Values.image }}
+        args:
+        - port=3000
+        - sync=true
+        - {{ .Values.logLevel }}
+        ports:
+        - containerPort: 3000
+{{ end }}

charts/pega/charts/constellation/templates/clln-service.yaml

@@ -0,0 +1,19 @@
+#Deploy only when the cosmosUI flag has been enabled in the values yaml.
+{{ if and .Values.enabled (eq .Values.enabled true) }}
+apiVersion: v1
+kind: Service
+metadata:
+  name: cosmosUI
+  labels:
+    app: cosmosUI
+    # component: cosmosUI
+spec:
+  selector:
+    app: cosmosUI
+    # component: cosmosUI
+  ports:
+  - protocol: TCP
+    port: 3000
+    targetPort: 3000
+  type: NodePort
+{{ end }}

charts/pega/charts/constellation/values.yaml

@@ -0,0 +1,7 @@
+---
+# Parameters for Constellation operation:
+# Docker repos and tag for image
+image: IMAGE_REPO_URL_HERE
+# log level : error, warn, info, debug.  use error for production
+logLevel: info
+enabled: false

charts/pega/templates/_pega-deployment.tpl

@@ -90,6 +90,10 @@ spec:
         - name: REQUESTOR_PASSIVATION_TIMEOUT
           value: "{{ .node.requestor.passivationTimeSec }}"
 {{- end }}
+{{ if and .root.Values.cosmosUI (eq .root.Values.cosmosUI.enabled true) }}
+        - name: COSMOS_SETTINGS
+          value: "{{ .node.cosmosUISettings }}"
+{{- end }}
 {{- if .custom }}
 {{- if .custom.env }}
         # Additional custom env vars

charts/pega/templates/_pega-eks-ingress.tpl

@@ -52,9 +52,15 @@ spec:
   # To access the below service, along with {{ .node.domain }}, alb http port also has to be provided in the URL.
   - host: {{ template "domainName" dict "node" .node }}
     http:
-      paths:
-      - backend:
-          serviceName: {{ .name }}
+      paths: 
+      {{ if and .root.Values.cosmosUI (eq .root.Values.cosmosUI.enabled true) }}
+      - path: /prweb/cosmosUI     
+        backend:
+          serviceName: cosmosUI
+          servicePort: 3000
+      {{ end }}
+      - backend: 
+          serviceName: {{ .name }} 
           servicePort: {{ .node.service.port }}
 ---
 {{- end }}

charts/pega/templates/_pega-gke-ingress.tpl

@@ -37,9 +37,15 @@ spec:
   # To access the below service, along with {{ .node.domain }}, http/https port also has to be provided in the URL.
   - host: {{ template "domainName" dict "node" .node }}
     http:
-      paths:
-      - backend:
-          serviceName: {{ .name }}
+      paths: 
+      {{ if and .root.Values.cosmosUI (eq .root.Values.cosmosUI.enabled true) }}
+      - path: /prweb/cosmosUI     
+        backend:
+          serviceName: cosmosUI
+          servicePort: 3000
+      {{ end }}
+      - backend: 
+          serviceName: {{ .name }} 
           servicePort: {{ .node.service.port }}
 ---
 {{- end }}

charts/pega/templates/_pega-k8s-ingress.tpl

@@ -25,9 +25,15 @@ spec:
   # To access the below service, along with {{ .node.domain }}, traefik http port also has to be provided in the URL.
   - host: {{ template "domainName" dict "node" .node }}
     http:
-      paths:
-      - backend:
-          serviceName: {{ .name }}
+      paths: 
+      {{ if and .root.Values.cosmosUI (eq .root.Values.cosmosUI.enabled true) }}
+      - path: /prweb/cosmosUI     
+        backend:
+          serviceName: cosmosUI
+          servicePort: 3000
+      {{ end }}
+      - backend: 
+          serviceName: {{ .name }} 
           servicePort: {{ .node.service.port }}
 ---     
 {{- end }}

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

@@ -40,4 +40,6 @@ data:
   CASSANDRA_NODES: "{{ include "cassandraNodes" . }}"
   # Port to connect to cassandra with
   CASSANDRA_PORT: "{{ .Values.dds.port }}"
+  # Pass cosmosUI URL as a Dynamic System Setting property of Pega Infinity.
+  COSMOS_SETTINGS: "Pega-UIEngine/CosmosServicesURI=/prweb/cosmosUI"
 {{ end }}

charts/pega/values-large.yaml

@@ -101,9 +101,11 @@ global:
           # For GKE to use static IP for load balancer, use kubernetes.io/ingress.global-static-ip-name: <global-static-ip-name>
           ssl_annotation:
 
+
       replicas: 1
+      # Pass the cosmosUI url as a Dynamic System Setting to the infinity. Added only when Constellation is enabled.
+      cosmosUISettings: "Pega-UIEngine/CosmosServicesURI=/prweb/cosmosUI"
       javaOpts: ""
-
       pegaDiagnosticUser: ""
       pegaDiagnosticPassword: ""
 
@@ -256,3 +258,9 @@ installer:
     upgradeType: "in-place"
     # Specify target rules schema for migration and upgrade
     targetRulesSchema: ""
+
+# Pega Constellation UI settings.
+# Note : This node is for cosmosUI service whose purpose is to serve static content to applications.
+# This is a feature currently under development and is to be used only with Pega versions 8.5 and above.
+cosmosUI:
+  enabled: false

charts/pega/values-minimal.yaml

@@ -77,6 +77,8 @@ global:
       memRequest: "5Gi"
       cpuLimit: 2
       memLimit: "6Gi"
+      # Pass the cosmosUI url as a Dynamic System Setting to the infinity. Added only when Constellation is enabled.
+      cosmosUISettings: "Pega-UIEngine/CosmosServicesURI=/prweb/cosmosUI"
       javaOpts: ""
       initialHeap: "4096m"
       maxHeap: "4096m"
@@ -113,3 +115,9 @@ pegasearch:
 installer:
   image: "YOUR_INSTALLER_IMAGE:TAG"
   adminPassword: "ADMIN_PASSWORD"
+
+# Pega Constellation UI settings.
+# Note : This node is for cosmosUI service whose purpose is to serve static content to applications.
+# This is a feature currently under development and is to be used only with Pega versions 8.5 and above.
+cosmosUI:
+  enabled: false

charts/pega/values.yaml

@@ -96,8 +96,9 @@ global:
           # ssl_annotation:
 
       replicas: 1
+      # Pass the cosmosUI url as a Dynamic System Setting to the infinity. Added only when Constellation is enabled.
+      cosmosUISettings: "Pega-UIEngine/CosmosServicesURI=/prweb/cosmosUI"
       javaOpts: ""
-
       pegaDiagnosticUser: ""
       pegaDiagnosticPassword: ""
 
@@ -213,3 +214,9 @@ installer:
     upgradeType: "in-place"
     # Specify target rules schema for migration and upgrade
     targetRulesSchema: ""
+
+# Pega Constellation UI settings.
+# Note : This node is for cosmosUI service whose purpose is to serve static content to applications.
+# This is a feature currently under development and is to be used only with Pega versions 8.5 and above.
+cosmosUI:
+  enabled: false

terratest/src/test/pega/deploy_with_constellation_test.go

@@ -0,0 +1,29 @@
+package pega
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/gruntwork-io/terratest/modules/helm"
+	"github.com/stretchr/testify/require"
+)
+
+// set action execute to install
+var cosmosUI_options = &helm.Options{
+	SetValues: map[string]string{
+		"global.provider":        "k8s",
+		"global.actions.execute": "deploy",
+		"cosmosUI.enabled":  "true",
+	},
+}
+
+// TestPegaStandardTierDeployment - Test case to verify the standard pega tier deployment.
+// Standard tier deployment includes web deployment, batch deployment, stream statefulset, search service, hpa, rolling update, web services, ingresses and config maps
+func TestPegaStandardTierDeploymentWithConstellation(t *testing.T) {
+	t.Parallel()
+	// Path to the helm chart we will test
+	helmChartPath, err := filepath.Abs(PegaHelmChartPath)
+	require.NoError(t, err)
+
+	VerifyPegaStandardTierDeployment(t, helmChartPath, cosmosUI_options, []string{"wait-for-pegasearch", "wait-for-cassandra"})
+}

terratest/src/test/pega/deployment_utility.go

@@ -48,6 +48,11 @@ func VerifyPegaStandardTierDeployment(t *testing.T, helmChartPath string, option
 	// Verify search service
 	VerifySearchService(t, helmChartPath, options)
 
+	if options.SetValues["cosmosUI.enabled"] == "true" {
+		// Verify cosmosUI service
+		VerifyConstellationService(t, helmChartPath, options)
+	}
+
 	// Verfiy Pega deployed services
 	SplitAndVerifyPegaServices(t, helmChartPath, options)
 
@@ -123,6 +128,17 @@ func VerifyDeployment(t *testing.T, pod *k8score.PodSpec, expectedSpec pegaDeplo
 		require.Equal(t, pod.Containers[0].Env[envIndex].Name, "REQUESTOR_PASSIVATION_TIMEOUT")
 		require.Equal(t, expectedSpec.passivationTimeout, pod.Containers[0].Env[envIndex].Value)
 	}
+	if options.SetValues["cosmosUI.enabled"] == "true" && expectedSpec.name == "pega-web" {
+		envIndex++
+		require.Equal(t, pod.Containers[0].Env[envIndex].Name, "COSMOS_SETTINGS")
+		require.Equal(t, "Pega-UIEngine/CosmosServicesURI=/prweb/cosmosUI", pod.Containers[0].Env[envIndex].Value)
+	}
+
+	if options.SetValues["cosmosUI.enabled"] == "true" && expectedSpec.name != "pega-web" {
+		envIndex++
+		require.Equal(t, pod.Containers[0].Env[envIndex].Name, "COSMOS_SETTINGS")
+		require.Equal(t, "", pod.Containers[0].Env[envIndex].Value)
+	}
 	envIndex++
 	require.Equal(t, pod.Containers[0].Env[envIndex].Name, "JAVA_OPTS")
 	require.Equal(t, pod.Containers[0].Env[envIndex].Value, "")
@@ -277,6 +293,14 @@ func VerifyPegaIngress(t *testing.T, ingressObj *k8sv1beta1.Ingress, expectedIng
 		VerifyGKEIngress(t, ingressObj, expectedIngress)
 	} else if provider == "aks" {
 		VerifyAKSIngress(t, ingressObj, expectedIngress)
+	} else if provider != "eks" && options.SetValues["cosmosUI.enabled"] == "false" {
+		VerifyK8SIngress(t, ingressObj, expectedIngress)
+	} else if provider != "aks" && options.SetValues["cosmosUI.enabled"] == "false" {
+		VerifyAKSIngress(t, ingressObj, expectedIngress)
+	} else if provider != "gke" && options.SetValues["cosmosUI.enabled"] == "false" {
+		VerifyGKEIngress(t, ingressObj, expectedIngress)
+	} else if options.SetValues["cosmosUI.enabled"] == "true" {
+		VerifyK8SIngressWithConstellationEnabled(t, ingressObj, expectedIngress)
 	} else {
 		VerifyK8SIngress(t, ingressObj, expectedIngress)
 	}
@@ -321,6 +345,21 @@ func VerifyK8SIngress(t *testing.T, ingressObj *k8sv1beta1.Ingress, expectedIngr
 	require.Equal(t, expectedIngress.Port, ingressObj.Spec.Rules[0].HTTP.Paths[0].Backend.ServicePort)
 }
 
+// VerifyPegaIngressWithConstellationEnabled - Performs Pega Ingress assertions with the values as provided in default values.yaml when the cosmosUI service is enabled.
+func VerifyK8SIngressWithConstellationEnabled(t *testing.T, ingressObj *k8sv1beta1.Ingress, expectedIngress pegaIngress) {
+	if ingressObj.Spec.Rules[0].HTTP.Paths[0].Backend.ServiceName == "cosmosUI" {
+		require.Equal(t, "traefik", ingressObj.Annotations["kubernetes.io/ingress.class"])
+		require.Equal(t, "/prweb/cosmosUI", ingressObj.Spec.Rules[0].HTTP.Paths[0].Path)
+		require.Equal(t, "cosmosUI", ingressObj.Spec.Rules[0].HTTP.Paths[0].Backend.ServiceName)
+		require.Equal(t, intstr.FromInt(3000), ingressObj.Spec.Rules[0].HTTP.Paths[0].Backend.ServicePort)
+		require.Equal(t, expectedIngress.Name, ingressObj.Spec.Rules[0].HTTP.Paths[1].Backend.ServiceName)
+		require.Equal(t, expectedIngress.Port, ingressObj.Spec.Rules[0].HTTP.Paths[1].Backend.ServicePort)
+	} else {
+		require.Equal(t, expectedIngress.Name, ingressObj.Spec.Rules[0].HTTP.Paths[0].Backend.ServiceName)
+		require.Equal(t, expectedIngress.Port, ingressObj.Spec.Rules[0].HTTP.Paths[0].Backend.ServicePort)
+	}
+}
+
 // VerifySearchService - Verifies search service deployment used by search pod with the values as provided in default values.yaml
 func VerifySearchService(t *testing.T, helmChartPath string, options *helm.Options) {
 
@@ -334,6 +373,18 @@ func VerifySearchService(t *testing.T, helmChartPath string, options *helm.Optio
 	require.Equal(t, searchServiceObj.Spec.Ports[0].TargetPort, intstr.FromInt(9200))
 }
 
+// VerifyConstellationService - Verifies cosmosUI service deployment used by cosmosUI pod with the values as provided in default values.yaml
+func VerifyConstellationService(t *testing.T, helmChartPath string, options *helm.Options) {
+
+	cosmosUIService := helm.RenderTemplate(t, options, helmChartPath, []string{"charts/cosmosUI/templates/clln-service.yaml"})
+	var cosmosUIServiceObj k8score.Service
+	helm.UnmarshalK8SYaml(t, cosmosUIService, &cosmosUIServiceObj)
+	require.Equal(t, cosmosUIServiceObj.Spec.Selector["app"], "cosmosUI")
+	// require.Equal(t, cosmosUIServiceObj.Spec.Ports[0].Protocol, "TCP")
+	require.Equal(t, cosmosUIServiceObj.Spec.Ports[0].Port, int32(3000))
+	require.Equal(t, cosmosUIServiceObj.Spec.Ports[0].TargetPort, intstr.FromInt(3000))
+}
+
 // VerifyEnvironmentConfig - Verifies the environment configuration used by the pods with the values as provided in default values.yaml
 func VerifyEnvironmentConfig(t *testing.T, helmChartPath string, options *helm.Options) {