From d6835de765ad5a39a7066cda0fdecab13d47bb7d Mon Sep 17 00:00:00 2001
From: Stefan Reimer <stefan@zero-downtime.net>
Date: Mon, 4 May 2020 14:46:55 +0100
Subject: [PATCH] More README update

---
 charts/kubezero/README.md   |  9 +++++----
 charts/kubezero/values.yaml | 26 ++++++++++++--------------
 2 files changed, 17 insertions(+), 18 deletions(-)

diff --git a/charts/kubezero/README.md b/charts/kubezero/README.md
index 34d805b..874a4d7 100644
--- a/charts/kubezero/README.md
+++ b/charts/kubezero/README.md
@@ -27,12 +27,13 @@ Source code can be found [here](https://kubezero.com)
 | argo-cd.repoServer.nodeSelector."node-role.kubernetes.io/master" | string | `""` |  |
 | argo-cd.repoServer.tolerations[0].effect | string | `"NoSchedule"` |  |
 | argo-cd.repoServer.tolerations[0].key | string | `"node-role.kubernetes.io/master"` |  |
-| argo-cd.server.config.url | string | `"argocd.example.com"` |  |
+| argo-cd.server.config.url | string | `"argocd.example.com"` | ArgoCD hostname to be exposed via Istio |
 | argo-cd.server.extraArgs[0] | string | `"--insecure"` |  |
 | argo-cd.server.nodeSelector."node-role.kubernetes.io/master" | string | `""` |  |
 | argo-cd.server.service.servicePortHttpsName | string | `"grpc"` |  |
 | argo-cd.server.tolerations[0].effect | string | `"NoSchedule"` |  |
 | argo-cd.server.tolerations[0].key | string | `"node-role.kubernetes.io/master"` |  |
-| bootstrap | bool | `true` |  |
-| istio.enabled | bool | `false` |  |
-| istio.gateway | string | `"ingressgateway.istio-system.svc.cluster.local"` |  |
+| bootstrap | bool | `true` | Wether to install the root-app `kubezero-app` |
+| config | object | `{}` | Kubezero configuration to be passed into kubezero-app |
+| istio.enabled | bool | `false` | Deploy Istio VirtualService to expose ArgoCD |
+| istio.gateway | string | `"ingressgateway.istio-system.svc.cluster.local"` | Name of the Istio gateway to add the VirtualService to |
diff --git a/charts/kubezero/values.yaml b/charts/kubezero/values.yaml
index 34fdbbd..0617ca2 100644
--- a/charts/kubezero/values.yaml
+++ b/charts/kubezero/values.yaml
@@ -1,22 +1,17 @@
+# bootstrap -- Wether to install the root-app `kubezero-app`
 bootstrap: true
 
-#config:
-#  defaultSource:
-#    repoURL: https://myprivate.repo.com/k8s-components
-#    pathPrefix: 'some-folder'
-#
-#  # Enabled component
-#  calico:
-#    enabled: true
+# config -- Kubezero configuration to be passed into kubezero-app
+config: {}
 
 argo-cd:
   installCRDs: false
-    
+
   #configs:
   #  secret:
   #    argocdServerAdminPassword: "$2a$10$ivKzaXVxMqdeDSfS3nqi1Od3iDbnL7oXrixzDfZFRHlXHnAG6LydG"
   #    argocdServerAdminPasswordMtime: "2020-04-24T15:33:09BST"
-  
+
   # Run Argo on the controllers
   controller:
     nodeSelector:
@@ -24,16 +19,17 @@ argo-cd:
     tolerations:
     - key: node-role.kubernetes.io/master
       effect: NoSchedule
-  
+
   repoServer:
     nodeSelector:
       node-role.kubernetes.io/master: ""
     tolerations:
     - key: node-role.kubernetes.io/master
       effect: NoSchedule
-  
+
   server:
     config:
+      # argo-cd.server.config.url -- ArgoCD hostname to be exposed via Istio
       url: argocd.example.com
 
     # Rename former https port to grpc, works with istio + insecure
@@ -47,17 +43,19 @@ argo-cd:
     tolerations:
     - key: node-role.kubernetes.io/master
       effect: NoSchedule
-  
+
   redis:
     nodeSelector:
       node-role.kubernetes.io/master: ""
     tolerations:
     - key: node-role.kubernetes.io/master
       effect: NoSchedule
-  
+
   dex:
     enabled: false
 
 istio:
+  # istio.enabled -- Deploy Istio VirtualService to expose ArgoCD
   enabled: false
+  # istio.gateway -- Name of the Istio gateway to add the VirtualService to
   gateway: ingressgateway.istio-system.svc.cluster.local