Pega deployment on Kubernetes

This project provides Helm charts and basic examples for deploying Pega on Kubernetes. You will also need to download the required installation kit from the Pega Community which includes rules and data to preload into your relational database. Deploying Pega on Kubernetes requires Pega Infinity 8.2 or newer.

Supported Kubernetes environments

Pegasystems has validated deployments on the following Kubernetes IaaS and PaaS environments.

• Open-source Kubernetes (and MiniKube for personal deployments)
• Microsoft Azure Kubernetes Service (AKS) - see the AKS runbook
• Amazon Elastic Kubernetes Service (EKS)
• Google Kubernetes Engine (GKE) - see the GKE runbook
• Red Hat OpenShift
• Pivotal Container Service (PKS) - see the PKS runbook

Getting started

This project assumes you have an installation of Kubernetes available and have Helm installed locally. The following commands will verify your installation. The exact output may be slightly different, but they should return without error.

$ helm version
version.BuildInfo{Version:"v3.0.0", GitCommit:"e29ce2a54e96cd02ccfce88bee4f58bb6e2a28b6", GitTreeState:"clean", GoVersion:"go1.13.4"}

If this command does not successfully return, install Helm 3 for your operating system. See Helm Installation for more information. If you are running Helm 2.x, you will see both a client and server (tiller) portion returned by the version command. Some of the commands below will also differ slightly for Helm 2.x.

1. Add the Pega repository to your Helm installation.

$ helm repo add pega https://dl.bintray.com/pegasystems/pega-helm-charts

2. Verify the new repository by searching it.

$ helm search repo pega
NAME       	CHART VERSION	APP VERSION	DESCRIPTION
pega/pega  	1.2.0        	           	Pega installation on kubernetes
pega/addons	1.2.0        	1.0        	A Helm chart for Kubernetes 

There are two charts available in this repository - addons and pega.

The addons chart installs a collection of supporting services and tools required for a Pega deployment. The services you will need to deploy will depend on your cloud environment - for example you may need a load balancer on Minikube, but not for EKS. These supporting services are deployed once per Kubernetes environment, regardless of how many Pega Infinity instances are deployed.

3. Download the values file for pega/pega and pega/addons.

$ helm inspect values pega/pega > pega.yaml
$ helm inspect values pega/addons > addons.yaml

4. Edit your values yaml files to specify all required information and customizations for your environment.

• Instructions to configure the Pega chart
• Instructions to configure the Pega addons

5. Create namespaces for your Pega deployment and the addons (if applicable for your environment).

$ kubectl create namespace mypega
$ kubectl create namespace pegaaddons

6. To install the addons chart, run the following helm command after configuring your values.yaml file (if applicable for your environment).

$ helm install addons pega/addons --namespace pegaaddons --values addons.yaml

7. Now you can deploy Pega using the Helm chart. Before installing using the chart, it is a good idea to review the detailed deployment guide to understand how Pega deploys as a distributed system. Running a Helm installation using the pega chart installs a Pega Infinity instance into a specified namespace.

$ helm install mypega pega/pega --namespace mypega --values pega.yaml

If you want to edit the charts and build using your local copy, replace pega/addons or pega/pega with the path to your chart directory.

8. If you wish to delete your deployment of Pega nodes, enter the following command (this will not delete your database):

$ helm delete mypega

Contributing

This is an open source project and contributions are welcome. Please see the contributing guidelines to get started.