Skip to main content


Using Pega-provided Docker images

Suggest edit Updated on December 10, 2020

In Client-managed cloud environments, clients with appropriate licenses use Pega-provided docker images to manage their cloud environment.

Deploying Pega Platform™ using Kubernetes requires that you install Pega Platform files into a database that is available to the deployment. To do so, you must build a Docker image for the Pega Platform installation. To prepare this installation image, you use a Pega-provided Docker image that is designed specifically for a database installation, a Dockerfile and a Pega Platform distribution image which you download to your local system from the Pega Digital Software site. For details on how to build a Pega installer image using the distribution kit, see Downloading Docker images for your deployment.

For step-by-step guidance for preparing your system for Kubernetes deployments as well as build the Docker image installation image, Pega provides details in each of the following example runbooks:

List of the Pega-provided Docker images:

platform/pegaDeploys the Pega Platform with its customized version of the Tomcat application server.
platform/searchDeploys the search engine required for the Pega Platform application’s search and reporting capabilities. This Docker image contains Elasticsearch and includes all required plugins.
platform/installerA utility image Pega Platform deployments use to install or upgrade all of the Pega-specific rules and database tables in the “Pega” database you have configured for your deployment.

Managing your docker images

Clients with appropriate licenses can request access to several required images from the Pega-managed Docker image repository. With your access key, you can log in to the image repository and download docker images that are required to install the Pega Platform onto your database. After you pull the images to your local system you must push them into your private Docker registry.

The Pega application requires the use of a Tomcat application server, which Pega maintains in order to optimize it for use with Pega software. It is included in all Pega Platform installations.

If this is the first time you are setting up a Docker registry, review the Docker article, Deploy a registry server. Pega supports using any of the following popular Docker image repositories:

Note: After you build a customized installation image, Pega requires you to place it in a private Docker registry, since it includes proprietary Pega files.

Depending on your Kubernetes configuration and registry of choice, you may need to fully qualify your image. For example, to access an image you tagged as pega/platform:latest and pushed to, you reference your image in the Pega configuration files as For details on using a private Docker registry, see How to use your own registry article on the Docker blog.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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