Merge pull request #1 from pjmolina/feature/win-prereqs

Added prerequisites for Windows
vicenteherrera · Sep 2, 2024 · d89f2c8 · d89f2c8
2 parents 506c9ce + 9e3f758
commit d89f2c8
Showing 1 changed file with 30 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,32 @@
 
 This repo has files to quickstart a Kubernetes project or experiment with Kubernetes
 
+## Prerequisites
+
+Install Docker, make, minikube, heml & helmfile
+
+### Prerequisites for Windows
+
+1. Install Docker from <https://www.docker.com/products/docker-desktop/>
+2. Install choco from <https://chocolatey.org/install#individual>
+3. Install scoop from <https://scoop.sh/>
+
+From an elevated Powershell console:
+
+```powershell
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
+```
+
+From an elevated console:
+
+```bash
+choco install make
+choco install minikube
+scoop install helmfile
+scoop install helm
+```
+
 ## Usage
 
 ```bash
@@ -38,9 +64,9 @@ Check more targets at `makefile`.
 
 ## Directories
 
- + clusters: files to create and configure different cluster types
- + charts: files to deploy and configure several Helm charts
- + exercises: files to run commands to practice different Kubernetes concepts
++ clusters: files to create and configure different cluster types
++ charts: files to deploy and configure several Helm charts
++ exercises: files to run commands to practice different Kubernetes concepts
 
 ## Configuration
 
@@ -51,6 +77,7 @@ Check more targets at `makefile`.
 To use **Opsgenie** with Alertmanager, copy `sample.envrc` to `.envrc`, and set your API key and team id in that file. Then load its values into environment before deploying charts, with `source .envrc` or using [direnv](https://direnv.net/).
 
 To use **Mailtrap** as an alternative, edit `./charts/prometheus/am-mailtrap.yaml` with your user and password, and edit `./charts/helmfile-observability`, switch commenting these lines so they look like this:
+
 ```
     - ./prometheus/am-mailtrap.yaml
     # - ./prometheus/am-opsgenie.yaml