Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Installing Pega software

Updated on April 5, 2022

After you have the required docker images, you install Pega Platform software when you initially deploy Pega Platform into your Kubernetes environment. To deploy Pega Platform, Pega provides Helm charts in which you specify the requirements of the Pega deployment for your environment. You then use Helm to deploy all the required Kubernetes resources automatically.

Getting the Pega charts

Pega maintains a repository of Helm charts that are required to deploy Pega Platform using Helm. After you add the repository to your local system, you can customize these Pega configuration files for your Pega Platform deployment. To get started using the Pega-provided Helm charts for deploying Pega Platform into the cloud environment of your choice, see Pega deployment on Kubernetes.

Helm Chart parameters

To deploy Pega Platform by using the Pega-provided Helm charts you must update the parameters in the following two charts:

  • To reflect the requirements for your Pega Platform deployment, edit the Pega Helm chart. For details about the Pega Helm chart configuration, see the Pega Helm chart readme.
  • To configure the supporting services and tools, edit the Addons Helm chart. For details about the Addons Helm chart configuration, see the Addons Helm chart readme.

For more general details about how to use Helm and Helm charts to manage Kubernetes orchestrations, see the QuickStart Guide on the Helm documentation portal.

Best practices for managing configuration using secrets

Pega supports using Kubernetes secrets to secure credentials and related information. Use secrets to represent credentials for your database, Docker registry, or any other token or key that you need to pass to a deployed application. To create a secret, see Distributing Credentials Securely Using Secrets.

Pega supports passing secrets in the following ways:

TypeConfiguration Example
Credentials using environment variablesenv:
  • - name: DB_USERNAME
  • - valueFrom:
  • - secretKeyRef:
  • - name: mysecret
key: username
  • - name: DB_PASSWORD
  • - valueFrom:


  • - name: mysecret
  • - key: password
Credentials using volume mountcontainers:
  • ...
  • - name: secret-volume
  • - mountPath: /opt/pega/secrets


  • - name: secret-volume


  • - secretName: mysecret
Docker registry secretimagePullSecrets:
  • - name: regsecret

Installing other Pega applications

After you install Pega Platform using the installer Docker that you built, you can install additional Pega applications using the standard application installation process with an application distribution image you download from the Pega Digital Software Delivery site. For the installation instructions, see the industry application section of the Pega Community Product page.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us