Fix the Doc lint, shellcheck and doc links Errors

[kuberef.git] / deploy.env

diff --git a/deploy.env b/deploy.env
index e317a5f..9c4292f 100644 (file)
--- a/deploy.env
+++ b/deploy.env
@@ -4,8 +4,14 @@
 
 # Define environment variables
 
+# Vendor name - some examples are listed under kuberef/hw_config
 export VENDOR=${VENDOR:-intel}
+
+# OS to be installed on target hosts
+# Currently centos7 and ubuntu1804 are supported
 export DISTRO=${DISTRO:-centos7}
+
+# k8s provisioiner details
 export INSTALLER=bmra
 export BMRA_PROFILE=$(yq r $CURRENTPATH/hw_config/$VENDOR/idf.yaml bmra.profile)
 
@@ -23,3 +29,6 @@ export VM_NAME=$(yq r $CURRENTPATH/hw_config/$VENDOR/pdf.yaml jumphost.name)
 export USERNAME=${USERNAME:-ubuntu}
 export PROJECT_ROOT="${PROJECT_ROOT:-/home/ubuntu}"
 export ROOT_PASSWORD="root" # This is used for throubleshooting purposes
+
+# Set to true to show more detailed debug level logs
+export DEBUG=false