From 5a8c07d80ddc4756abf6a5ccede2faeae8618bcd Mon Sep 17 00:00:00 2001 From: Meezaan-ud-Din Abdu Dhil-Jalali Wal-Ikram Date: Thu, 6 Aug 2020 12:57:04 +0400 Subject: [PATCH] Update README with ToC --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bafa048..c1c7f7f 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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: