Update documentation to reflect Pega's stance on dependent charts (#330)

* Update documentation to reflect Pega's stance on dependent charts * Add link to support guide * Improved wording overall
pegasystems · Aug 27, 2021 · 2204a8f · 2204a8f
1 parent fdbeb15
commit 2204a8f
Show file tree

Hide file tree

Showing 13 changed files with 29 additions and 10 deletions.
diff --git 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.
 
@@ -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, 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).
 
 ```bash

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
 ```