Skip to main content

Using Pega-provided Docker images


Only available versions of this content are shown in the dropdown

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 software files into a database that is available to the deployment. Pega-provides several Docker image that work together to deploy Pega software on nodes and a database instance running in your preferred cloud environment. To do so, you must download several Docker images to your local system from the Pega Digital Software site and then upload them to your preferred Docker image repository.

A Pega Platform deployment includes processes that prepare a split-schema configuration where Pega rules and data objects reside on separate schemas and copy Pega software into your rules schema. Pega provides separate Docker images to run a Tomcat-based web application and Elasticsearch-based search functionality as described in the table below.

List of the Pega-provided Docker images:

Name Description
platform/pega Deploys Pega Platform with its customized version of the Tomcat application server.
platform/search Deploys an external Elasticsearch search service that includes the required Elasticsearch plug-ins so your Pega applications automatically connect to search.

For an overview about setting up search in Pega Platform, see Using full-text search based in Elasticsearch.

platform/installer A 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.
platform-services/search-n-reporting-service Deploys the latest Pega generation of search and reporting capabilities in Pega Infinity on dedicated, backing service nodes. This Docker image contains Pega Search and Reporting Services (SRS) and allows you to optimize Elasticsearch processing in your Pega deployment.

For an overview about setting up SRS-based search in Pega Platform, see Using full-text search based in Elasticsearch.

Managing your docker images

Clients with the appropriate support role in your organization can log in to the image repository and download the Docker images in Pega Digital Software Delivery that are required to install Pega Platform onto your database. From here you request access and after Pega provides your access key, you can log in to the image repository and download your preferred Docker images. After you pull the images to your local system, you must push them into your private Docker registry. For more information on accessing and managing your Pega-provided images, see Downloading Docker images for your deployment. Pega partners are not allowed to request an access key on behalf of their customer to obtain the Pega-provided Docker images.

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:

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.

Building your own docker image

Pega also supported building your own Pega installation Docker image for your Pega Platform installation. To prepare this installation image, you use a Pega-provided Docker image that is designed specifically for a database installation. For details, see Building a Pega Platform installer docker image.

Did you find this content helpful?

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.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us