BUG-883938 Move Build custom pega-web-ready doc to the main readme

[kingakowalska1]

No description provided.

[kingakowalska1]

From: Peterson, John [email protected]
Sent: Monday, September 23, 2024 2:54 PM
To: Kowalska, Kinga [email protected]; Kumar, Saurabh [email protected]
Cc: Chikkam, Venkata Satya Gopal [email protected]; Saranathan, Raghu [email protected]; Talbot, Adam [email protected]
Subject: RE: Documentation to build custom runtime image.

Hi Kinga,

This looks fine.

Thanks,
John

From: Kowalska, Kinga <[email protected]>
Sent: Wednesday, September 18, 2024 7:21 AM
To: Peterson, John <[email protected]>; Kumar, Saurabh <[email protected]>
Cc: Chikkam, Venkata Satya Gopal <[email protected]>; Saranathan, Raghu <[email protected]>; Talbot, Adam <[email protected]>
Subject: RE: Documentation to build custom runtime image.

Hi John,

I thought the doc that we were incorporating into the README was addressing specifically this issue, that means, creating a web ready image with a client’s customized OS and JDK. Here’s what we have in the PR:

If you do not want to use the Pega-provided Docker image because, for example, you need a customized base image with your preferred OS and JDK enforced by a corporate standard, you can copy this repository and build your own pega-web-ready image based on your preferred base image. When making customizations for your environment, check the Pega Platform Support Guide Resources to verify that those changes are supported by your Pega Platform version.
Important: If you choose to build your own image, Pega will continue to offer support for Pega Platform, but problems that arise from your custom image are not the responsibility of Pegasystems.
To build a custom pega-web-ready image using your preferred OS and JDK, perform the following actions:

1. Ensure that the base image you selected has $CATALINA_HOME set to the correct Tomcat location.
2. Create a Dockerfile for your custom pega-web-ready image using your base image and the open-source pega-web-ready Dockerfile code.
   For more information, see pegasystems/docker-pega-web-ready/Dockerfile.
   Note: You can add any extra environment variables needed in the Dockerfile as per your use-case.
3. Use the following command to build the custom pega-web-ready image using the base image as an argument.
   $ docker build --build-arg BASE_TOMCAT_IMAGE=<BASE_IMAGE> -t <IMAGE_NAME> .
   The system then builds your custom pega-web-ready Docker image.
   Do we need anything else?

If I’m not understanding this correctly, perhaps we could have a chat and clear this up? I could set up a meeting whenever you’re available.

Thank you!
Kinga

From: Peterson, John <[email protected]>
Sent: Thursday, September 12, 2024 4:19 PM
To: Kowalska, Kinga <[email protected]>; Kumar, Saurabh <[email protected]>
Cc: Chikkam, Venkata Satya Gopal <[email protected]>; Saranathan, Raghu <[email protected]>; Talbot, Adam <[email protected]>
Subject: RE: Documentation to build custom runtime image.

https://github.com/pegasystems/docker-pega-web-ready?tab=readme-ov-file#building-a-deployable-docker-image-using-this-web-ready-image
These instructions are for taking our provide pega-ready image to build a customized client image. Again, as I explained below this is not really required anymore, because clients can simply take the Pega image to build their own customized client image.

I’m looking for the documentation that explains how clients could create a custom ready image with their own OS, JDK, and/or Tomcat implementation.

John

From: Kowalska, Kinga <[email protected]>
Sent: Thursday, September 12, 2024 9:55 AM
To: Peterson, John <[email protected]>; Kumar, Saurabh <[email protected]>
Cc: Chikkam, Venkata Satya Gopal <[email protected]>; Saranathan, Raghu <[email protected]>; Talbot, Adam <[email protected]>
Subject: RE: Documentation to build custom runtime image.

Hi John,

Do you mean a detailed explanation on how to use the Dockerfile? I thought all of the settings, building commands, image customizations, etc, were explained in the following sections of the readme? First in “Image customizations” and then https://github.com/pegasystems/docker-pega-web-ready?tab=readme-ov-file#building-a-deployable-docker-image-using-this-web-ready-image. Unless you mean something additional that was not covered?

Kinga

From: Peterson, John <[email protected]>
Sent: Thursday, September 12, 2024 2:03 PM
To: Kowalska, Kinga <[email protected]>; Kumar, Saurabh <[email protected]>
Cc: Chikkam, Venkata Satya Gopal <[email protected]>; Saranathan, Raghu <[email protected]>; Talbot, Adam <[email protected]>
Subject: RE: Documentation to build custom runtime image.

Hi Kinga,

Yeah, I think that works. Do we want to try to explain how they can achieve it?

John

From: Kowalska, Kinga <[email protected]>
Sent: Wednesday, September 11, 2024 8:57 AM
To: Peterson, John <[email protected]>; Kumar, Saurabh <[email protected]>
Cc: Chikkam, Venkata Satya Gopal <[email protected]>; Saranathan, Raghu <[email protected]>; Talbot, Adam <[email protected]>
Subject: RE: Documentation to build custom runtime image.

Hi John,

Thank you for the detailed explanation, it was very illuminating. 😊

I propose that we write the following:

Using this image

Pega offers a publicly available Pega runtime Docker image which includes the prweb.war file, but does not contain Pega rules - for details, see pegasystems/pega on DockerHub and Pega-provided Docker images. Pega builds the pegasystems/pega image from a pegasystems/pega-ready Docker image, a base image that contains an OS (Ubuntu Linux), a Java implementation (Adoptium Temurin JDK11 or JDK17), and an application server (Apache Tomcat) and is customized with Pega-specific configurations. You can use the pegasystems/pega-ready Dockerfile code to customize and build your own web-ready image and then extend it with the Pega .war file of your choice.
Docker images provided by Pegasystems are validated and supported by Pega Support.

Please let me know if this is sufficient.

Thanks!
Kinga