From a578c2db4b8f21888c348ac0584515285436e53d Mon Sep 17 00:00:00 2001 From: Dave Casavant Date: Fri, 31 Jan 2020 21:15:29 -0500 Subject: [PATCH] Add linting and validation of markdown links (#90) * Update .travis.yml * Fix broken links --- .remark_ignore | 2 ++ .travis.yml | 2 ++ CONTRIBUTING.md | 2 +- charts/pega/README.md | 6 ++-- docs/Deploying-Pega-on-AKS.md | 28 +++++++++---------- docs/Deploying-Pega-on-GKE.md | 22 +++++++-------- docs/Deploying-Pega-on-PKS.md | 14 +++++----- docs/RUNBOOK_MINIKUBE.md | 2 +- docs/prepping-local-system-runbook-linux.md | 12 ++++---- docs/prepping-local-system-runbook-windows.md | 12 ++++---- 10 files changed, 53 insertions(+), 49 deletions(-) create mode 100644 .remark_ignore diff --git a/.remark_ignore b/.remark_ignore new file mode 100644 index 000000000..0b7e43d6b --- /dev/null +++ b/.remark_ignore @@ -0,0 +1,2 @@ +linux-amd64/ +terratest/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index dbd8cd128..120519fc7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,6 +12,7 @@ install: - helm init --client-only # Install YamlLint - sudo pip install yamllint=="${YAMLLINT_VERSION}" + - npm install -g --save remark-cli to-vfile remark-preset-lint-recommended remark-validate-links remark-lint-no-dead-urls remark-message-control remark-preset-lint-markdown-style-guide remark-lint # Install Go - wget -c https://storage.googleapis.com/golang/go1.7.3.linux-amd64.tar.gz - sudo tar -C /usr/local -xvzf go1.7.3.linux-amd64.tar.gz @@ -19,6 +20,7 @@ install: script: - yamllint -c .yamllint.yml -s $(find . -type f -name "Chart.yaml") - yamllint -c .yamllint.yml -s $(find . -type f -name "values*.yaml") + - remark -i .remark_ignore -f -u validate-links . # Now load the helm dependencies - make dependencies # Run Helm lint diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0570fb4d5..fe43dd05a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,4 +37,4 @@ # Additional Resources * [General GitHub documentation](https://help.github.com/) -* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) +* [GitHub pull request documentation](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) diff --git a/charts/pega/README.md b/charts/pega/README.md index d6b250a66..b5eba1d24 100644 --- a/charts/pega/README.md +++ b/charts/pega/README.md @@ -151,7 +151,7 @@ stream | Nodes that run an embedded deployment of Kafka and are exposed t #### Small deployment with a single tier -To get started running a personal deployment of Pega on kubernetes, you can handle all processing on a single tier. This configuration provides the most resource utilization efficiency when the characteristics of a production deployment are not necessary. The [values-small.yaml](relative-link-here) configuration provides a starting point for this simple model. +To get started running a personal deployment of Pega on kubernetes, you can handle all processing on a single tier. This configuration provides the most resource utilization efficiency when the characteristics of a production deployment are not necessary. The [values-minimal.yaml](./values-minimal.yaml) configuration provides a starting point for this simple model. Tier Name | Description --- | --- @@ -159,7 +159,7 @@ pega | One tier handles all foreground and background processing and is g #### Large deployment for production isolation of processing -To run a larger scale Pega deployment in production, you can split additional processing out to dedicated tiers. The [values-large.yaml](relative-link-here) configuration provides an example of a multi-tier deployment that Pega recommends as a good starting point for larger deployments. +To run a larger scale Pega deployment in production, you can split additional processing out to dedicated tiers. The [values-large.yaml](./values-large.yaml) configuration provides an example of a multi-tier deployment that Pega recommends as a good starting point for larger deployments. Tier Name | Description --- | --- @@ -185,7 +185,7 @@ Node classification is the process of separating nodes by purpose, predefining t Specify the list of Pega node types for this deployment. For more information about valid node types, see the Pega Community article on [Node Classification]. -[Node types for client-managed cloud environments](http://doc-build02.rpega.com/docs-oxygen/procomhelpmain.htm#engine/node-classification/eng-node-types-client-managed-cloud-ref.htm) +[Node types for client-managed cloud environments](https://community.pega.com/knowledgebase/articles/performance/node-classification) Example: diff --git a/docs/Deploying-Pega-on-AKS.md b/docs/Deploying-Pega-on-AKS.md index a1a9588e4..8fbb64dc9 100644 --- a/docs/Deploying-Pega-on-AKS.md +++ b/docs/Deploying-Pega-on-AKS.md @@ -14,16 +14,16 @@ Use Kubernetes tools and the customized orchestration tools and Docker images to 1. Prepare your local system: - - To prepare a local Linux system, install required applications and configuration files - [Preparing your local Linux system – 45 minutes](https://github.com/pegasystems/pega-helm-charts/blob/master/docs/prepping-local-system-runbook-linux.md). + - To prepare a local Linux system, install required applications and configuration files - [Preparing your local Linux system – 45 minutes](prepping-local-system-runbook-linux.md). - To prepare a local Windows system, install required applications and configuration files - - [Preparing your local Windows 10 system – 45 minutes](https://github.com/pegasystems/pega-helm-charts/blob/master/docs/prepping-local-system-runbook-windows.md). + [Preparing your local Windows 10 system – 45 minutes](prepping-local-system-runbook-windows.md). 2. Create an AKS cluster and an SQL database resource in your Azure account - [Prepare your AKS resources – 45 minutes](#prepare-your-aks-resources--45-minutes). 3. Customize a configuration file with your AKS details and use the command-line tools, kubectl and Helm, to install and then deploy Pega Platform onto your AKS cluster - [Deploying Pega Platform using Helm charts – 90 minutes](#installing-and-deploying-pega-platform-using-helm-charts--90-minutes). -4. Configure your network connections in the DNS management zone of your choice so you can log in to Pega Platform - [Logging into Pega Platform – 10 minutes](#logging-into-pega-platform--10-minutes). +4. Configure your network connections in the DNS management zone of your choice so you can log in to Pega Platform - [Logging in to Pega Platform – 10 minutes](#logging-in-to-pega-platform--10-minutes). To understand how Pega maps Kubernetes objects with Pega applications and services, see [How Pega Platform and applications are deployed on Kubernetes](https://community.pega.com/knowledgebase/articles/cloud-choice/how-pega-platform-and-applications-are-deployed-kubernetes). @@ -296,15 +296,15 @@ Configure the parameters so the pega.yaml Helm chart matches your deployment res | Jdbc.driverUri: | Specify the database driver Pega Platform uses during the deployment. For AKS, we can obtain the URL of the required 7.4.1. driver file that is publicly available in the referenced Maven repository. | driverUri: "https://repo1.maven.org/maven2/com/microsoft/sqlserver/mssql-jdbc/7.4.1.jre11/mssql-jdbc-7.4.1.jre11.jar" | | Jdbc: username: password: | Set the security credentials for your database server to allow installation of Pega Platform into your database. | | | jdbc.rulesSchema: jdbc.dataSchema: | Set the names of both your rules and the data schema to the values that Pega Platform uses for these two schemas. | rulesSchema: "rules" dataSchema: "data" | -| docker.registry.url: username: password: | Map the host name of a registry to an object that contains the “username” and “password” values for that registry. For more information, search for “index.docker.io/v1” in [Engine API v1.24](https://docs.docker.com/engine/api/v1.24/). | | +| docker.registry.url: username: password: | Map the host name of a registry to an object that contains the “username” and “password” values for that registry. For more information, search for “index.docker.io/v1” in [Engine API v1.24](https://docs.docker.com/engine/api/v1.24/). | | | docker.pega.image: | Refer to the latest Pega Platform deployment image on DockerHub. | | | upgrade: | Do not set for installations or deployments. | upgrade: for non-upgrade, keep the default value. | | tier.name: ”web” tier.service.domain:| Set a host name for the pega-web service of the DNS zone. | | | tier.name: ”stream” tier.service.domain: | Set the host name for the pega-stream service of the DNS zone. | | -| installer.image: | Specify the Docker image you built to install Pega Platform. | | +| installer.image: | Specify the Docker image you built to install Pega Platform. | | | installer. adminPassword: | Specify a password for your initial log in to Pega Platform. | adminPassword: "\" | -3. Save the file. +1. Save the file. ### Deploy Pega Platform using the command line @@ -315,15 +315,15 @@ automatically followed by a deploy. In subsequent Helm deployments, you should n 1. Do one of the following: -- Open Windows PowerShell running as Administrator on your local system and change the location to the top folder of your aks-demo folder that you created in [Preparing your local Windows 10 system](https://github.com/pegasystems/pega-helm-charts/blob/master/docs/prepping-local-system-runbook-windows.md). +- Open Windows PowerShell running as Administrator on your local system and change the location to the top folder of your aks-demo folder that you created in [Preparing your local Windows 10 system](prepping-local-system-runbook-windows.md). `$ cd \aks-demo` -- Open a Linux bash shell and change the location to the top folder of your aks-demo directory that you created in [Preparing your local Linux system](https://github.com/pegasystems/pega-helm-charts/blob/master/docs/prepping-local-system-runbook-linux.md). +- Open a Linux bash shell and change the location to the top folder of your aks-demo directory that you created in [Preparing your local Linux system](prepping-local-system-runbook-linux.md). `$ cd /home//aks-demo` -2. Use the Azure CLI to log into your account. +1. Use the Azure CLI to log into your account. `$ az login` @@ -373,15 +373,15 @@ Merged "runbook-demo" as current context in \.kube 10. Do one of the following: -- Open a new Windows PowerShell running as Administrator on your local system and change the location to the top folder of your aks-demo folder that you created in [Create a local folder to access all of the configuration files](#create-a-local-folder-to-access-all-of-the-configuration-files). +- Open a new Windows PowerShell running as Administrator on your local system and change the location to the top folder of your aks-demo folder that you created in [Create a local folder to access all of the configuration files](prepping-local-system-runbook-windows.md#creating-a-local-folder-to-access-all-of-the-configuration-files). `$ cd \\aks-demo` -- Open a new Linux bash shell and change the location to the top folder of your aks-demo directory that you created in [Create a local folder to access all of the configuration files](#create-a-local-folder-to-access-all-of-the-configuration-files). +- Open a new Linux bash shell and change the location to the top folder of your aks-demo directory that you created in [Create a local folder to access all of the configuration files](prepping-local-system-runbook-linux.md#creating-a-local-folder-to-access-all-of-the-configuration-files). `$ cd /home//aks-demo` -11. Create namespaces in preparation for the pega.yaml and addons.yaml deployments. +1. Create namespaces in preparation for the pega.yaml and addons.yaml deployments. ```yaml $ kubectl create namespace mypega @@ -390,7 +390,7 @@ $ kubectl create namespace pegaaddons namespace/pegaaddons created ``` -12. Install the addons chart, which you updated in [Preparing your local system](#Prepare-your-local-system-–-45-minutes). +12. Install the addons chart, which you updated in [Preparing your AKS resources](#prepare-your-aks-resources--45-minutes). ```yaml $ helm install addons pega/addons --namespace pegaaddons --values addons.yaml @@ -483,6 +483,6 @@ The mypega-web node is the only tier with an externally exposed IP address. Note ![](media/ccb6329a621c6f11970e25531cfa1857.png) -With the ingress host name name associated with this IP address in your DNS service, you can log in to Pega Platform with a web browser using the URL: http://\/prweb. +With the ingress host name name associated with this IP address in your DNS service, you can log in to Pega Platform with a web browser using the URL: `http://\/prweb`. ![](media/25b18c61607e4e979a13f3cfc1b64f5c.png) diff --git a/docs/Deploying-Pega-on-GKE.md b/docs/Deploying-Pega-on-GKE.md index d80ef0a75..e302aa021 100644 --- a/docs/Deploying-Pega-on-GKE.md +++ b/docs/Deploying-Pega-on-GKE.md @@ -12,13 +12,13 @@ Deployment process overview Use Kubernetes tools and the customized orchestration tools and Docker images to orchestrate a deployment in a GKE cluster that you create for the deployment: -1. Prepare your local system using [Preparing your local Linux system – 45 minutes](https://github.com/pegasystems/pega-helm-charts/blob/master/docs/prepping-local-system-runbook-linux.md) – install required applications and configuration files. +1. Prepare your local system using [Preparing your local Linux system – 45 minutes](prepping-local-system-runbook-linux.md) – install required applications and configuration files. -2. Create a GKE cluster and a Postgres database in an SQL instance in your Google Cloud Platform (GPC) account - [Prepare your GKE resources – 45 minutes](#prepare-your-resources--45-minutes). +2. Create a GKE cluster and a Postgres database in an SQL instance in your Google Cloud Platform (GPC) account - [Preparing your GKE resources – 45 minutes](#preparing-your-gke-resources--45-minutes). 3. Customize a configuration file with your GKE details and use the command-line tools, kubectl and Helm, to install and then deploy Pega Platform onto your GKE cluster - [Deploying Pega Platform using Helm charts – 90 minutes](#installing-and-deploying-pega-platform-using-helm-charts--90-minutes). -4. Configure your network connections in the DNS management zone of your choice so you can log in to Pega Platform - [Logging into Pega Platform – 10 minutes](#logging-into-pega-platform--10-minutes). +4. Configure your network connections in the DNS management zone of your choice so you can log in to Pega Platform - [Logging in to Pega Platform – 10 minutes](#logging-in-to-pega-platform--10-minutes). To understand how Pega maps Kubernetes objects with Pega applications and services, see [How Pega Platform and applications are deployed on Kubernetes](https://community.pega.com/knowledgebase/articles/cloud-choice/how-pega-platform-and-applications-are-deployed-kubernetes). @@ -55,7 +55,7 @@ Creating a Google Cloud Platform project - 5 minutes ----------------------------------------- To deploy Pega Platform to a GKE cluster, you must create a Google Cloud project in which you will create your Kubernetes cluster resources. -1. Using the web browser of your choice, log in to [GCP](#https://cloud.google.com/) with your GCP account credentials. +1. Using the web browser of your choice, log in to [GCP](https://cloud.google.com/) with your GCP account credentials. 2. Click **Console** next to your profile name to open the GCP console page. @@ -230,15 +230,15 @@ Configure the parameters so the pega.yaml Helm chart matches your deployment res | Jdbc.driverUri: | Specify the database driver Pega Platform uses during the deployment.|
  • driverUri: "latest jar file available”
  • For PostgreSQL databases, use the URL of the latest PostgreSQL driver file that is publicly available at .
|| | Jdbc: username: password: | Set the security credentials for your database server to allow installation of Pega Platform into your database. |
  • username: "\"
  • password: "\"
  • -- For GCP PostgreSQL databases, the default user is “postgres”.
| | jdbc.rulesSchema: jdbc.dataSchema: | Set the names of both your rules and the data schema to the values that Pega Platform uses for these two schemas. | rulesSchema: "rules" dataSchema: "data" | -| docker.registry.url: username: password: | Map the host name of a registry to an object that contains the “username” and “password” values for that registry. For more information, search for “index.docker.io/v1” in [Engine API v1.24](https://docs.docker.com/engine/api/v1.24/). |
  • url: “”
  • username: "\"
  • password: "\< DockerHub account password\>"
| +| docker.registry.url: username: password: | Map the host name of a registry to an object that contains the “username” and “password” values for that registry. For more information, search for “index.docker.io/v1” in [Engine API v1.24](https://docs.docker.com/engine/api/v1.24/). |
  • url: “https://index.docker.io/v1/”
  • username: "\"
  • password: "\< DockerHub account password\>"
| | docker.pega.image: | Refer to the latest Pega Platform deployment image on DockerHub. |
  • Image: "pegasystems/pega:latest"
  • For a list of default images that Pega provides:
| | upgrade: | Do not set for installations or deployments. | upgrade: for non-upgrade, keep the default value. | | tier.name: ”web” tier.service.domain:| Set a host name for the pega-web service of the DNS zone. |
  • domain: "\"
  • Assign this host name with an external IP address and log into Pega Platform with this host name in the URL. Your web tier host name must comply with your networking standards and be available as an external IP address.
| | tier.name: ”stream” tier.service.domain: | Set the host name for the pega-stream service of the DNS zone. |
  • domain: "\"
  • Your stream tier host name should comply with your networking standards.
| -| installer.image: | Specify the Docker image you built to install Pega Platform. |
  • Image: "\"
  • You created this image in [Preparing your local Linux system](docs/prepping-local-system-runbook-linux.md)
| +| installer.image: | Specify the Docker image you built to install Pega Platform. |
  • Image: "\"
  • You created this image in [Preparing your local Linux system](prepping-local-system-runbook-linux.md)
| | installer. adminPassword: | Specify a password for your initial log in to Pega Platform. | adminPassword: "\" | -3. Save the file. +1. Save the file. ### Deploy Pega Platform using the command line @@ -247,7 +247,7 @@ A Helm installation and a Pega Platform installation are separate processes. The In this document, you specify that the Helm chart always “deploys” by using the setting, actions.execute: “deploy”. In the following tasks, you overwrite this function on your *initial* Helm install by specifying `--set global.actions.execute:install-deploy`, which invokes an installation of Pega Platform using your installation Docker image and then automatically followed by a deploy. In subsequent Helm deployments, you should not use the override argument, `--set global.actions.execute=`, since Pega Platform is already installed in your database. -1. Open a Linux bash shell and change the location to the top folder of your gke-demo directory that you created in [Preparing your local Linux system](docs/prepping-local-system-runbook-linux.md). +1. Open a Linux bash shell and change the location to the top folder of your gke-demo directory that you created in [Preparing your local Linux system](prepping-local-system-runbook-linux.md). `$ cd /home//gke-demo` @@ -344,7 +344,7 @@ $ kubectl create clusterrolebinding dashboard-admin -n kube-system --clusterrole 11. To access the Dashboard UI, open a web browser and navigate to the following URL: - +`http://localhost:8001/api/v1/namespaces/kube-system/services/https:kubernetes-dashboard:/proxy/` 12. In the **Kubernetes Dashboard** sign in window, choose the appropriate authentication method: @@ -370,7 +370,7 @@ $ kubectl create namespace pegaaddons namespace/pegaaddons created ``` -15. Install the addons chart, which you updated in [Preparing your local system](#Prepare-your-local-system-–-45-minutes). +15. Install the addons chart, which you updated in [Preparing your local system](#preparing-your-gke-resources--45-minutes). ```yaml $ helm install addons pega/addons --namespace pegaaddons --values addons.yaml @@ -444,6 +444,6 @@ For GCP **Cloud DNS** documentation details, see [Quickstart](https://cloud.goog ### Logging in by using the domain name of the web tier -With the ingress host name name associated with this IP address in your DNS service, you can log in to Pega Platform with a web browser using the URL: http://\/prweb. +With the ingress host name name associated with this IP address in your DNS service, you can log in to Pega Platform with a web browser using the URL: `http://\/prweb`. ![](media/25b18c61607e4e979a13f3cfc1b64f5c.png) diff --git a/docs/Deploying-Pega-on-PKS.md b/docs/Deploying-Pega-on-PKS.md index 94001e95c..f06fcb2e1 100644 --- a/docs/Deploying-Pega-on-PKS.md +++ b/docs/Deploying-Pega-on-PKS.md @@ -23,7 +23,7 @@ Use Kubernetes tools and the customized orchestration tools and Docker images to 3. Customize a configuration file with your PKS details and use the command-line tools, kubectl and Helm, to install and then deploy Pega Platform onto your PKS cluster - [Deploying Pega Platform using Helm charts – 90 minutes](#installing-and-deploying-pega-platform-using-helm-charts--90-minutes). -4. Configure your network connections in the DNS management zone of your choice so you can log in to Pega Platform - [Logging into Pega Platform – 10 minutes](#logging-into-pega-platform--10-minutes). +4. Configure your network connections in the DNS management zone of your choice so you can log in to Pega Platform - [Logging in to Pega Platform – 10 minutes](#logging-in-to-pega-platform--10-minutes). To understand how Pega maps Kubernetes objects with Pega applications and services, see [How Pega Platform and applications are deployed on Kubernetes](https://community.pega.com/knowledgebase/articles/cloud-choice/how-pega-platform-and-applications-are-deployed-kubernetes). @@ -197,15 +197,15 @@ Configure the parameters so the pega.yaml Helm chart matches your deployment res | Jdbc.driverUri: | Specify the database driver Pega Platform uses during the deployment.|
  • driverUri: "latest jar file available”
  • For PostgreSQL databases, use the URL of the latest PostgreSQL driver file that is publicly available at .
| | Jdbc: username: password: | Set the security credentials for your database server to allow installation of Pega Platform into your database. |
  • username: "\"
  • password: "\"
  • -- For GCP PostgreSQL databases, the default user is “postgres”.
| | jdbc.rulesSchema: jdbc.dataSchema: | Set the names of both your rules and the data schema to the values that Pega Platform uses for these two schemas. | rulesSchema: "rules" dataSchema: "data" | -| docker.registry.url: username: password: | Map the host name of a registry to an object that contains the “username” and “password” values for that registry. For more information, search for “index.docker.io/v1” in [Engine API v1.24](https://docs.docker.com/engine/api/v1.24/). |
  • url: “”
  • username: "\"
  • password: "\< DockerHub account password\>"
| +| docker.registry.url: username: password: | Map the host name of a registry to an object that contains the “username” and “password” values for that registry. For more information, search for “index.docker.io/v1” in [Engine API v1.24](https://docs.docker.com/engine/api/v1.24/). |
  • url: “https://index.docker.io/v1/”
  • username: "\"
  • password: "\< DockerHub account password\>"
| | docker.pega.image: | Refer to the latest Pega Platform deployment image on DockerHub. |
  • Image: "pegasystems/pega:latest"
  • For a list of default images that Pega provides:
| | upgrade: | Do not set for installations or deployments. | upgrade: for non-upgrade, keep the default value. | | tier.name: ”web” tier.service.domain:| Set a host name for the pega-web service of the DNS zone. |
  • domain: "\"
  • Assign this host name with an external IP address and log into Pega Platform with this host name in the URL. Your web tier host name must comply with your networking standards and be available as an external IP address.
| | tier.name: ”stream” tier.service.domain: | Set the host name for the pega-stream service of the DNS zone. |
  • domain: "\"
  • Your stream tier host name should comply with your networking standards.
| -| installer.image: | Specify the Docker image you built to install Pega Platform. |
  • Image: "\"
  • You created this image in [Preparing your local Linux system](docs/prepping-local-system-runbook-linux.md)
| +| installer.image: | Specify the Docker image you built to install Pega Platform. |
  • Image: "\"
  • You created this image in [Preparing your local Linux system](prepping-local-system-runbook-linux.md)
| | installer. adminPassword: | Specify a password for your initial log in to Pega Platform. | adminPassword: "\" | -3. Save the file. +1. Save the file. ### Deploy Pega Platform using the command line @@ -261,7 +261,7 @@ If you need to use a Bearer Token Access Credentials instead of this credential 8. To access the Dashboard UI, open a web browser and navigate to the following URL: - +`http://localhost:8001/api/v1/namespaces/kube-system/services/https:kubernetes-dashboard:/proxy/` 9. In the **Kubernetes Dashboard** sign in window, choose the appropriate sign in method: @@ -292,7 +292,7 @@ $ kubectl create namespace pegaaddons namespace/pegaaddons created ``` -12. Install the addons chart, which you updated in [Preparing your local system](#Prepare-your-local-system-–-45-minutes). +1. Install the addons chart, which you updated in [Preparing your local system](#prepare-your-resources--45-minutes). ```yaml $ helm install addons pega/addons --namespace pegaaddons --values addons.yaml @@ -353,6 +353,6 @@ To manually associate the host name of the pega-web tier ingress with the tier e For GCP **Cloud DNS** documentation details, see [Quickstart](https://cloud.google.com/dns/docs/quickstart). If not using the GCP **Cloud DNS**, for configuration details, see the documentation for your DNS lookup management system. -With the ingress host name name associated with this IP address in your DNS service, you can log in to Pega Platform with a web browser using the URL: http://\/prweb. +With the ingress host name name associated with this IP address in your DNS service, you can log in to Pega Platform with a web browser using the URL: `http://\/prweb`. ![](media/25b18c61607e4e979a13f3cfc1b64f5c.png) diff --git a/docs/RUNBOOK_MINIKUBE.md b/docs/RUNBOOK_MINIKUBE.md index 84d87aecc..2c7b892d8 100644 --- a/docs/RUNBOOK_MINIKUBE.md +++ b/docs/RUNBOOK_MINIKUBE.md @@ -60,7 +60,7 @@ minikube ip can be fetched using command - ``` minikube ip``` and Pega service N Start minikube with at least 4 CPU’s and 10GB memory for complete pega deployment. As per the need increase the limits of minikube. ***Note*** -1. Use “values-minimal.yaml” to deploy pega which is available in the [pega chart](\pega-helm-charts\charts\pega) directory. +1. Use “values-minimal.yaml” to deploy pega which is available in the [pega chart](../charts/pega) directory. Example helm command to deploy diff --git a/docs/prepping-local-system-runbook-linux.md b/docs/prepping-local-system-runbook-linux.md index 185debe3e..172ab0478 100644 --- a/docs/prepping-local-system-runbook-linux.md +++ b/docs/prepping-local-system-runbook-linux.md @@ -177,7 +177,7 @@ To install the Google Cloud SDK: 2. Ensure that Python 2.7 is installed. -3. Download the appropriate Google SDK distribution for your Linux version. See [Installing from versioned archives](#https://cloud.google.com/sdk/docs/downloads-versioned-archives). There are also versions available for Debian and Ubuntu or Red Hat and CentOS Linux. +3. Download the appropriate Google SDK distribution for your Linux version. See [Installing from versioned archives](https://cloud.google.com/sdk/docs/downloads-versioned-archives). There are also versions available for Debian and Ubuntu or Red Hat and CentOS Linux. 3. Extract the Google SDK distribution archive file to your system. @@ -236,7 +236,7 @@ Run `gcloud topic configurations` to learn more. `gcloud info` -These instructions were sourced from the Google document, [Quickstart for Linux](#https://cloud.google.com/sdk/docs/quickstart-linux), which includes additional information. +These instructions were sourced from the Google document, [Quickstart for Linux](https://cloud.google.com/sdk/docs/quickstart-linux), which includes additional information. ### Installing Docker @@ -388,8 +388,8 @@ The Pega deployment model supports advanced configurations to fit most existing - prconfig.xml: adjust the standard Pega Platform configuration with known, required settings -Make these changes before you begin in the section, [Deploying Pega Platform -using Helm charts – 30 minutes](#_Deploying_Pega_Platform). +Make these changes before you begin deploying Pega Platform +using Helm charts. Downloading a Pega Platform distribution to your local system ------------------------------------------------------------- @@ -398,7 +398,7 @@ These instructions require the Pega Platform distribution image to install the P ### Requesting access to a Pega Platform distribution -1. In the browser of your choice, navigate to the Pega [Digital Software Delivery](https://community1.pega.com/digital-delivery) site. +1. In the browser of your choice, navigate to the Pega [Digital Software Delivery](https://community.pega.com/digital-delivery) site. 2. Log into the [Pega Community](https://community.pega.com/knowledgebase/articles/pega-cloud/pega-cloud-services-patch-process-releases-83x-and-later) site with the credentials your Pega representative provided. @@ -480,7 +480,7 @@ Prepare your Pega Platform installation Docker image – 15 minutes As stated previously, you must have a [DockerHub](https://hub.docker.com/) account and log into it in order to see the [pega-installer-ready Docker image](https://hub.docker.com/r/pegasystems/pega-installer-ready). You also need the Docker cli and Docker-desktop installed on your system before you begin this procedure. The Pega-provided Docker image, pega-installer-ready, includes some components of a full installation image that you can use to install or upgrade the Pega Platform database. While it is built on top of a JDK, it does not contain the contents of the Pega distribution kit which are essential for installing or upgrading Pega Platform. -Pega provides this image as the primary content of the final Docker image you will use to install or upgrade Pega Platform. This section describes how you can use this Docker image in combination with a Dockerfile and the Pega Platform distribution image that you have made available on your local system. The procedure assumes you’ve downloaded the software in [Downloading Pega Platform to your local system](#_Downloading_Pega_Platform) and installed the required components on your local system listed in [Install required applications for the deployment](#_Install_required_applications). +Pega provides this image as the primary content of the final Docker image you will use to install or upgrade Pega Platform. This section describes how you can use this Docker image in combination with a Dockerfile and the Pega Platform distribution image that you have made available on your local system. The procedure assumes you’ve downloaded the software in [Downloading Pega Platform to your local system](#downloading-a-pega-platform-distribution-to-your-local-system) and installed the required components on your local system listed in [Install required applications for the deployment](#creating-a-local-folder-to-access-all-of-the-configuration-files). Follow these steps to create a Docker image you can use to install or upgrade Pega Platform. diff --git a/docs/prepping-local-system-runbook-windows.md b/docs/prepping-local-system-runbook-windows.md index 0be13f344..30a1aa000 100644 --- a/docs/prepping-local-system-runbook-windows.md +++ b/docs/prepping-local-system-runbook-windows.md @@ -35,7 +35,7 @@ Where \-demo is: - Openshift-demo - for the Openshift runbook -Currently there is no runbook for running on the Google Kubernetes Engine (GKE) using the Windows 10 Google SDK. To set up a system for a deployment on GKE, see [Prepare a local Linux system – 45 minutes](docs/prepping-local-system-runbook-linux.md). +Currently there is no runbook for running on the Google Kubernetes Engine (GKE) using the Windows 10 Google SDK. To set up a system for a deployment on GKE, see [Prepare a local Linux system – 45 minutes](prepping-local-system-runbook-linux.md). You are ready to continue preparing your local system. @@ -152,7 +152,7 @@ Advanced users may add the binary file to their path using their preferred metho ### Installing Docker Desktop on Windows 10 -In order to build a docker installation image in the section, [Prepare your Pega Platform installation Docker image – 15 minutes](#_Prepare_your_Pega_1), you must install the Community Edition (CE) of Docker for Windows. To do so, you must download, install, and log into Docker for Windows in order to complete the setup on your local system. +In order to build a docker installation image in the section, [Prepare your Pega Platform installation Docker image – 15 minutes](#prepare-your-pega-platform-installation-docker-image--15-minutes), you must install the Community Edition (CE) of Docker for Windows. To do so, you must download, install, and log into Docker for Windows in order to complete the setup on your local system. 1. Download the installer (Docker for Windows Installer.exe) from [download.docker.com](https://download.docker.com/win/stable/Docker%20for%20Windows%20Installer.exe). @@ -277,8 +277,8 @@ Pega added for this purpose in the [pega-helm-charts](https://github.com/pegasys - prconfig.xml: adjust the standard Pega Platform configuration with known, required settings -Make these changes before you begin in the section, [Deploying Pega Platform -using Helm charts – 30 minutes](#_Deploying_Pega_Platform). +Make these changes before you begin deploying Pega Platform +using Helm charts. Downloading a Pega Platform distribution to your local system ------------------------------------------------------------- @@ -287,7 +287,7 @@ These instructions require the Pega Platform distribution image to install the P ### Requesting access to a Pega Platform distribution -1. In the browser of your choice, navigate to the Pega [Digital Software Delivery](https://community1.pega.com/digital-delivery) site. +1. In the browser of your choice, navigate to the Pega [Digital Software Delivery](https://community.pega.com/digital-delivery) site. 2. Log into the [Pega Community](https://community.pega.com/knowledgebase/articles/pega-cloud/pega-cloud-services-patch-process-releases-83x-and-later) site with the credentials your Pega representative provided. @@ -369,7 +369,7 @@ Prepare your Pega Platform installation Docker image – 15 minutes As stated previously, you must have a [DockerHub](https://hub.docker.com/) account and log into it in order to see the [Pega-installer-ready Docker image](https://hub.docker.com/r/pegasystems/pega-installer-ready). You also need the docker cli and docker-desktop installed on your system before you begin this procedure. The Pega-provided Docker image, pega-installer-ready, includes some components of a full installation image that you can use to install or upgrade the Pega Platform database. While it is built on top of a JDK, it does not contain the contents of the Pega distribution kit which are essential for installing or upgrading Pega Platform. -Pega provides this image as the primary content of the final Docker image you will use to install or upgrade Pega Platform. This section describes how you can use this Docker image in combination with a Dockerfile and the Pega Platform distribution image that you have made available on your local system. The procedure assumes you’ve downloaded the software in [Downloading Pega Platform to your local system](#_Downloading_Pega_Platform) and installed the required components on your local system listed in [Install required applications for the deployment](#creating-a-local-folder-to-access-all-of-the-configuration-files). +Pega provides this image as the primary content of the final Docker image you will use to install or upgrade Pega Platform. This section describes how you can use this Docker image in combination with a Dockerfile and the Pega Platform distribution image that you have made available on your local system. The procedure assumes you’ve downloaded the software in [Downloading Pega Platform to your local system](#downloading-a-pega-platform-distribution-to-your-local-system) and installed the required components on your local system listed in [Install required applications for the deployment](#creating-a-local-folder-to-access-all-of-the-configuration-files). Follow these steps to create a Docker image you can use to install or upgrade Pega Platform.