Fixes README
This commit is contained in:
23
README.md
23
README.md
@@ -14,27 +14,22 @@ All code in this repo is distributed freely by the GPLv3 License.
|
|||||||
|
|
||||||
- Requirements:
|
- Requirements:
|
||||||
|
|
||||||
This project requires a working kubernetes cluster, in case of a testing environment a minikube cluster will by configured for you, otherwise a kubernetes will not be configured.
|
This project requires a working kubernetes cluster with the following tools installed: kubectl, helm and envsubts. If running in a local environment and if minikube is preset a minikube cluster can be created.
|
||||||
|
|
||||||
- Configuring Secrets:
|
|
||||||
|
|
||||||
```
|
|
||||||
python -m pip install --upgrade pip pipenv
|
|
||||||
pipenv install
|
|
||||||
pipenv run python setup.py -e {{environment-option}} -f config.json
|
|
||||||
```
|
|
||||||
|
|
||||||
- Running Kubernetes Application:
|
- Running Kubernetes Application:
|
||||||
|
|
||||||
```
|
```
|
||||||
sudo apt update && sudo apt install -y jq python3-pip
|
./deploy.sh [-f <env_file>] [-e <environment>] [-m]
|
||||||
cd infra-hideyoshi.com
|
|
||||||
./deploy.sh {{environmet-flag}}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
`{{environment-flag}}` : `--local`, `--staging`, `--prod`
|
- Flags:
|
||||||
|
|
||||||
|
- `-f`: The environment file to use. If not set the system environment variables will be used.
|
||||||
|
|
||||||
|
- `-e`: The environment to deploy. Values `[remote|local]`. Default is `remote`.
|
||||||
|
|
||||||
|
- `-m`: If set, the minikube cluster will be used.
|
||||||
|
|
||||||
`{{environment-option}` : `local`, `staging`, `prod`
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
- [@HideyoshiNakazone](https://github.com/HideyoshiNakazone)
|
- [@HideyoshiNakazone](https://github.com/HideyoshiNakazone)
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ apply_deployment() {
|
|||||||
|
|
||||||
configure_nginx_minikube() {
|
configure_nginx_minikube() {
|
||||||
if [[ $setup_minikube == "true" ]]; then
|
if [[ $setup_minikube == "true" ]]; then
|
||||||
minikube start --driver kvm2 --cpus 2 --memory 4Gib
|
minikube start --driver kvm2 --cpus 8 --memory 8Gib
|
||||||
fi
|
fi
|
||||||
|
|
||||||
minikube addons enable ingress-dns
|
minikube addons enable ingress-dns
|
||||||
|
|||||||
Reference in New Issue
Block a user