Pega-provided Docker images
In client-managed cloud environments, clients obtain the required licenses to
download and use Pega-provided Docker images to deploy
Pega Platform in a Kubernetes environment of their choice. Deploying Pega Platform using Kubernetes requires that you install Pega software files into a database that is available to the
deployment. Pega-provided several Docker images that
work together to deploy Pega software on nodes and a
database instance running in your preferred cloud environment. Download required Docker
images to your local system from the Pega-managed Docker
repository, and tag them, and then upload them to your preferred Docker image
repository. A Pega deployment includes processes that prepare a
split-schema configuration in which Pega rules and data
objects reside on separate schemas. The process copies the Pega software into your rules schema. Pega provides separate Docker images to run a Tomcat-based
web application, a backing service that runs Elasticsearch-based searches, and a
Hazelcast cluster. After you obtain the required access download the required Pega Docker images from the Pega
host site. Pega Platform version 8.6 and later support the
backing service feature that runs independently of your web server
nodes. For an overview of setting up SRS-based search in
Pega Platform and using Indexed classes for
SRS, see the appropriate section in Using full-text search based in Elasticsearch. Pega Platform versions 8.6 and later support the
client-server Hazelcast model. This model supersedes the embedded
deployment, which is deprecated in 8.7 and later and do not use the
embedded model for new deployments. Pega uses a standard naming practice of
When you choose a Pega Platform version for your downloaded Docker
images, use the same version tag for each of the images that you download. For the
For The date stamp confirms that the image you download includes the changes that
Pega engineering commits to the repository by
using pull requests that have the date stamp date. While Pega builds the most
current patch version of each minor release once daily, Pega makes the last five daily-built images available for
client downloads. After Pega releases a new patch
version, the prior patch version no longer receives daily builds with a date stamp
tag. For Pega Platform 8.6 and later, Pega supports a new client-server deployment model using
a cluster of nodes running Hazelcast as server, to which the Pega nodes connect as a client. This new client-server
deployment model improves the stability for Pega Platform
deployments that use a large number of nodes because it introduces independent
scalability for both servers and clients in Pega Platform.
Because of the inherent stability and scalability of this model, clients deploying
Pega Platform 8.6 and later should adopt this client-server
model using Hazelcast. Future Pega Platform releases will not
support embedded Hazelcast deployments. To deploy Pega Platform
and Hazelcast by using this client-server deployment model, download, and then push
the Clustering Service Docker image, The Docker image You can request access to the Pega-provided image
repository to download the Docker images that
Pega Platform deployments require. You must request access credentials to
obtain an access key that you use to download Docker images maintained in the Pega site. Pega provides access
credentials only to clients that have an appropriate support role in an organization that
already works with Pega. Pega partners are not allowed to request an access key on behalf of their customer to obtain
the Pega-provided Docker images. After completing your access request, you receive a confirmation that you
will soon receive an email with your access information. To deploy your client-managed cloud environments, after you have appropriate
licenses, manage your downloaded Docker images in your repository and make them available to
the Kubernetes environment in which you deploy Pega Platform. These
images do not expire, and you can keep them in your repository for as long as
necessary. Pega supports clients deploying and managing
Kubernetes with specific Docker needs to customize Docker images to support your Pega Platform deployments. Pega provides dockerfiles you can use to build a set of
custom Docker images if your organization enforces a corporate standard as to which
operating system and Java libraries to include in your Docker images. Pega provides Docker image with Ubuntu as the operating
system because of licensing restrictions around many commonly used operating systems;
however, before you customize your images, check the Platform Support Guide to verify that your changes, including your
operating system and Java libraries are supported by your Pega Platform version. When you deploy using your own custom image, Pega will continue to offer support for Pega Platform, but problems that arise from your custom image are not the
responsibility of Pega. If you build your own Docker images, you do not have to download the Pega-provided Docker images listed in the table to complete
your deployment. You must be familiar with Docker commands to build your own images. As
a starting point, see Dockerfile reference. After you build customized Docker images for use in a deployment of Pega Platform, Pega requires you to place
them in your non-public, privately-managed Docker registry since it includes proprietary
Pega files. After you complete a deployment using a set of these custom images, it is your
responsibility to keep your Pega up to date by
downloading Pega software distributions and creating new
custom images for patches and minor version updates. To prepare an installation image, use a Pega-provided
Dockerfile image that is designed to be used with a Pega Platform
distribution that you have downloaded. You must use this custom image to complete a
database installation of Pega Platform rules as part of your
deployment. For complete details, see Building a Pega Platform installer Docker image. To prepare a Pega web image, use a Pega-provided Dockerfile image that extends a customized
Tomcat base image and contains required components that allow you to run Pega Platform on your deployment nodes. For complete details, see
Pega Docker Image. To prepare a Pega Search and Reporting Service (SRS)
image, use the Pega-provided SRS-builder Dockerfile
image. For complete details, see Building a Search and Reporting Service(SRS) docker image.Pega-provided Docker images overview
List of the Pega-provided Docker images:
Image Name Description Version details platform/pega Deploys Pega Platform with its customized version
of the Tomcat application server. Pega provides a pega
Docker image for minor versions and patch versions of Pega Platform. To stay current with Pega releases, use the latest available
image.platform/installer A utility image Pega provides to
install or update the Pega-specific
rules and database tables in the “Pega”
database that you have configured for your deployment. Pega provides a
pega-installer image for minor versions and patch
versions of Pega Platform. To stay current with
Pega releases, use the latest
available installer image to install or update your Pega software.platform-services/search-n-reporting-service Deploys a cluster that runs search and reporting functions on
dedicated, backing service nodes. This Docker image contains Pega Search and Reporting Services (SRS),
with which you optimize Elasticsearch processing in your Pega deployment. Pega provides SRS Docker image
versions starting at 1.12.0; Pega
certified these images against Elasticsearch versions 7.10.2 and 7.16.3.
To stay current with Pega releases, use
the latest available SRS image--1.17.10 or later. platform/clustering-service Deploys the required clustering service, Hazelcast for the caching
capabilities in Pega Infinity as a backing service. This Docker image
contains the Hazelcast clustering Service. To stay current with Pega releases,
use the latest available a Hazelcast service Docker Image that is tagged
with version 1.0.3 or later. Determining which Dockers images to use for your deployment
hostname/product/image:tag. platform/installer/image:tag image, the :tag
represents the version of Pega that you want to install. For example, the tag
:8.7.1 installs Pega Platform version
8.7.1.platform/pega and platform/search images,
Pega also offers an image with a version tag
appended with a date stamp that uses the pattern
pegaVersion-YYYYMMDD to indicate the version and the date when
Pega built the image. For example, if you pull
the platform/pega that has the tag
pega:8.5.1-20201026, it indicates that Pega built this 8.5.1 image on October 26, 2020. Using
the version tag without the date stamp points to the most recently built image for
that version.platform/clustering-service,
to your Docker repository, and then reference it with the Hazelcast subchart under
the Pega-specific Helm chart. For the
platform/clustering-service image, the image tag represents the
version of Clustering Service that you want to install, for example, the
:1.0.3 tag installs clustering-service version 1.0.3.platform-services/search-n-reporting-service, used
with the SRS-specific backing sub-charts provides Pega backing services.
For more details, including an overview of how to configure the Pega backing
services, see the readme file in the BackingServices Helm chart. The SRS
subchart deployment provisions the latest generation of search and reporting
capabilities in Pega Platform. This service provides the search
service feature and replaces the previously provided
platform/search image-based Elasticsearch deployment. The
Docker image tagging format is different for backing services compared to the
Pega Platform images and does not follow the date stamp
pattern. For installing or updating Pega Infinity 8.6, use the
SRS image, 1.17.10 or later.Requesting access to Pega-provided Docker images
Manage downloaded Docker images
$ cat <localfilepath>\<platform>-demo\<access-key-filename>.txt | docker login pega-docker.downloads.pega.com --username=<reg-XXXXX> --password-stdin
Login Succeeded$ curl -X GET https://pega-docker.downloads.pega.com/v2/_catalog -H "X-JFrog-Art-Api:[accessKey]"$ curl -X GET "https://pega-docker.downloads.pega.com/v2/[repository name]/tags/list" -H "X-JFrog-Art-Api:[accessKey]"pega image to your
local system by specifying the version tag:$ docker pull pega-docker.downloads.pega.com/platform/pega:8.7.0
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform/pega:8.7.0pega image for your deployment with a customized tag
that includes your Docker registry host name and a name that is useful to your
organization.$ docker tag pega-docker.downloads.pega.com/platform/pega:8.7.0 <Registry host name:Port>/my-pega:8.7.0my-pega image to your registry:$ docker push <Registry host name:Port>/my-pega:8.7.0pega-installer image to
your local system, by specifying the version tag:$ docker pull pega-docker.downloads.pega.com/platform/installer:8.7.0
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform/installer:8.7.0pega-installer image for your deployment with a
customized tag that includes your Docker registry host name and a name that is
useful to your organization:$ docker tag pega-docker.downloads.pega.com/platform/installer:8.7.0 <Registry host name:Port>/my-pega-installer:8.7.0my-pega-installer image to your
registry:$ docker push <Registry host name:Port>/my-pega-installer:8.7.0search-n-reporting-service image to
your local system by specifying the version tag as shown in the following
example:$ docker pull pega-docker.downloads.pega.com/platform-services/search-n-reporting-service:1.17.10
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform-services/search-n-reporting-service:1.17.10search-n-reporting-service image for your deployment
with a customized tag that includes your Docker registry host name and a name
that is useful to your organization:$ docker tag pega-docker.downloads.pega.com/platform-services/search-n-reporting-service:1.17.10 <Registry host name:Port>/my-pega-srs:1.17.10my-pega-srs image to your registry:$ docker push <Registry host name:Port>/my-pega-srs:1.17.10platform/clustering-service image
for Hazelcast to your local system by specifying the version tag as shown in the
following example:$ docker pull pega-docker.downloads.pega.com/platform/clustering-service:1.0.3
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform/clustering-service:1.0.3platform/clustering-service image for your
deployment with a customized tag that includes your Docker registry host name
and a name that is useful to your organization:$ docker tag pega-docker.downloads.pega.com/platform/clustering-service:1.0.3 <Registry host name:Port>/my-pega-clustering-service:1.0.3platform/clustering-service image to your
registry:$ docker push <Registry host name:Port>/my-pega-clustering-service:1.0.3Build custom Docker images for your deployments
Build a Pega installer image
Build a Pega web image
Build a Pega Search and Reporting Service
image
Previous topic Meeting requirements and prerequisites Next topic Installing, patching, or updating Pega software