From 136f0bbe74e6e7d5119e0a255fedf207034f9a16 Mon Sep 17 00:00:00 2001 From: talba Date: Fri, 27 Aug 2021 12:23:10 -0400 Subject: [PATCH 1/3] Update documentation to reflect Pega's stance on dependent charts --- README.md | 6 +++--- charts/addons/README.md | 4 +++- charts/addons/requirements.yaml | 3 +++ charts/backingservices/README.md | 4 ++++ charts/backingservices/requirements.yaml | 3 +++ charts/pega/README.md | 2 ++ charts/pega/requirements.yaml | 3 +++ docs/Deploying-Pega-on-AKS.md | 2 +- docs/Deploying-Pega-on-EKS.md | 2 +- docs/Deploying-Pega-on-GKE.md | 2 +- docs/Deploying-Pega-on-PKS.md | 2 +- docs/Deploying-Pega-on-openshift.md | 2 +- docs/upgrading-pega-deployment-zero-downtime.md | 2 +- 13 files changed, 27 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f6df09dd0..c42706512 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Pegasystems has validated deployments on the following Kubernetes IaaS and PaaS * Microsoft Azure Kubernetes Service (AKS) - see the [AKS runbook](docs/Deploying-Pega-on-AKS.md) * Amazon Elastic Kubernetes Service (EKS) - see the [EKS runbook](docs/Deploying-Pega-on-EKS.md) * Google Kubernetes Engine (GKE) - see the [GKE runbook](docs/Deploying-Pega-on-GKE.md) -* Red Hat OpenShift +* Red Hat OpenShift - see the [OpenShift runbook](docs/Deploying-Pega-on-openshift.md) * VMware Tanzu Kubernetes Grid Integrated Edition (TKGI) - see the [TKGI runbook](docs/Deploying-Pega-on-PKS.md) # Getting started @@ -39,13 +39,13 @@ $ helm repo add pega https://pegasystems.github.io/pega-helm-charts $ helm search repo pega NAME CHART VERSION APP VERSION DESCRIPTION pega/pega 1.4.4 Helm chart to configure required installation and deployment configuration settings in your environment for your deployment. -pega/addons 1.4.4 1.0 Helm chart to configure required supporting services and tools in your environment for your deployment. +pega/addons 1.4.4 1.0 Helm chart to configure supporting services and tools in your environment for your deployment. pega/backingservices 1.4.4 Helm Chart to provision the latest Search and Reporting Service (SRS) for your Pega Infinity deployment ``` There are three charts available in this repository - addons, backingservices, and pega. -The addons chart installs a collection of supporting services and tools required for a Pega deployment. The services you will need to deploy will depend on your cloud environment - for example you may need a load balancer on Minikube, but not for EKS. These supporting services are deployed once per Kubernetes environment, regardless of how many Pega Infinity instances are deployed. +The addons chart installs a collection of supporting services and tools for a Pega deployment. The services you will need to deploy will depend on your cloud environment - for example you may need a load balancer on Minikube, but not for EKS. These supporting services are deployed once per Kubernetes environment, regardless of how many Pega Infinity instances are deployed. The backingservices chart installs services like 'Search and Reporting Service' (SRS) that you can configure with one or more Pega deployments. You can deploy these backing services in their own namespace; you can isolate the services to a single environment or share them across multiple Pega Infinity environments. diff --git a/charts/addons/README.md b/charts/addons/README.md index d0d2190fc..8243f4cdb 100644 --- a/charts/addons/README.md +++ b/charts/addons/README.md @@ -1,6 +1,8 @@ # Addons Helm chart -The addons chart installs a collection of supporting services and tools required for a Pega deployment. The services you will need to deploy will depend on your cloud environment - for example you may need a load balancer on Minikube, but not for EKS. These supporting services are deployed once per Kubernetes environment, regardless of how many Pega Infinity instances are deployed. This readme provides a detailed description of possible configurations and their default values as applicable. +The addons chart installs a collection of supporting services and tools for a Pega deployment. The services you need to deploy will depend on your cloud environment - for example you may need a load balancer on Minikube, but not for EKS. These supporting services are deployed once per Kubernetes environment, regardless of how many Pega Infinity instances are deployed. This readme provides a detailed description of possible configurations and their default values as applicable. + +Pega does **not** actively update the dependencies in `requirements.yaml`. Whether a dependency is enabled or disabled will depend on the service you choose for your environment. For any enabled dependencies listed in the `requirements.yaml` file, you should update its corresponding `version` value. Disabled dependencies do not require version updates. ## Load balancer diff --git a/charts/addons/requirements.yaml b/charts/addons/requirements.yaml index 1063745b3..3d12c65e7 100644 --- a/charts/addons/requirements.yaml +++ b/charts/addons/requirements.yaml @@ -1,3 +1,6 @@ +# Pega does NOT actively update these dependencies. For each dependency, you should: +# * Update the dependency's 'version' value, or +# * Disable the dependency by setting its condition value (for example, 'traefik.enabled') to false in values.yaml. dependencies: - name: traefik version: "1.77.1" diff --git a/charts/backingservices/README.md b/charts/backingservices/README.md index 631ae7ed8..1721d9dcd 100644 --- a/charts/backingservices/README.md +++ b/charts/backingservices/README.md @@ -30,6 +30,10 @@ If an externally managed elasticsearch cluster is being used, make sure the serv You may enable the component of [Elasticsearch](https://github.com/helm/charts/tree/master/stable/elasticsearch/values.yaml) in the backingservices by configuring the 'srs.srsStorage' section in values.yaml file to deploy ElasticSearch cluster automatically. For more configuration options available for each of the components, see their Helm Charts. +Note: Pega does **not** actively update the elasticsearch dependency in `requirements.yaml`. To leverage SRS, you should: +* Update the elasticsearch `version` value, or +* Disable deploying elasticsearch by setting `srs.srsStorage.provisionInternalESCluster` to false. + ### Configuration settings Configuration | Usage diff --git a/charts/backingservices/requirements.yaml b/charts/backingservices/requirements.yaml index aa5eeffce..547029e24 100644 --- a/charts/backingservices/requirements.yaml +++ b/charts/backingservices/requirements.yaml @@ -1,3 +1,6 @@ +# Pega does NOT actively update this elasticsearch dependency. To leverage SRS, you should: +# * Update the elasticsearch 'version' value, or +# * Disable deploying elasticsearch by setting 'srs.srsStorage.provisionInternalESCluster' to false. dependencies: - name: elasticsearch version: "7.9.3" diff --git a/charts/pega/README.md b/charts/pega/README.md index c2db9d0e1..94bc5ad56 100644 --- a/charts/pega/README.md +++ b/charts/pega/README.md @@ -606,6 +606,8 @@ dds: You may deploy a Cassandra instance along with Pega. Cassandra is a separate technology and needs to be independently managed. When deploying Cassandra, set `cassandra.enabled` to `true` and leave the `dds` section as-is. For more information about configuring Cassandra, see the [Cassandra Helm charts](https://github.com/helm/charts/blob/master/incubator/cassandra/values.yaml). +Pega does **not** actively update the Cassandra dependency in `requirements.yaml`. When deploying Cassandra with Pega, you should update its `version` value in `requirements.yaml`. + #### Cassandra minimum resource requirements Deployment | CPU | Memory diff --git a/charts/pega/requirements.yaml b/charts/pega/requirements.yaml index 245dd50cc..fd2bc5000 100644 --- a/charts/pega/requirements.yaml +++ b/charts/pega/requirements.yaml @@ -1,3 +1,6 @@ +# Pega does NOT actively update this Cassandra dependency. To leverage Cassandra, you should: +# * Update the cassandra 'version' value, or +# * Disable deploying cassandra by setting 'cassandra.enabled' to false. dependencies: - name: cassandra version: "0.13.3" diff --git a/docs/Deploying-Pega-on-AKS.md b/docs/Deploying-Pega-on-AKS.md index 93f119ae0..407d9d681 100644 --- a/docs/Deploying-Pega-on-AKS.md +++ b/docs/Deploying-Pega-on-AKS.md @@ -358,7 +358,7 @@ To customize these files, you must download them from the source github reposito $ helm search repo pega NAME CHART VERSION APP VERSION DESCRIPTION pega/pega 1.4.4 Helm chart to configure required installation and deployment configuration settings in your environment for your deployment. - pega/addons 1.4.4 1.0 Helm chart to configure required supporting services and tools in your environment for your deployment. + pega/addons 1.4.4 1.0 Helm chart to configure supporting services and tools in your environment for your deployment. pega/backingservices 1.4.4 Helm Chart to provision the latest Search and Reporting Service (SRS) for your Pega Infinity deployment ``` diff --git a/docs/Deploying-Pega-on-EKS.md b/docs/Deploying-Pega-on-EKS.md index 1ab3dcfca..402bf45af 100644 --- a/docs/Deploying-Pega-on-EKS.md +++ b/docs/Deploying-Pega-on-EKS.md @@ -414,7 +414,7 @@ To customize these files, you must download them from the source github reposito $ helm search repo pega NAME CHART VERSION APP VERSION DESCRIPTION pega/pega 1.4.4 Helm chart to configure required installation and deployment configuration settings in your environment for your deployment. - pega/addons 1.4.4 1.0 Helm chart to configure required supporting services and tools in your environment for your deployment. + pega/addons 1.4.4 1.0 Helm chart to configure supporting services and tools in your environment for your deployment. pega/backingservices 1.4.4 Helm Chart to provision the latest Search and Reporting Service (SRS) for your Pega Infinity deployment ``` diff --git a/docs/Deploying-Pega-on-GKE.md b/docs/Deploying-Pega-on-GKE.md index 1c8ee0013..159a3293d 100644 --- a/docs/Deploying-Pega-on-GKE.md +++ b/docs/Deploying-Pega-on-GKE.md @@ -213,7 +213,7 @@ To customize these files, you must download them from the source github reposito $ helm search repo pega NAME CHART VERSION APP VERSION DESCRIPTION pega/pega 1.4.4 Helm chart to configure required installation and deployment configuration settings in your environment for your deployment. - pega/addons 1.4.4 1.0 Helm chart to configure required supporting services and tools in your environment for your deployment. + pega/addons 1.4.4 1.0 Helm chart to configure supporting services and tools in your environment for your deployment. pega/backingservices 1.4.4 Helm Chart to provision the latest Search and Reporting Service (SRS) for your Pega Infinity deployment ``` diff --git a/docs/Deploying-Pega-on-PKS.md b/docs/Deploying-Pega-on-PKS.md index ab21ec94a..74e39fc0b 100644 --- a/docs/Deploying-Pega-on-PKS.md +++ b/docs/Deploying-Pega-on-PKS.md @@ -173,7 +173,7 @@ To customize these files, you must download them from the source github reposito $ helm search repo pega NAME CHART VERSION APP VERSION DESCRIPTION pega/pega 1.4.4 Helm chart to configure required installation and deployment configuration settings in your environment for your deployment. - pega/addons 1.4.4 1.0 Helm chart to configure required supporting services and tools in your environment for your deployment. + pega/addons 1.4.4 1.0 Helm chart to configure supporting services and tools in your environment for your deployment. pega/backingservices 1.4.4 Helm Chart to provision the latest Search and Reporting Service (SRS) for your Pega Infinity deployment ``` diff --git a/docs/Deploying-Pega-on-openshift.md b/docs/Deploying-Pega-on-openshift.md index 666a73ef5..d69206078 100644 --- a/docs/Deploying-Pega-on-openshift.md +++ b/docs/Deploying-Pega-on-openshift.md @@ -153,7 +153,7 @@ To customize these files, you must download them from the source github reposito $ helm search repo pega NAME CHART VERSION APP VERSION DESCRIPTION pega/pega 1.6.1 Helm chart to configure required installation and deployment configuration settings in your environment for your deployment. - pega/addons 1.6.1 1.0 Helm chart to configure required supporting services and tools in your environment for your deployment. + pega/addons 1.6.1 1.0 Helm chart to configure supporting services and tools in your environment for your deployment. pega/backingservices 1.6.1 Helm Chart to provision the latest Search and Reporting Service (SRS) for your Pega Infinity deployment ``` diff --git a/docs/upgrading-pega-deployment-zero-downtime.md b/docs/upgrading-pega-deployment-zero-downtime.md index ecf0d70ff..426c1c135 100644 --- a/docs/upgrading-pega-deployment-zero-downtime.md +++ b/docs/upgrading-pega-deployment-zero-downtime.md @@ -83,7 +83,7 @@ To complete an upgrade using the charts in the Pega-provided repository of Helm $ helm search repo pega NAME CHART VERSION APP VERSION DESCRIPTION pega/pega 1.6.0 Helm chart to configure required installation and deployment configuration settings in your environment for your deployment. - pega/addons 1.6.0 1.0 Helm chart to configure required supporting services and tools in your environment for your deployment. + pega/addons 1.6.0 1.0 Helm chart to configure supporting services and tools in your environment for your deployment. pega/backingservices 1.6.0 Helm Chart to provision the latest Search and Reporting Service (SRS) for your Pega Infinity deployment ``` From 594dff2d6ea200e8d070dc05770fc72e12b1c60e Mon Sep 17 00:00:00 2001 From: talba Date: Fri, 27 Aug 2021 15:19:16 -0400 Subject: [PATCH 2/3] Add link to support guide --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c42706512..0a0a6d50d 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,8 @@ $ helm inspect values pega/backingservices > backingservices.yaml * [Instructions to configure the Pega addons](charts/addons/README.md) * [Instructions to configure the Pega backingservices](charts/backingservices/README.md) +When making customizations for your environment, verify that those changes are supported by your version of Pega. You can check this information in the [Pega Platform Support Guide Resources](https://community.pega.com/knowledgebase/articles/pega-platform-support-guide-resources). + 5. Create namespaces for your Pega deployment, backingservices and the addons (if applicable for your environment). ```bash From addd6a0b3d7b29c6555dbf510b89d2455e65ea69 Mon Sep 17 00:00:00 2001 From: talba Date: Fri, 27 Aug 2021 15:25:51 -0400 Subject: [PATCH 3/3] Improved wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a0a6d50d..03b1073e9 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ $ helm inspect values pega/backingservices > backingservices.yaml * [Instructions to configure the Pega addons](charts/addons/README.md) * [Instructions to configure the Pega backingservices](charts/backingservices/README.md) -When making customizations for your environment, verify that those changes are supported by your version of Pega. You can check this information in the [Pega Platform Support Guide Resources](https://community.pega.com/knowledgebase/articles/pega-platform-support-guide-resources). +When making customizations for your environment, check the [Pega Platform Support Guide Resources](https://community.pega.com/knowledgebase/articles/pega-platform-support-guide-resources) to verify that those changes are supported by your Pega Platform version. 5. Create namespaces for your Pega deployment, backingservices and the addons (if applicable for your environment).