Updated README for helm3 commands

mojaloop · Aug 19, 2020 · 3be7e09 · 3be7e09
1 parent 10624c9
commit 3be7e09
Showing 1 changed file with 52 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -7,15 +7,16 @@ Mojaloop published Helm Repo: http://mojaloop.io/helm/repo/
 
 Mojaloop deployment documentation: https://docs.mojaloop.io/documentation/deployment-guide
 
-Refer to Helm docs for more information: https://docs.helm.sh/
+Refer to Helm v3 docs for more information: https://docs.helm.sh/
 
 ## Pre-requisites
 
 1. Add Helm dependency repositories:
 ```bash
-helm repo add incubator http://storage.googleapis.com/kubernetes-charts-incubator;
-helm repo add kiwigrid https://kiwigrid.github.io;
-helm repo add elastic https://helm.elastic.co
+   helm repo add incubator http://storage.googleapis.com/kubernetes-charts-incubator
+   helm repo add kiwigrid https://kiwigrid.github.io	   helm repo add kiwigrid https://kiwigrid.github.io
+   helm repo add elastic https://helm.elastic.co	   helm repo add elastic https://helm.elastic.co
+   helm repo add bitnami https://charts.bitnami.com/bitnami 
 ```
 
 ## Configure remote Mojaloop Helm repo on your Helm Client
@@ -26,36 +27,52 @@ helm repo add elastic https://helm.elastic.co
 
 2. Keep your local Mojaloop repo up to date
 
-`helm repo up mojaloop`
+`helm repo update`
 
-## Deployment from remote Mojaloop repo
+## Deployment
 
 1. Deploy specific chart
 
-- `helm install --debug --namespace=<namespace> --name=<release-name> --repo=http://mojaloop.io/helm/repo <chart_name>`
+- `helm --namespace <namespace> install <release_name> mojaloop/<chart_name>`
 
-e.g. `helm install --debug --namespace=mojaloop --name=dev --repo=http://mojaloop.io/helm/repo centralledger`
+e.g. `helm --namespace moja install dev mojaloop/centralledger`
+
+Alternative directly from remote repo:
+
+- `helm --namespace <namespace> install <release_name> --repo=http://mojaloop.io/helm/repo <chart_name>`
 
 2. Deploy specific chart overriding values
 
-- `helm install --debug --namespace=<namespace> --name=<release-name> --repo=http://mojaloop.io/helm/repo -f <values_file> <chart_name>`
+- `helm --namespace <namespace> install <release_name> mojaloop/<chart_name> -f {custom-values.yaml}`
+
+e.g. `helm --namespace moja install dev mojaloop/centralledger -f ./values.yaml`
+
+Refer to the following default chart config file for values: http://mojaloop.io/helm/<chart_name>/values.yaml
+
+Alternatively one can set specific values via cli arguments based on the config file above:
+- `helm --namespace <namespace> install <release_name> mojaloop/<chart_name> --set foo=bar --set {key.subkey.subsubkey}={value}`
+
+3. Deploy specific version for a chart
+
+- `helm --namespace <namespace> install <release_name> mojaloop/<chart_name> --version {version}`
 
-e.g. `helm install --debug --namespace=mojaloop --name=dev --repo=http://mojaloop.io/helm/repo -f ./values.yaml centralledger`
+e.g. `helm --namespace moja install dev mojaloop/centralledger --version v1.0.0`
 
 Refer to the following default chart config file for values: http://mojaloop.io/helm/<chart_name>/values.yaml
 
-3. Deploy Mojaloop components
+4. Deploy Mojaloop components
 
-*Warning: This will deploy all charts.*
+*Warning: This will deploy all core Mojaloop charts.*
 
-- `helm install --debug --namespace=<namespace> --name=<release-name> --repo=http://mojaloop.io/helm/repo mojaloop`
+- `helm --namespace <namespace> install <release_name> mojaloop/mojaloop`
 
-e.g. `helm install --debug --namespace=mojaloop --name=dev --repo=http://mojaloop.io/helm/repo mojaloop`
+e.g. `helm --namespace moja install dev mojaloop/mojaloop`
 
 ### Deploying development versions
 
 1. To deploy the latest development version, use the `--devel` flag:
-- `helm install --devel --debug --namespace=<namespace> --name=<release-name> --repo=http://mojaloop.io/helm/repo <chart_name>`
+
+- `helm --namespace <namespace> install <release_name> mojaloop/mojaloop --devel`
 
     This is useful if you've had some work merged into master but it has not yet been released.
 
