CNE GCP Ready: Helm Values Reference

Helm uses YAML for configuration. This reference describes the default values for the Liferay Helm chart when deploying on Google Cloud Platform (GCP).

The following YAML shows the available values and their defaults for the core Liferay deployment.

Core Liferay Values

affinity: {}                    # Set Liferay DXP StatefulSet spec affinity field
annotations: {}                 # Set Liferay DXP StatefulSet metadata annotations field
autoscaling:                    # Built-in autoscaling configuration
   annotations: {}              # Set HorizontalPodAutoscaler metadata annotations field
   behavior: {}                 # Set HorizontalPodAutoscaler spec behavior field
   enabled: false               # Enable/disable templating of HorizontalPodAutoscaler manifest
   maxReplicas: 100             # Set HorizontalPodAutoscaler spec maxReplicas field
   metrics: {}                  # Set HorizontalPodAutoscaler spec metrics field
   minReplicas: 1               # Set HorizontalPodAutoscaler spec minReplicas field
configmap:                      # Central ConfigMap configuration
   annotations: {}              # Set central ConfigMap metadata annotations
   data: {}                     # Set central ConfigMap spec data
   overrideDefaults: false      # If true, excludes default spec data hard-coded in templates/configmap.yaml manifest
customEnv: {}                   # Set Liferay DXP StatefulSet spec template spec containers env field using YAML mapping
customEnvFrom: {}               # Set Liferay DXP StatefulSet spec template spec containers envFrom field using YAML mapping
customInitContainers: {}        # Set Liferay DXP StatefulSet spec template spec initContainers field using YAML mapping
customLabels: {}                # Set Liferay DXP StatefulSet metadata labels field using YAML mapping
customPorts: {}                 # Set Liferay DXP StatefulSet spec template spec containers ports field using YAML mapping
customPullSecrets: {}           # Set Liferay DXP StatefulSet spec template spec containers imagePullSecrets field using YAML mapping
customServicePorts: {}          # Set Liferay DXP Service spec ports field using YAML mapping
customVolumeClaimTemplates: {}  # Set Liferay DXP StatefulSet spec volumeClaimTemplates field using YAML mapping
customVolumeMounts: {}          # Set Liferay DXP StatefulSet spec template spec containers volumeMounts field using YAML mapping
customVolumes: {}               # Set Liferay DXP StatefulSet spec template spec volumes field using YAML mapping
dependencies: {}                # Set external service dependencies which should become ready before starting Liferay DXP
env: []                         # Set Liferay DXP StatefulSet spec template spec containers env field
envFrom: []                     # Set Liferay DXP StatefulSet spec template spec containers envFrom field
fullnameOverride: ""            # Override the liferay.fullname value used in the helper template
image:                          # Set Liferay DXP StatefulSet spec template spec containers image field
   repository:                  # Image repository (required)
   tag:                         # Image tag (required)
ingress:                        # Liferay DXP Ingress configuration
   annotations: {}              # Set Liferay DXP Ingress metadata annotations field
   className: ""                # Set Liferay DXP Ingress spec ingressClassName field
   enabled: false               # Enable/disable templating of Liferay DXP Ingress manifest
   rules: []                    # Set Liferay DXP Ingress spec rules field
   tls: []                      # Set Liferay DXP Ingress spec tls field
initContainers: []              # Set Liferay DXP StatefulSet spec template spec initContainers field
livenessProbe: {}               # Set Liferay DXP StatefulSet spec template spec containers livenessProbe field
nameOverride: ""                # Override the Chart.Name value used in the helper template
nodeSelector: {}                # Set Liferay DXP StatefulSet spec template spec nodeSelector field
podSecurityContext: {}          # Set Liferay DXP StatefulSet spec template spec securityContext field
portalBundleDenyList: []        # Configure Liferay DXP portal bundle deny list in portal properties via central ConfigMap
portalComponentDenyList: []     # Configure Liferay DXP portal component deny list in portal properties via central ConfigMap
portalProperties: ""            # Set Liferay DXP portal properties via central ConfigMap
ports:                          # Set Liferay DXP StatefulSet spec template spec containers ports field
pullSecrets: []                 # Set Liferay DXP StatefulSet spec template spec containers imagePullSecrets field
readinessProbe: {}              # Set Liferay DXP StatefulSet spec template spec containers readinessProbe field
replicaCount: 1                 # Set Liferay DXP StatefulSet spec template spec replicas field
resources: {}                   # Set Liferay DXP StatefulSet spec template spec containers resources field
schedulingGates: []             # Set Liferay DXP StatefulSet spec template spec schedulingGates field
securityContext:                # Set Liferay DXP StatefulSet spec template spec containers securityContext field
service:                        # Liferay DXP Service configuration
   annotations: {}              # Set Liferay DXP Service metadata annotations field
   ports: []                    # Set Liferay DXP Service spec ports field
   type: ClusterIP              # Set Liferay DXP Service spec type field
serviceAccount:                 # Liferay DXP Role-Based Access Control configuration
   annotations: {}              # Set Liferay DXP ServiceAccount metadata annotations field
   automount: true              # Set Liferay DXP ServiceAccount automountServiceAccountToken field
   create: true                 # Enable/disable templating of Liferay DXP ServiceAccount, Role, and RoleBinding manifests
   name: ""                     # Set Liferay DXP ServiceAccount metadata name field (also sets Liferay DXP StatefulSet spec template spec serviceAccountName field)
   role:                        # Liferay DXP Role configuration
      annotations: {}           # Set Liferay DXP Role metadata annotations field
      rules: []                 # Set Liferay DXP Role spec rules field
startupProbe: {}                # Set Liferay DXP StatefulSet spec template spec containers startupProbe field
tolerations: []                 # Set Liferay DXP StatefulSet spec template spec tolerations field
updateStrategy: {}              # Set Liferay DXP StatefulSet spec updateStrategy field
volumeClaimTemplates: {}        # Set Liferay DXP StatefulSet spec volumeClaimTemplates field
volumeMounts: []                # Set Liferay DXP StatefulSet spec template spec volumeMounts field
volumes: []                     # Set Liferay DXP StatefulSet spec template spec volumes field

Super-charts (GCP)

When using the Liferay GCP super-charts, ensure the values are nested properly to include GCP-specific sub-charts such as the backup controller and restore utilities.

The liferay-gcp Helm chart configuration structure is as follows:

liferay-subchart-backup-controller:      # GCP-specific backup controller configuration
   enabled: true
   serviceAccountName: "backup-controller"
liferay-subchart-backup-create:          # Sub-chart for backup creation
   enabled: true
liferay-subchart-backup-restore:         # Sub-chart for backup restoration
   enabled: true
liferay-default:                         # The core liferay-default chart configuration
   ... (see core values above) ...