Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated doc with info on how to leverage environment name.
  • Loading branch information
misterdorito authored Jan 28, 2021
1 parent e483429 commit a0cf421
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions charts/pega/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,30 @@ docker:
imagePullPolicy: "Always"
```

## Environment Name (Optional)

Set the environment name to help differentiate this deployment from others. The provided name will be used as a prefix to the various Pega tiers (and the k8s objects created on their behalf). The environment name must consist of a DNS friendly name as it will be incorporated into the names of k8s objects. For example:
```yaml
global:
environment:
name: app1-dev-

This comment has been minimized.

Copy link
@dcasavant

dcasavant Jan 29, 2021

Member

Should there be a - at the end? Or is that automatically incorporated?

```
will result in:
```
>kubectl get pods -n test
NAME READY STATUS RESTARTS AGE
pega-search-0 1/1 Running 0 24m
app1-dev-batch-86584dcd6b-dsvdd 1/1 Running 0 24m
app1-dev-batch-86584dcd6b-lfwjg 1/1 Running 0 7m31s
app1-dev-stream-0 1/1 Running 0 24m
app1-dev-stream-1 1/1 Running 0 18m
app1-dev-web-788cfb8cc4-6c5nz 1/1 Running 0 8m57s
app1-dev-web-788cfb8cc4-gcltx 1/1 Running 0 24m
```
(pega-search-0 is not renamed as it not a Pega tier as it doesn't host a Pega node.)

This comment has been minimized.

Copy link
@dcasavant

dcasavant Jan 29, 2021

Member

Should we just apply this to search as well for consistency? Any reason not to do it?


The default value is "pega-" if it is unset.

## Tiers of a Pega deployment

Pega supports deployment using a multi-tier architecture to separate processing and functions. Isolating processing in its own tier also allows for unique deployment configuration such as its own prconfig, resource allocations, or scaling characteristics. Use the `tier` section in the helm chart to specify which tiers you wish to deploy and their logical tasks.
Expand Down

1 comment on commit a0cf421

@taz-pega-work
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wordsmithing for the description...that is an ACE example! nice job! ;-)
-->Specify an environment name that the deployment uses as a prefix to help differentiate this deployment in your environment. The deployment adds this prefix to the various Pega tiers and the associated k8s objects in your deployment. Your environment name must be a DNS-friendly name so the deployment can successfully add it to k8s object names. For example:

Please sign in to comment.