helm devops readme (#658)

# Description This PR includes the following proposed change(s): - spdbt-2066: deploy test env with helm chart. --------- Co-authored-by: Yossi T <[email protected]>
bcgov · Jan 6, 2024 · 0698527 · 0698527
1 parent 4a59614
commit 0698527
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/tools/helm/charts/readme.md b/tools/helm/charts/readme.md
@@ -0,0 +1,26 @@
+# Environment setup
+
+
+## Install helm
+
+To install helm chart, use the following command:
+
+```sh
+winget install helm.helm
+```
+Note another way to install helm: Open a "command prompt" as system administrator, go to "sparc" folder, use chocolate to install helm.
+
+```
+choco
+choco install kubernetes-helm
+```
+## Sync "Dev hangout" files to local
+go to teams/Dev hangout/ files, select "sync"
+
+## Create a symlink by running this command
+
+Open a "command prompt" as system administrator, go to "sparc" folder, use following command
+
+```
+mklink /D envs "C:\Users\[user]\Quartech Systems Limited\SPD QT No41 only - Dev hangout - secrets\envs"
+```
diff --git a/tools/helm/charts/sparc/README.md b/tools/helm/charts/sparc/README.md
@@ -3,19 +3,28 @@
 This directory contains a Helm chart to deploy SPD Sparc applications.
 
 Each environment has its own folder under 'envs' that need to be mapped from the shared secured storage.
+Start a command prompt with Administrator, then login to your openshift account.
 
 ## Usage
 
 To install a new environment, ensure the values.yaml matches the environment, then run the following command:
 
 ```sh
-helm -n [namespace] install [env name] -f ./envs/[env name]/values.yml
+helm -n [namespace] install [env name] . -f ./envs/[env name]/values.yaml
+```
+Example: 
+```
+C:\projects\spd\tools\helm\charts\sparc>helm -n fe7e29-test install testname . -f ./envs/test/values.yaml
 ```
 
 To upgrade an existing environment, run the following command:
 
 ```sh
-helm -n [namespace] upgrade [env name] -f ./envs/[env name]/values.yml
+helm -n [namespace] upgrade [env name] . -f ./envs/[env name]/values.yaml
+```
+Example:
+```
+C:\projects\spd\tools\helm\charts\sparc>helm -n fe7e29-test upgrade testname . -f ./envs/test/values.yaml
 ```
 
 To remove an existing environment, run the following command: