Skip to content

Commit

Permalink
Update README with ToC
Browse files Browse the repository at this point in the history
  • Loading branch information
meezaan committed Aug 6, 2020
1 parent 1adafd8 commit 5a8c07d
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ you can deploy 2 instances of this utility (usually 1 is enough).
It's fully dockerised (but written in PHP) and has a low resource footprint, so you can
deploy it locally or on the cluster itself.

# Contents
[Requirements](#requirements)
[Docker Image](#published-docker-image)
[Environment Variables & Configuration](#environment-variables--configuration)
[Usage](#usage)
[Deploying on Kubernetes for Production Usage](deploying-on-kubernetes-for-production-usage)
[Pod Sizing](#sizing-the-autoscaler-pod)
[Credits](#credits)
[Disclaimer](#discalimer)

## Requirements
* Linode Kuberenetes Cluster (LKE) with Metrics Server
* A kubectl config file (usually stored @ ~/.kube/config)
Expand Down Expand Up @@ -77,7 +87,7 @@ docker run -v ~/.kube/config:/root/.kube/config \
-e AUTOSCALE_WAIT_TIME_AFTER_SCALING='180' meezaan/linode-k8s-autoscaler
```

## Deploying on Kubernetes
## Deploying on Kubernetes for Production Use

For production, you can build a private Docker image and push a kubectl config file
with a service account's credentials into the image. So, your Dockerfile may look something like:
Expand Down

0 comments on commit 5a8c07d

Please sign in to comment.