Skip to content

Commit

Permalink
BUG-841263 (#692)
Browse files Browse the repository at this point in the history
Removed references to Pega Platform 8.2, as we only support 8.3+
  • Loading branch information
khick77 authored Jan 19, 2024
1 parent 7d03c0f commit 132cedd
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 17 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pega deployment on Kubernetes

This project provides Helm charts and basic examples for deploying Pega on Kubernetes. You will also need to download the required [installation kit](https://community.pega.com/knowledgebase/products/platform/deploy) from the Pega Community which includes rules and data to preload into your relational database. Deploying Pega on Kubernetes requires Pega Infinity 8.2 or later.
This project provides Helm charts and basic examples for deploying Pega on Kubernetes. You will also need to download the required [installation kit](https://community.pega.com/knowledgebase/products/platform/deploy) from the Pega Community which includes rules and data to preload into your relational database. Deploying Pega on Kubernetes requires Pega Infinity 8.3 or later.

[![Build Status](https://github.com/pegasystems/pega-helm-charts/actions/workflows/github-actions-build.yml/badge.svg)](https://github.com/pegasystems/pega-helm-charts/actions/workflows/github-actions-build.yml)
[![GitHub release](https://img.shields.io/github/release/pegasystems/pega-helm-charts.svg)](https://github.com/pegasystems/pega-helm-charts/releases)
Expand Down
2 changes: 1 addition & 1 deletion charts/pega/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -971,7 +971,7 @@ Parameter | Description | Default value
`upgrade.upgradeType:` |Specify the type of process, applying a patch or upgrading. | See the next table for details.
`upgrade.upgradeSteps:` |Specify the steps of a `custom` upgrade process that you want to complete. For `zero-downtime`, `out-of-place-rules`, `out-of-place-data`, or `in-place` upgrades, leave this parameter empty. | <ul>`enable_cluster_upgrade` `rules_migration` `rules_upgrade` `data_upgrade` `disable_cluster_upgrade`</ul>
`upgrade.targetRulesSchema:` |Specify the name of the schema you created the process creates for the new rules schema. | `""`
`upgrade.targetDataSchema:` | For patches to 8.4 and later or upgrades from 8.4.2 and later, specify the name of the schema the process creates for the temporary data schema. After the patch or upgrade, you must delete this temporary data schema from your database. For 8.2 or 8.3 Pega software patches, you can leave this value empty, as is (do not add blank text). | `""`
`upgrade.targetDataSchema:` | For patches to 8.4 and later or upgrades from 8.4.2 and later, specify the name of the schema the process creates for the temporary data schema. After the patch or upgrade, you must delete this temporary data schema from your database. For 8.3 Pega software patches, you can leave this value empty, as is (do not add blank text). | `""`

Upgrade type | Description
--- | ---
Expand Down
21 changes: 6 additions & 15 deletions docs/patching-pega-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,15 @@ Client-managed cloud clients use the same Pega Kubernetes tools and Helm charts

2. Edit the pega Helm chart by editing parameters to specify "upgrade-deploy" your software with the software contained in your provided patch image. - [Applying a zero-downtime Pega Platform patch using Helm charts - 120-minutes](#applying-a-zero-downtime-pega-platform-patch-using-helm-charts--120-minutes).

3. **For deployments running Pega Infinity 8.2.1 through 8.2.7 only:** Create a new blank rules schema in your existing database. Leave this new schema empty. If you are running Pega Infinity 8.3 or higher, you can skip this step, since the patch scripts in your deployment automate the creation of these blank schemas.

If you create a new schema, create each schema name in accordance with the requirements of your deployment database type:
- Oracle/DB2 databases force unquoted identifiers to uppercase.
- PostgreSQL databases force unquoted identifiers to lowercase.
- MSSQL uses case sensitive identifiers; therefore you must use a consistent naming convention in order to avoid issues with your deployment.

Pega does not support quoted identifiers in database schema names, so do not wrap your schema name with single quotes.

4. Apply the patch by using the `helm upgrade release --namespace mypega` command as directed in the deployment section - [Patching your Pega Platform deployment using the command line](#patching-your-pega-platform-deployment-using-the-command-line).
3. Apply the patch by using the `helm upgrade release --namespace mypega` command as directed in the deployment section - [Patching your Pega Platform deployment using the command line](#patching-your-pega-platform-deployment-using-the-command-line).

## Assumptions and prerequisites

The process to patch your deployment assumes:

- Your Kubernetes environment has not changed and you are using the same Pega charts with which you originally deployed.
- Your Kubernetes environment has not changed, and you are using the same Pega charts with which you originally deployed.

- Your original deployment used Pega Platform 8.2.1 or later.
- Your original deployment used Pega Platform 8.3.0 or later.

## Applying a zero-downtime Pega Platform patch using Helm charts – 120 minutes

Expand All @@ -51,7 +42,7 @@ To complete a zero downtime patch, you must configure the following settings in
- Specify action.execute: upgrade-deploy to invoke the zero-downtime patch process.
- Specify the schema name or names that will be upgraded:
- **For 8.4 and later**: specify both schema names, since the process involves migrating rules to and from each schema (jdbc.rulesSchema: "YOUR_RULES_SCHEMA" and jdbc.dataSchema: "YOUR_DATA_SCHEMA").
- **For 8.2 and 8.3**: specify the rules schema since the process only involves migrating rules to and from the existing rule schema (jdbc.rulesSchema: "YOUR_RULES_SCHEMA"); leave the existing "YOUR_RULES_SCHEMA" value (do not leave blank text).
- **For 8.3**: specify the rules schema since the process only involves migrating rules to and from the existing rule schema (jdbc.rulesSchema: "YOUR_RULES_SCHEMA"); leave the existing "YOUR_RULES_SCHEMA" value (do not leave blank text).
- Ensure one of the following:
- You pushed the images for your patch to the same repository that you used for your installation repository and the credentials for your repository account are the same as those in your `pega` Helm chart.
- You pushed the images for your patch to a new repository and you update the parameters with your credentials for this new repository account in your `pega` Helm chart.
Expand All @@ -65,7 +56,7 @@ To complete a zero downtime patch, you must configure the following settings in
- In the installer section of the Helm chart, update the following:
- Update the tagging details, including the version and date of your Pega-provided `platform/installer` Docker image, that you downloaded to support your patch.
- Specify an `zero-downtime` upgrade to apply a patch using the zero-downtime patch process.
- **For patches to 8.4 and later**, specify the new target new rules and temporary data schema names that the process creates in your existing database to support the patch process within the quotes. **For 8.2 or 8.3 Pega software patches**, you can leave this value empty, as is (do not leave blank text).
- **For patches to 8.4 and later**, specify the new target new rules and temporary data schema names that the process creates in your existing database to support the patch process within the quotes. **For 8.3 Pega software patches**, you can leave this value empty, as is (do not leave blank text).

You can leave the existing customized parameters as is; the patch process will use the remaining existing settings in your deployment.

Expand All @@ -88,7 +79,7 @@ Complete the following steps.
| installer.adminPassword: | Specify an initial administrator@pega.com password for your installation. This will need to be changed at first login. The adminPassword value cannot start with "@".| adminPassword: "\<initial password\>" |
| installer.upgrade.upgradeType | Specify an zero-downtime upgrade to apply a patch using the zero-downtime patch process. | upgradeType: "zero-downtime" |
| installer.upgrade.targetRulesSchema | Specify a new rules schema name that the process creates in your existing database to support the patch process within the quotes. | targetRulesSchema: "" |
| installer.upgrade.targetDataSchema | For patches to 8.4 and later, specify a new target data schema name that the process creates in your existing database to support the patch process within the quotes. For 8.2 or 8.3 Pega software patches, you can leave this value empty, as is (do not leave blank text). | targetDataSchema: "" |
| installer.upgrade.targetDataSchema | For patches to 8.4 and later, specify a new target data schema name that the process creates in your existing database to support the patch process within the quotes. For 8.3 Pega software patches, you can leave this value empty, as is (do not leave blank text). | targetDataSchema: "" |
2. Save the file.

### Patching your Pega Platform deployment using the command line
Expand Down

0 comments on commit 132cedd

Please sign in to comment.