Skip to content

Commit

Permalink
update documentation by comments (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
kuritka committed Apr 16, 2020
1 parent 46ef25b commit 13abd06
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ tags
.history
# End of https://www.gitignore.io/api/go,vim,emacs,visualstudiocode

### JetBrains GoLand workspace ###
### JetBrains IDE ###
.idea
# End of idea tools

Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A Global Service Load Balancing solution with a focus on having cloud native qua
- [Installation Local Playground](#installation-local-playground)
- [Environment prerequisites](#environment-prerequisites)
- [Running project locally](#running-project-locally)
- [verify installation](#verify-installation)
- [Verify installation](#verify-installation)
- [Run integration tests](#run-integration-tests)
- [Cleaning](#cleaning)

Expand Down Expand Up @@ -45,15 +45,17 @@ for customization options.

#### Environment prerequisites

- install **GO 1.14**
- [install **GO 1.14**](https://golang.org/dl/)

- install **GIT**
- ensure SSH key is set for your account; see https://github.com/settings/keys
- [install **GIT**](https://git-scm.com/downloads)

- install **gnu-sed** if you don't have it
- update $PATH in `~/.bash_profile` by sed path `export PATH=/usr/local/opt/gnu-sed/libexec/gnubin:$PATH`
- If you are on a Mac, install sed by Homebrew
```shell script
brew install gnu-sed
```

- install **Docker**
- [install **Docker**](https://docs.docker.com/get-docker/)
- ensure you are able to push/pull from your docker registry
- to run multiple clusters reserve 8GB of memory

Expand All @@ -62,13 +64,13 @@ for customization options.
<sup>above screenshot is for <strong>Docker for Mac</strong> and that options for other Docker distributions may vary</sup>
</div>

- install **Kubectl** to operate clusters
- [install **Kubectl**](https://kubernetes.io/docs/tasks/tools/install-kubectl/) to operate clusters

- [install **Helm3**](https://helm.sh/docs/intro/install/) to get charts
- add default repo
```shell script
helm repo add stable https://kubernetes-charts.storage.googleapis.com
```
helm repo add stable https://kubernetes-charts.storage.googleapis.com
```

- install **kind** as tool for running local Kubernetes clusters
- follow https://kind.sigs.k8s.io/docs/user/quick-start/
Expand Down

0 comments on commit 13abd06

Please sign in to comment.