Docs update (#57)

docs/Kubeflow-install.md

@@ -1,5 +1,10 @@
 # Kubeflow installation instruction
 
+## Connect to AKS
+
+* Login to Azure: az login
+* Create user credentials:  az aks get-credentials -n <AKS_NAME> -g <RESOURCE_GROUP_NAME>
+
 ## Install Istio (if not already installed on the cluster)
 
 (https://istio.io/docs/setup/getting-started/#download)

docs/README.md

@@ -17,12 +17,12 @@
 
 * [Install KubeFlow](./Kubeflow-install.md) on the AKS cluster
 * Run [azure-credentials.sh](../setup/kfp/azure-credentials.sh)
-  * This file sets Azure service principal secrets in the AKS cluster
+  * This file sets Azure service principal secrets in the AKS cluster. Initialize variables in the script before running it.
 * Run [ghcreds-secret.sh](../setup/kfp/ghcreds-secret.sh)
-  * This file set Git access token secrets in the AKS cluster
+  * This file set Git access token secrets in the AKS cluster. Initialize variables in the script before running it.
 * Run [kubemlopsbot.sh](../setup/kfp/kubemlopsbot.sh)
-  * Manually installs a k8s deployment for a custom bot
+  * Manually installs a k8s deployment for a custom bot. Initialize variables in the script before running it.
 * Run [pvc.sh](../setup/kfp/pvc.sh)
   * Deploy a PVC configuration in kubeflow namespace
-* Run [attach-acr.sh](../setup/kfp/attach-acr.sh)
+* Run [attach-acr.sh](../setup/kfp/attach-acr.sh). Initialize variables in the script before running it.
   * Use Az CLI to authenticate Azure Container Registry with AKS

setup/kfp/attach-acr.sh

@@ -1 +1,6 @@
+# Initialize variables:
+# AKS_NAME=
+# RESOURCE_GROUP=
+# ACR_NAME=
+
 az aks update -n $AKS_NAME -g $RESOURCE_GROUP --attach-acr $ACR_NAME

setup/kfp/azure-credentials.sh

@@ -1,3 +1,10 @@
+# Initialize variables:
+# AZ_SUBSCRIPTION_ID=
+# AZ_TENANT_ID=
+# AZ_CLIENT_ID=
+# AZ_CLIENT_SECRET=
+# KUBEFLOW_NAMESPACE=kubeflow
+
 kubectl create secret generic azcreds --from-literal=AZ_SUBSCRIPTION_ID=$AZ_SUBSCRIPTION_ID \
                                       --from-literal=AZ_TENANT_ID=$AZ_TENANT_ID \
                                       --from-literal=AZ_CLIENT_ID=$AZ_CLIENT_ID \

setup/kfp/databricks-secret.sh

@@ -1 +1,7 @@
+# Initialize variables:
+# DATABRICKS_HOST=
+# DATABRICKS_TOKEN=
+# CLUSTER_ID=
+# KUBEFLOW_NAMESPACE=kubeflow
+
 kubectl create secret generic databricks-secret --from-literal=DATABRICKS_HOST=$DATABRICKS_HOST --from-literal=DATABRICKS_TOKEN=$DATABRICKS_TOKEN --from-literal=CLUSTER_ID=$CLUSTER_ID -n $KUBEFLOW_NAMESPACE

setup/kfp/ghcreds-secret.sh

@@ -1 +1,6 @@
+# Initialize variables:
+# GITHUB_TOKEN=
+# GITHUB_REPOSITORY=
+# KUBEFLOW_NAMESPACE=kubeflow
+
 kubectl create secret generic ghcreds-secret --from-literal=GITHUB_TOKEN=$GITHUB_TOKEN --from-literal=GITHUB_REPOSITORY=$GITHUB_REPOSITORY -n $KUBEFLOW_NAMESPACE

setup/kfp/kubemlopsbot.sh

@@ -1 +1,4 @@
+# Initialize variables:
+# KUBEFLOW_NAMESPACE=kubeflow
+
 kubectl apply -f kubemlopsbot.yml -n $KUBEFLOW_NAMESPACE