From 8330157c9a838a2326abbb53661ae43e32720854 Mon Sep 17 00:00:00 2001
From: Marc Burnie <mburnie@amazon.com>
Date: Fri, 29 Jul 2022 14:55:34 -0500
Subject: [PATCH] using release namespace

---
 devops/aws/chart/README.md | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/devops/aws/chart/README.md b/devops/aws/chart/README.md
index b1488a7b6..7bcf2199a 100644
--- a/devops/aws/chart/README.md
+++ b/devops/aws/chart/README.md
@@ -13,41 +13,46 @@ The below software must be installed before continuing:
 Additionally, an OSDU on AWS environment must be deployed.
 
 ## Installation/Updating
-To install or update the service application by executing the following command in the devops/aws/chart folder:
+To install or update the service application by executing the following command in the CHART folder:
 
 ```bash
-helm upgrade [RELEASE_NAME] . -i
+helm upgrade [RELEASE_NAME] . -i -n [NAMESPACE]
 ```
 
 To observe the Kubernetes resources before deploying them using the command:
 ```bash
-helm upgrade [RELEASE_NAME] . -i --dry-run --debug
+helm upgrade [RELEASE_NAME] . -i -n [NAMESPACE] --dry-run --debug
 ```
 
 To observe the history of the current release, use the following command:
 ```bash
-helm history [RELEASE]
+helm history [RELEASE_NAME] -n [NAMESPACE]
 ```
 
 To revert to a previous release, use the following command:
 ```bash
-helm rollback [RELEASE] [REVISION]
+helm rollback [RELEASE] [REVISION] -n [NAMESPACE]
 ```
 
 ### Customizing the Deployment
-It is possible to modify the default values specified in the **values.yaml** file using the --set option. The below variables can be modified by advanced users to customize the deployment configuration:
-
-| Name | Example Value | Description | Type |
-| ---  | ------------- | ----------- | ---- |
-| `replicaCount` | `1` | The number of pod replicas to be deployed | int |
-| `autoscaling.enabled` | `true` | Enables the pod autoscaler | Bool |
-| `autoscaling.minReplicas` | `1` | Minimum number of pod replicas | int |
-| `autoscaling.maxReplicas` | `100` | Maximum number of pod replicas | int |
-| `autoscaling.targetCPUUtilizationPercentage` | `80` | CPU utilization target | int |
+It is possible to modify the default values specified in the **values.yaml** file using the --set option. The below parameters can be modified by advanced users to customize the deployment configuration:
+
+| Name | Example Value | Description | Type | Required |
+| ---  | ------------- | ----------- | ---- | -------- |
+| `global.accountID` | `000123456789` | The AWS account ID. | int | yes |
+| `global.region` | `us-east-1` | The AWS region containing the OSDU deployment. | str | yes |
+| `global.resourcePrefix` | `osdu` | The resource prefix of the OSDU deployment. | str | yes |
+| `global.allowOrigins` | `{http://localhost,https://www.osdu.aws}` | A list of domains that are permitted by CORS policy. An empty list permits all origins. | array[str] | no |
+| `podAnnotations` | `podAnnotations.version=v1.0.0` | Additional annotations on the service pod | dict | no |
+| `imagePullPolicy` | `IfNotPresent` | The service image pull policy | str | no |
+| `replicaCount` | `1` | The number of pod replicas to be deployed | int | no |
+| `autoscaling.minReplicas` | `1` | Minimum number of pod replicas | int | no |
+| `autoscaling.maxReplicas` | `100` | Maximum number of pod replicas | int | no |
+| `autoscaling.targetCPUUtilizationPercentage` | `80` | CPU utilization target | int | no |
 
 ## Uninstalling the Chart
 To uninstall the helm release:
 
 ```bash
-helm uninstall [RELEASE] --keep-history
-```
+helm uninstall [RELEASE] -n [NAMESPACE] --keep-history
+```
\ No newline at end of file
-- 
GitLab