Fix incorrect documentation for proctord

Fixes #40
gojek · Oct 24, 2018 · e8202d6 · e8202d6
1 parent 521e6df
commit e8202d6
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/proctord/.env.sample b/proctord/.env.sample
@@ -10,7 +10,7 @@ export PROCTOR_LOGS_STREAM_WRITE_BUFFER_SIZE="4096"
 export PROCTOR_KUBE_CLUSTER_HOST_NAME="localhost:8001"
 export PROCTOR_KUBE_POD_LIST_WAIT_TIME="5"
 export PROCTOR_KUBE_CA_CERT_ENCODED="LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCmNlcnRpZmljYXRlCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K"
-export PROCTOR_KUBE_BASIC_AUTH="Y2EtY2VydAo="
+export PROCTOR_KUBE_BASIC_AUTH_ENCODED="Y2EtY2VydAo="
 export PROCTOR_POSTGRES_USER="postgres"
 export PROCTOR_POSTGRES_PASSWORD=""
 export PROCTOR_POSTGRES_HOST="localhost"

diff --git a/proctord/.env.test b/proctord/.env.test
@@ -12,7 +12,7 @@ PROCTOR_LOGS_STREAM_WRITE_BUFFER_SIZE=4096
 PROCTOR_KUBE_CLUSTER_HOST_NAME=localhost:8001
 PROCTOR_KUBE_POD_LIST_WAIT_TIME=5
 PROCTOR_KUBE_CA_CERT_ENCODED=LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCmNlcnRpZmljYXRlCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
-PROCTOR_KUBE_BASIC_AUTH=YWRtaW46cGFzc3dvcmQK
+PROCTOR_KUBE_BASIC_AUTH_ENCODED=YWRtaW46cGFzc3dvcmQK
 PROCTOR_POSTGRES_USER=postgres
 PROCTOR_POSTGRES_PASSWORD=
 PROCTOR_POSTGRES_HOST=localhost

diff --git a/proctord/README.md b/proctord/README.md
@@ -49,7 +49,7 @@
 * `PROCTOR_DEFAULT_NAMESPACE` is the namespace under which jobs will be run in kubernetes cluster. By default, K8s has namespace "default". If you set another value, please create namespace in K8s before deploying `proctord`
 * `PROCTOR_KUBE_CLUSTER_HOST_NAME` is address/ip address to api-server of kube cluster. It is used for fetching logs of a pod using https
 * `PROCTOR_KUBE_CA_CERT_ENCODED` is the CA cert file encoded in base64. This is used for establishing authority while talking to kubernetes api-server on a public https call
-* `PROCTOR_KUBE_BASIC_AUTH` is the base64 encoded authentication of kubernetes. Enocde `username:password` to base64 and set this config.
+* `PROCTOR_KUBE_BASIC_AUTH_ENCODED` is the base64 encoded authentication of kubernetes. Enocde `username:password` to base64 and set this config.
 * Before streaming logs of jobs, `PROCTOR_KUBE_POD_LIST_WAIT_TIME` is the time to wait until jobs and pods are in active/successful/failed state
 * `PROCTOR_POSTGRES_USER`, `PROCTOR_POSTGRES_PASSWORD`, `PROCTOR_POSTGRES_HOST` and `PROCTOR_POSTGRES_PORT` is the username and password to the postgres database you wish to connect to
 * Set `PROCTOR_POSTGRES_DATABASE` to `proctord_development` for development purpose