Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG-867838] Platform/Search Docker image deprecation #743

Merged
merged 3 commits into from
May 15, 2024
Merged

[BUG-867838] Platform/Search Docker image deprecation #743

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99341c8
[BUG-867838] Platform/Search Docker image deprecation
kingakowalska1 May 6, 2024
0f50796
[BUG-867838] Platform/Search Docker image deprecation (#744)
kingakowalska1 May 6, 2024
03b45f0
Merge branch 'master' into kingakowalska1-patch-1
MadhuriArugula May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 27 additions & 28 deletions docs/prepping-local-system-runbook-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,9 +420,9 @@ Pegasystems uses a standard naming practice of hostname/product/image:tag. Pega
-------------|-------------------------------------------------------|----------|
`platform/installer` | A utility image with which you install all of the Pega-specific rules and database tables in the “Pega” database that you have configured for your deployment. This installation is required before a deployment can take place.| `<version>` |
`platform/pega` | (Download required) Deploys Pega Platform with its customized version of the Tomcat application server.| `<version>` or `<version>-YYYYMMDD` |
`platform/search` | (Download required) Deploys the required search engine for Pega Platform search and reporting capabilities. This Docker image contains Elasticsearch and includes all required plugins.| `<version>` or `<version>-YYYYMMDD` |
`platform/clustering-service` | (Download required) Deploys the required clustering service(Hazelcast) for the caching capabilities in Pega platform as a backing service. This Docker image contains Hazelcast clustering Service. <br/><br/>*Note: This feature is supported only from platform version "8.6" to deploy the platform in client-server Hazelcast model. Embedded deployment would not be supported in future platform releases.*| `<version>` |
`platform-services/search-n-reporting-service` | [optional and compatible only with Pega version 8.6 and later] (Download required) 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 and allows you to optimize Elasticsearch processing in your Pega deployment. To optimize Elasticsearch processing, you must deploy this image and the matching release of the platform/search image. For more information about this service, see [Instructions to configure the Pega backingservices](../charts/backingservices/README.md). | `<version>` |
`platform-services/search-n-reporting-service` | (Download required) 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 Service (SRS) and allows you to optimize Elasticsearch processing in your Pega deployment. For more information about this service, see [External Elasticsearch in your deployment](https://docs.pega.com/bundle/platform-23/page/platform/deployment/externalization-of-services/externalize-search-in-your-deployment.html). | `<version>` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use
External Elasticsearch in your deployment

`platform/search` | (Deprecated) Deploys the deprecated legacy external client-server solution for Elasticsearch. The Docker image contains an Elasticsearch plug-in configured to directly connect to your Pega Platform environment. Note: The Elasticsearch plug-in is deprecated starting in Pega Platform version 8.8. Use the `platform-services/search-n-reporting-service` to deploy the Search and Reporting Service (SRS) instead. For more information, see [External Elasticsearch in your deployment](https://docs.pega.com/bundle/platform-23/page/platform/deployment/externalization-of-services/externalize-search-in-your-deployment.html).| `<version>` or `<version>-YYYYMMDD` |

When you decide on a Pega Platform version for your downloaded Docker images, you should use the same version tag for each of the images you download.

Expand All @@ -438,7 +438,7 @@ this client-server model using Hazelcast. Embedded deployment would not be suppo
To deploy Pega platform and Hazelcast using this client-server deployment model, you must download and push the Clustering Service Docker image,
`platform/clustering-service` to your Docker repository and use with the Hazelcast subchart under [Pega charts](../charts/pega/charts).For the `platform/clustering-service` image, the :tag represents the version of Clustering Service you want to install, for example the tag :1.0.3 will install clustering-service version 1.0.3.

The Docker image `platform-services/search-n-reporting-service` is used with the [Search and Reporting Service](../charts/backingservices/charts/srs) under [backing services](../charts/backingservices). The SRS subchart deployment provisions the latest generation of search and reporting capabilities in Pega Infinity. This service is optional and is an alternate search feature to the previously used `platform/search` image-based Elasticsearch deployment. To configure this service, see [Instructions to configure the Pega backingservices](../charts/backingservices/README.md).
The Docker image `platform-services/search-n-reporting-service` is used with the [Search and Reporting Service](../charts/backingservices/charts/srs) under [backing services](../charts/backingservices). The SRS subchart deployment provisions the latest generation of search and reporting capabilities in Pega Infinity. To configure this service, see [External Elasticsearch in your deployment](https://docs.pega.com/bundle/platform-23/page/platform/deployment/externalization-of-services/externalize-search-in-your-deployment.html).
The docker image format is different for backing services and does not follow the datestamp pattern. For installations of or upgrades to Pega Infinity 8.6, you may configure Docker image `platform-services/search-n-reporting-service` with `<srs-version>` compatible with the Pega version as provided in [compatibility matrix](../charts/backingservices/charts/srs/README.md#srs-version-compatibility-matrix).

The datestamp ensures that the image you download includes the changes that Pega engineering commits to the repository using pull requests by a certain date. While Pega builds the most current patch version of each minor release one time each day, 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 datestamp tag.
Expand Down Expand Up @@ -546,69 +546,68 @@ It is a best practice to retag each of your Pega Docker images by including your

`$ docker push <Registry host name:Port>/my-pega:8.4.0`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we update all of these tags to '24.1 now?
docker push /my-pega:24.1.0`


5. To download your preferred version of the `search` image to your local system, specify the version tag when you enter:

```bash
$ docker pull pega-docker.downloads.pega.com/platform/search:<version>
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform/search:<version>
```

6. To retag the `search` image for your deployment with a customized tag that includes your Docker registry host name and a name that is useful to your organization, such as `<Registry host name:Port>/my-pega-search:<Pega Platform version>`, enter:

`$ docker tag pega-docker.downloads.pega.com/platform/search:8.4.0 <Registry host name:Port>/my-pega-search:8.4.0`

7. To push the retagged `my-pega-search` image to your registry, enter:

`$ docker push <Registry host name:Port>/my-pega-search:8.4.0`

8. To download your preferred version of the `installer` image to your local system, specify the version tag when you enter:
5. To download your preferred version of the `installer` image to your local system, specify the version tag when you enter:

```bash
$ docker pull pega-docker.downloads.pega.com/platform/installer:<version>
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform/installer:<version>
```

9. To retag the `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, such as `<Registry host name:Port>/my-pega-installer:<Pega Platform version>`, enter:
6. To retag the `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, such as `<Registry host name:Port>/my-pega-installer:<Pega Platform version>`, enter:

`$ docker tag pega-docker.downloads.pega.com/platform/installer:8.4.0 <Registry host name:Port>/my-pega-installer:8.4.0`

10. To push the retagged `my-pega-installer` image to your registry, enter:
7. To push the retagged `my-pega-installer` image to your registry, enter:

`$ docker push <Registry host name:Port>/my-pega-installer:8.4.0`

11. To download your preferred version of the `clustering-service` image to your local system, specify the version tag when you enter:
8. To download your preferred version of the `clustering-service` image to your local system, specify the version tag when you enter:

```bash
$ docker pull pega-docker.downloads.pega.com/platform/clustering-service:<version>
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform/clustering-service:<version>
```

12. To retag the `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, such as `<Registry host name:Port>/my-clustering-service:<Clustering Service version>`, enter:
9. To retag the `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, such as `<Registry host name:Port>/my-clustering-service:<Clustering Service version>`, enter:

`$ docker tag pega-docker.downloads.pega.com/platform/clustering-service:1.0.3 <Registry host name:Port>/my-clustering-service:1.0.3`

13. To push the retagged `my-clustering-service` image to your registry, enter:
10. To push the retagged `my-clustering-service` image to your registry, enter:

`$ docker push <Registry host name:Port>/my-clustering-service:1.0.3`

After you push these downloaded images to your private Docker registry, you are ready to begin deploying Pega Platform to a support Kubernetes environment. Use the runbook in this Github directory for your deployment.

14. To download your preferred version of the `search-n-reporting-service` image to your local system, specify the version tag (refer [compatibility matrix](../charts/backingservices/charts/srs/README.md#srs-version-compatibility-matrix)) when you enter:
11. To download your preferred version of the `search-n-reporting-service` image to your local system, specify the version tag (refer [compatibility matrix](../charts/backingservices/charts/srs/README.md#srs-version-compatibility-matrix)) when you enter:

```bash
$ docker pull pega-docker.downloads.pega.com/platform-services/search-n-reporting-service:<srs-version>
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform-services/search-n-reporting-service:<srs-version>
```

15. To retag the `search-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, such as `<Registry host name:Port>/my-pega-srs:<Pega Platform version>`, enter:
12. To retag the `search-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, such as `<Registry host name:Port>/my-pega-srs:<Pega Platform version>`, enter:

`$ docker tag pega-docker.downloads.pega.com/platform-services/search-n-reporting-service:<srs-version> <Registry host name:Port>/my-pega-srs:8.6.0`

16. To push the retagged `my-pega-srs` image to your registry, enter:
13. To push the retagged `my-pega-srs` image to your registry, enter:

`$ docker push <Registry host name:Port>/my-pega-srs:8.6.0`

14. To download your preferred version of the `search` image to your local system, specify the version tag when you enter:

```bash
$ docker pull pega-docker.downloads.pega.com/platform/search:<version>
Digest: <encryption verification>
Status: Downloaded pega-docker.downloads.pega.com/platform/search:<version>
```

15. To retag the `search` image for your deployment with a customized tag that includes your Docker registry host name and a name that is useful to your organization, such as `<Registry host name:Port>/my-pega-search:<Pega Platform version>`, enter:

`$ docker tag pega-docker.downloads.pega.com/platform/search:8.4.0 <Registry host name:Port>/my-pega-search:8.4.0`

18. To push the retagged `my-pega-search` image to your registry, enter:

`$ docker push <Registry host name:Port>/my-pega-search:8.4.0`
Loading
Loading