BUG-861291 syncing values.yaml with values-large.yaml (#745)

Co-authored-by: locoe <Evan.Loconto@pega.com>
pegasystems · May 17, 2024 · 7630516 · 7630516
1 parent 6f14e1f
commit 7630516
Show file tree

Hide file tree

Showing 2 changed files with 146 additions and 13 deletions.
diff --git a/charts/pega/values-large.yaml b/charts/pega/values-large.yaml
@@ -1,8 +1,7 @@
 ---
 global:
-  # This values.yaml file is an example of a large Pega deployment.
-  # For more information about each configuration option, see the
-  # project readme.
+  # This values.yaml file is an example.  For more information about
+  # each configuration option, see the project readme.
 
   # Enter your Kubernetes provider.
   provider: "YOUR_KUBERNETES_PROVIDER"
@@ -17,12 +16,13 @@ global:
   # Deploy Pega nodes
   actions:
     execute: "deploy"
+
   # Add custom certificates to be mounted to container
   # to support custom certificates as plain text (less secure), pass them directly using the certificates parameter;
   # to support multiple custom certificates as external secrets, specify each of your external secrets
   # as an array of comma-separated strings using the certificatesSecrets parameter.
   certificatesSecrets: []
-  certificates:
+  certificates: {}
 
   # Add krb5.conf file content here.
   # Feature is used for Decisioning data flows to fetch data from Kafka or HBase streams
@@ -124,6 +124,10 @@ global:
       serviceHost: "API_SERVICE_ADDRESS"
       httpsServicePort: "SERVICE_PORT_HTTPS"
 
+  # Set the `compressedConfigurations` parameter to `true` when the configuration files under charts/pega/config/deploy are in compressed format.
+  # For more information, see the “Pega compressed configuration files” section in the Pega Helm chart documentation.
+  compressedConfigurations: false
+
   pegaDiagnosticUser: ""
   pegaDiagnosticPassword: ""
 
@@ -140,19 +144,39 @@ global:
         # Inactivity time after which requestor is passivated
         passivationTimeSec: 900
 
+
       service:
         # For help configuring the service block, see the Helm chart documentation
         # https://github.com/pegasystems/pega-helm-charts/blob/master/charts/pega/README.md#service
         httpEnabled: true
         port: 80
         targetPort: 8080
+        # Use this parameter to deploy a specific type of service using the serviceType parameter and specify the type of service in double quotes.
+        # This is an optional value and should be used based on the use case.
+        # This should be set only in case of eks, gke and other cloud providers. This option should not be used for k8s and minikube.
+        # For example if you want to deploy a service of type LoadBalancer, uncomment the following line and specify serviceType: "LoadBalancer"
+        # serviceType: ""
+        # Specify the CIDR ranges to restrict the service access to the given CIDR range.
+        # Each new CIDR block should be added in a separate line.
+        # Should be used only when serviceType is set to LoadBalancer.
+        # Uncomment the following lines and replace the CIDR blocks with your configuration requirements.
+        # loadBalancerSourceRanges:
+        #     - "123.123.123.0/24"
+        #     - "128.128.128.64/32"
         # To configure TLS between the ingress/load balancer and the backend, set the following:
         tls:
           enabled: false
           # To avoid entering the certificate values in plain text, configure the keystore, keystorepassword, cacertificate parameter
           # values in the External Secrets Manager, and enter the external secret name below
           # make sure the keys in the secret should be TOMCAT_KEYSTORE_CONTENT, TOMCAT_KEYSTORE_PASSWORD and ca.crt respectively
-          external_secret_name: ""
+          # In case of providing multiple secrets, please provide them in comma separated string format.
+          external_secret_names: []
+          # If using tools like cert-manager to generate certificates, please provide the keystore name that is autogenerated by the external tool.
+          # Default is TOMCAT_KEYSTORE_CONTENT
+          external_keystore_name: ""
+          # If using external secrets operator and not using standard Password Key, please provide the key for keystore password.
+          # Default is TOMCAT_KEYSTORE_PASSWORD
+          external_keystore_password: ""
           keystore:
           keystorepassword:
           port: 443
@@ -173,7 +197,7 @@ global:
 
       ingress:
         enabled: true
-        # For help configuring the ingress block, see the Helm chart documentation
+        # For help configuring the ingress block including TLS, see the Helm chart documentation
         # https://github.com/pegasystems/pega-helm-charts/blob/master/charts/pega/README.md#ingress
 
         # Enter the domain name to access web nodes via a load balancer.
@@ -201,7 +225,6 @@ global:
           key:
           cacertificate:
 
-
       replicas: 1
       javaOpts: ""
       # Check the 'JVM Arguments' section in https://github.com/pegasystems/pega-helm-charts/blob/master/charts/pega/README.md
@@ -216,6 +239,23 @@ global:
       livenessProbe:
         port: 8081
 
+      # Optionally overridde default resource specifications
+      # cpuRequest: 2
+      # memRequest: "12Gi"
+      # cpuLimit: 4
+      # memLimit: "12Gi"
+      # initialHeap: "4096m"
+      # maxHeap: "8192m"
+      # ephemeralStorageRequest:
+      # ephemeralStorageLimit:
+
+      # To configure an alternative user for custom image, set value for runAsUser.
+      # To configure an alternative group for volume mounts, set value for fsGroup
+      # See, https://github.com/pegasystems/pega-helm-charts/blob/master/charts/pega/README.md#security-context
+      # securityContext:
+      #   runAsUser: 9001
+      #   fsGroup: 0
+
       hpa:
         enabled: true
         # To configure behavior specifications for hpa, set the required scaleUp & scaleDown values.
@@ -262,6 +302,13 @@ global:
       livenessProbe:
         port: 8081
 
+      # To configure an alternative user for your custom image, set value for runAsUser
+      # To configure an alternative group for volume mounts, set value for fsGroup
+      # See, https://github.com/pegasystems/pega-helm-charts/blob/master/charts/pega/README.md#security-context
+      # securityContext:
+      #   runAsUser: 9001
+      #   fsGroup: 0
+
       hpa:
         enabled: true
 
@@ -278,7 +325,7 @@ global:
       # as a stateful set to ensure durability of queued data. It may
       # be optionally exposed to the load balancer.
       # Note: Stream tier is deprecated, please enable externalized Kafka service configuration under External Services.
-      # When your Pega Platform deployment uses an externalize Kafka configuration, your deployment no longer uses the "Stream" node type.
+      # When externalized Kafka service is enabled, we should remove the entire stream tier.
       nodeType: "Stream"
 
       # Pega requestor specific properties
@@ -290,12 +337,17 @@ global:
         port: 7003
         targetPort: 7003
 
+      # If a nodeSelector is required for this or any tier, it may be specified here:
+      # nodeSelector:
+      #  disktype: ssd
+
       ingress:
         enabled: true
         # Enter the domain name to access web nodes via a load balancer.
         #  e.g. web.mypega.example.com
         domain: "YOUR_STREAM_NODE_DOMAIN"
         tls:
+          # Enable TLS encryption
           enabled: true
           # Give the name of the secret that contains certificate information - works for GKE, AKS and K8S
           secretName:
@@ -313,6 +365,13 @@ global:
       livenessProbe:
         port: 8081
 
+      # To configure an alternative user for your custom image, set value for runAsUser
+      # To configure an alternative group for volume mounts, set value for fsGroup
+      # See, https://github.com/pegasystems/pega-helm-charts/blob/master/charts/pega/README.md#security-context
+      # securityContext:
+      #   runAsUser: 9001
+      #   fsGroup: 0
+
       volumeClaimTemplate:
         resources:
           requests:
@@ -398,6 +457,8 @@ cassandra:
 
 # DDS (external Cassandra) connection settings.
 # These settings should only be modified if you are using a custom Cassandra deployment.
+# To deploy Pega without Cassandra, comment out or delete the following dds section and set
+# the cassandra.enabled property above to false.
 dds:
   # A comma separated list of hosts in the Cassandra cluster.
   externalNodes: ""
@@ -407,17 +468,87 @@ dds:
   username: "dnode_ext"
   # The password for authentication with the Cassandra cluster.
   password: "dnode_ext"
+  # Whether to enable client encryption on the Cassandra connection.
+  clientEncryption: false
+  # If required, provide the trustStore certificate file name.
+  # When using a trustStore certificate, you must also include a Kubernetes secret name that contains the trustStore certificate in the global.certificatesSecrets parameter.
+  # Pega deployments only support trustStores using the Java Key Store (.jks) format.
+  trustStore: ""
+  # If required provide trustStorePassword value in plain text.
+  trustStorePassword: ""
+  # If required, provide the keystore certificate file name.
+  # When using a keystore certificate, you must also include a Kubernetes secret name that contains the keystore certificate in the global.certificatesSecrets parameter.
+  # Pega deployments only support keystore using the Java Key Store (.jks) format.
+  keyStore: ""
+  # If required provide keyStorePassword value in plain text.
+  keyStorePassword: ""
   # To avoid exposing username,password,trustStorePassword,keyStorePassword parameters, configure the
   # username,password,trustStorePassword,keyStorePassword parameters in External Secrets Manager, and enter the external secret for the credentials
   # make sure the keys in the secret should be CASSANDRA_USERNAME, CASSANDRA_PASSWORD , CASSANDRA_TRUSTSTORE_PASSWORD , CASSANDRA_KEYSTORE_PASSWORD
   external_secret_name: ""
+  # Enable asynchronous processing of records in DDS Dataset save operation. Failures to store individual records will
+  # not interrupt Dataset save operations.
+  asyncProcessingEnabled: false
+  # Specify a prefix to use when creating Pega-managed keyspaces in Cassandra.
+  keyspacesPrefix: ""
+  # Enable an extended token aware policy for use when a Cassandra range query runs. When enabled this policy selects a
+  # token from the token range to determine which Cassandra node to send the request. Before you can enable this policy,
+  # you must configure the token range partitioner.
+  extendedTokenAwarePolicy: false
+  # Enable a latency awareness policy, which collects the latencies of the queries for each Cassandra node and maintains
+  # a per-node latency score (an average).
+  latencyAwarePolicy: false
+  # Enable the use of a customized retry policy for your Pega Platform deployment. After enabling this policy in your
+  # deployment configuration, Cassandra queries that timeout will be retried. The number of retries may be configured
+  # using the dynamic system setting (DSS): dnode/cassandra_custom_retry_policy/retryCount. If not configured, queries
+  # will be retried once.
+  customRetryPolicy: false
+  # Enable the use of a customized retry policy for your Pega Platform deployment for Pega Platform ’23 and earlier
+  # releases. After you enable this policy in your deployment configuration, the deployment retries Cassandra queries
+  # that time out. Configure the number of retries using the dynamic system setting (DSS):
+  # dnode/cassandra_custom_retry_policy/retryCount. The default is 1, so if you do not specify a retry count, timed out
+  # queries are retried once.
+  customRetryPolicyEnabled: false
+  # Use this parameter in Pega Platform '24 and later instead of `customRetryPolicy`. Configure the number of retries
+  # using the `customRetryPolicyCount` property.
+  customRetryPolicyCount: 1
+  # Specify the number of retry attempts when `customRetryPolicyEnabled` is true. For Pega Platform '23 and earlier
+  # releases use the dynamic system setting (DSS): dnode/cassandra_custom_retry_policy/retryCount.
+  speculativeExecutionPolicy: false
+  # Enable the speculative execution policy for retrieving data from your Cassandra service for Pega Platform '23 and
+  # earlier releases. When enabled, Pega Platform sends a query to multiple nodes in your Cassandra service and
+  # processes the first response. This provides lower perceived latencies for your deployment, but puts greater load
+  # on your Cassandra service. Configure the speculative execution delay and max executions using the following dynamic
+  # system settings (DSS): dnode/cassandra_speculative_execution_policy/delay and
+  # dnode/cassandra_speculative_execution_policy/max_executions.
+  speculativeExecutionPolicyEnabled: false
+  # Use this parameter in Pega Platform '24 and later instead of `speculativeExecutionPolicy`. Configure the
+  # speculative execution delay and max executions using the `speculativeExecutionPolicyDelay` and
+  # `speculativeExecutionPolicyMaxExecutions` properties.
+  speculativeExecutionPolicyDelay: 100
+  # Specify the delay in milliseconds before speculative executions are made when `speculativeExecutionPolicyEnabled` is
+  # true. For Pega Platform '23 and earlier releases use the dynamic system setting (DSS):
+  # dnode/cassandra_speculative_execution_policy/delay.
+  speculativeExecutionPolicyMaxExecutions: 2
+  # Specify the maximum number of speculative execution attempts when `speculativeExecutionPolicyEnabled` is true. For
+  # Pega Platform '23 and earlier releases use the dynamic system setting (DSS):
+  # dnode/cassandra_speculative_execution_policy/max_executions.
+  jmxMetricsEnabled: true
+  # Enable reporting of DDS SDK metrics to a Comma Separated Value (CSV) format for use by your organization to monitor
+  # your Cassandra service. If you enable this property, use the Pega Platform DSS:
+  # dnode/ddsclient/metrics/csv_directory to customize the filepath to which the deployment writes CSV files. By
+  # default, after you enable this property, CSV files will be written to the Pega Platform work directory.
+  csvMetricsEnabled: false
+  # Enable reporting of DDS SDK metrics to your Pega Platform logs.
+  logMetricsEnabled: false
 
 # Elasticsearch deployment settings.
 # Note: This Elasticsearch deployment is used for Pega search, and is not the same Elasticsearch deployment used by the EFK stack.
 # These search nodes will be deployed regardless of the Elasticsearch configuration above.
 pegasearch:
   image: "pegasystems/search"
   memLimit: "3Gi"
+  replicas: 1
 
   # Set externalSearchService to true to use the Search and Reporting Service.
   # Refer to the README document to configure SRS as a search functionality provider under this section.
@@ -431,9 +562,11 @@ pegasearch:
     privateKey: ""
     external_secret_name: ""
 
-# Pega Installer settings
+# Pega Installer settings.
 installer:
   image: "YOUR_INSTALLER_IMAGE:TAG"
+  # Set the initial administrator@pega.com password for your installation.  This will need to be changed at first login.
+  # The adminPassword value cannot start with "@".
   adminPassword: "ADMIN_PASSWORD"
   # Upgrade specific properties
   upgrade:
@@ -457,11 +590,11 @@ hazelcast:
   # Hazelcast docker image for platform version 8.8 and later
   clusteringServiceImage: "YOUR_CLUSTERING_SERVICE_IMAGE:TAG"
 
-  # Setting below to true will deploy the infinity in client-server Hazelcast model.
-  # Note: Make sure to set this value as "false" in case of platform version below "8.6". If not set this will fail the installation.
+  # Setting below to true will deploy Pega Platform using a client-server Hazelcast model for version 8.6 through 8.7.x.
+  # Note: Make sure to set this value as "false" in case of Pega Platform version before "8.6". If not set this will fail the installation.
   enabled: true
 
-  # Setting up for Pega 8.8 and above fresh install and for HZ upgrade
+  # Setting below to true will deploy Pega Platform using a client-server Hazelcast model for version 8.8 and later.
   clusteringServiceEnabled: false
 
   # Setting related to Hazelcast migration.

diff --git a/charts/pega/values.yaml b/charts/pega/values.yaml
@@ -56,7 +56,7 @@ global:
     username: "YOUR_JDBC_USERNAME"
     password: "YOUR_JDBC_PASSWORD"
     # To avoid exposing username & password, leave the jdbc.password & jdbc.username parameters empty (no quotes),
-    # configure  JDBC username & password parameters in the External Secrets Manager, and enter the external secret for the credentials
+    # configure JDBC username & password parameters in the External Secrets Manager, and enter the external secret for the credentials
     # make sure the keys in the secret should be DB_USERNAME and DB_PASSWORD respectively
     external_secret_name: ""
     # CUSTOM CONNECTION PROPERTIES