@@ -65,56 +82,41 @@ e.g. `helm install --debug --namespace=mojaloop --name=dev --repo=http://mojaloo
 
 ## Upgrading Deployments from Repo
 
-`helm upgrade --debug <release-name> --repo=http://mojaloop.io/helm/repo <chart_name>`
-
-e.g. `helm upgrade --debug dev --repo=http://mojaloop.io/helm/repo centralenduserregistry`
+`helm upgrade <release-name> mojaloop/<chart_name>`
 
-## Update Chart Dependencies for Source for local repo deployments
+e.g. `helm upgrade dev mojaloop/centralenduserregistry`
 
-Note: Please ensure that you update the Chart dependencies in the order show below.
 
-- `helm dep up centralkms`
-- `helm dep up forensicloggingsidecar`
-- `helm dep up centralledger`
-- `helm dep up centralenduserregistry`
-- `helm dep up centralsettlement`
-- `helm dep up central`
-- `helm dep up ml-api-adapter`
-- `helm dep up mojaloop`
+## Deployment from Source for local repo deployments
 
-We are quitely waiting on recursive updates: https://github.com/kubernetes/helm/issues/2247
+### Update Chart Dependencies for Source for local repo deployments (i.e. from the cloned github repository)
 
-Alternatively please use the helper script `sh ./update-charts-dep.sh`. 
+Run the following script `sh ./update-charts-dep.sh` in the helm root folder. 
 
-This script will ensure the correct order is maintained.
+This script will ensure that all dependencies and child-dependencies are updated correctly. This is temporary until recursive updates is supported in future: https://github.com/kubernetes/helm/issues/2247.
 
-## Deployment from Source for local repo deployments
+### Deployment
 
 1. Deploy specific chart
 
-- `helm install --debug --namespace=<namespace> --name=<release-name> <chart_directory>`
+- `helm --namespace <namespace> install <release_name> <chart_folder>`
 
-e.g. `helm install --debug --namespace=mojaloop --name=dev ./centralledger`
+e.g. `helm --namespace=mojaloop install dev ./centralledger`
 
 2. Deploy mojaloop componenets
 
-*Warning: This will deploy all charts.*
+*Warning: This will deploy all core Mojaloop charts.*
 
-- `helm install --debug --namespace=<namespace> --name=<release-name> ./mojaloop`
+- `helm --namespace <namespace> install <release_name> mojaloop`
 
-e.g. `helm install --debug --namespace=mojaloop --name=dev ./mojaloop`
+e.g. `helm --namespace=mojaloop install dev ./mojaloop`
 
-3. Deploy Ingress
-
-- `helm install --debug --namespace=<namespace> --name=<release-name> ./kube-public/ingress-nginx`
-
-e.g. `helm install --debug --namespace=kube-public --name=<release-name> ./kube-public/ingress-nginx`
 
 ## Upgrading Deployments from Source
 
-`helm upgrade --debug <release-name> <chart_directory>`
+- `helm upgrade <release-name> <chart_folder>`
 
-e.g. `helm upgrade --debug dev ./centralenduserregistry/`
+e.g. `helm upgrade dev ./centralenduserregistry`
 
 ## Testing Deployments
 
@@ -124,35 +126,36 @@ e.g. `helm upgrade --debug dev ./centralenduserregistry/`
 
 2. Curl Health End-points for ML-API-Adapter
 
-`curl http://ml-api-adapter.local/health`
+- `curl http://ml-api-adapter.local/health`
 
 Expected output:
 
 `{"status":"OK"}`
 
 3. Curl Health End-points for Central Ledger
 
-`curl http://central-ledger.local/health`
+- `curl http://central-ledger.local/health`
 
 Expected output:
 
 `{"status":"OK"}`
 
 ## Removing Deployments
 
-`helm del --purge <release-name>`
+- `helm del --purge <release-name>`
 
 e.g. `helm del --purge dev`
 
 ## Debugging Charts
 
 1. Execute a dry-run to display all the Kubernetes deployment files
 
- `helm install --dry-run --debug --namespace=<namespace> --name=<release-name> <chart_directory>`
+- `helm --namespace <namespace> install <release_name> <chart_folder> --dry-run`
+
 
 2. Use Helm Linter to check for any issues
 
-`helm lint --strict <chart_directory>`
+- `helm lint --strict <chart_folder>`
 
 ## Helper scripts