doc(chart): Updated chart readme (#2322)

Signed-off-by: Alessandro Vozza <alessandro.vozza@microsoft.com>

Makefile

@@ -57,7 +57,7 @@ clean-osm:
 
 .PHONY: chart-readme
 chart-readme:
-	go run github.com/norwoodj/helm-docs/cmd/helm-docs -c charts
+	go run github.com/norwoodj/helm-docs/cmd/helm-docs -c charts -t charts/osm/README.md.gotmpl
 
 .PHONY: go-checks
 go-checks: go-lint go-fmt go-mod-tidy

charts/osm/README.md.gotmpl

@@ -0,0 +1,61 @@
+# Open Service Mesh Helm Chart
+
+![Version: 0.6.1](https://img.shields.io/badge/Version-0.6.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.6.1](https://img.shields.io/badge/AppVersion-v0.6.1-informational?style=flat-square)
+
+A Helm chart to install the [OSM](https://github.com/openservicemesh/osm) control plane on Kubernetes.
+
+## Prerequisites
+
+- Kubernetes v1.15+
+
+## Get Repo Info
+
+```console
+helm repo add osm https://openservicemesh.github.io/osm
+helm repo update
+```
+
+## Install Chart
+
+```console
+helm install [RELEASE_NAME] osm/osm
+```
+
+The command deploys `osm-controller` on the Kubernetes cluster in the default configuration.
+
+_See [configuration](#configuration) below._
+
+_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
+
+## Uninstall Chart
+
+```console
+helm uninstall [RELEASE_NAME]
+```
+
+This removes all the Kubernetes components associated with the chart and deletes the release.
+
+_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
+
+## Upgrading Chart
+
+```console
+helm upgrade [RELEASE_NAME] [CHART] --install
+```
+
+_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
+
+## Configuration
+
+See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
+
+```console
+helm show values osm/osm
+```
+
+The following table lists the configurable parameters of the osm chart and their default values.
+
+{{ template "chart.valuesSection" . }}
+
+<!-- markdownlint-enable MD013 MD034 -->
+<!-- markdownlint-restore -->

charts/osm/values.yaml

@@ -1,84 +1,125 @@
 # Default values for osm.
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
+
 OpenServiceMesh:
+  # -- `osm-controller` replicas 
   replicaCount: 1
   image:
+    # -- `osm-controller` image registry
     registry: openservicemesh
+    # -- `osm-controller` pod PullPolicy
     pullPolicy: IfNotPresent
+    # -- `osm-controller` image tag
     tag: v0.6.1
+  # -- `osm-controller` image pull secret   
   imagePullSecrets: []
+  # -- Envoy sidecar image  
   sidecarImage: envoyproxy/envoy-alpine:v1.17.0
   prometheus:
+    # -- Prometheus port  
     port: 7070
     retention:
+      # -- Prometheus retention time
       time: 15d
+  # -- The Certificate manager type: `tresor`, `vault` or `cert-manager` 
   certificateManager: tresor
   vault:
+    # --  Hashicorp Vault host/service - where Vault is installed 
     host:
+    # -- protocol to use to connect to Vault
     protocol: http
+    # -- token that should be used to connect to Vault
     token:
+    # -- Vault role to be used by Open Service Mesh   
     role: openservicemesh
   certmanager:
+    # --  cert-manager issuer namecert-manager issuer name 
     issuerName: osm-ca
+    # -- cert-manager issuer kind 
     issuerKind: Issuer
+    # -- cert-manager issuer group
     issuerGroup: cert-manager
+  # -- Sets the service certificatevalidity duration 
   serviceCertValidityDuration: 24h
+  # -- The Kubernetes secret to store `ca.crt`
   caBundleSecretName: osm-ca-bundle
   grafana:
+    # -- Grafana port 
     port: 3000
+    # -- Enable Remote Rendering in Grafana  
     enableRemoteRendering: false
-
+  # -- Enable the debug HTTP server    
   enableDebugServer: false
+  # -- Enable permissive traffic policy mode  
   enablePermissiveTrafficPolicy: false
+  # -- Enable experimental backpressure feature 
   enableBackpressureExperimental: false
+  # -- Enable egress in the mesh 
   enableEgress: false
+  # -- Deploy Prometheus
   deployPrometheus: false
+  # -- Enable Prometheus metrics scraping on sidecar proxies  
   enablePrometheusScraping: true
+  # -- Deploy Grafana
   deployGrafana: false
+  # -- Enable Fluentbit sidecar deployment 
   enableFluentbit: false
   fluentBit:
+    # -- luentBit Sidecar container name
     name: fluentbit-logger
+    # -- Registry for FluentBit sidecar container 
     registry: fluent
+    # -- FluentBit sidecar image tag
     tag: 1.6.4
+    # -- PullPolicy for FluentBit sidecar container  
     pullPolicy: IfNotPresent
+    # -- Log level for FluentBit  
     logLevel: error
+    # -- FluentBit Output Plugin, can be `stdout` or `azure` 
     outputPlugin: stdout
+    # -- WorkspaceId for FluentBit output plugin to Azure LogAnalytics
     workspaceId: ""
+    # -- PrimaryKey for FluentBit output plugin to Azure LogAnalytics  
     primaryKey: ""
+    # -- Enable proxy support for FluentBit
     enableProxySupport: false
+    # -- HTTP Proxy url for FluentBit  
     httpProxy: ""
+    # -- HTTPS Proxy url for FluentBit  
     httpsProxy: ""
+  # -- Name for the new control plane instance
   meshName: osm
+  # -- Enables HTTPS ingress on the mesh   
   useHTTPSIngress: false
+  # -- Envoy log level is used to specify the level of logs collected from envoy 
   envoyLogLevel: error
+  # -- Controller log verbosity 
   controllerLogLevel: trace
+  # -- Enforce only deploying one mesh in the cluster     
   enforceSingleMesh: false
+  # -- Validating- and MutatingWebhookConfiguration name            
   webhookConfigNamePrefix: osm-webhook
 
-  # Optional parameter. If not specified, the release namespace is
-  # used to deploy the osm components.
+  # -- Optional parameter. If not specified, the release namespace is used to deploy the osm components.
   osmNamespace: ""
 
-  # Set deployJaeger to true to deploy a Jaeger cluster in the
-  # namespace where OSM resides.
+  # -- Deploy Jaeger in the OSM namespace
   deployJaeger: false
 
   # The following section configures a destination where to send
   # tracing data. Current implementation supports only Zipkin format
   # backends (https://github.com/openservicemesh/osm/issues/1596)
   tracing:
 
-    ## Toggles Envoy's tracing functionality on/off
-    ## for all proxies in the mesh.
+    # -- Toggles Envoy's tracing functionality on/off for all sidecar proxies in the cluster      
     enable: true
 
-    # Tracing destination cluster
+    # -- Tracing destination cluster (must contain the namespace) 
     address: "jaeger.osm-system.svc.cluster.local"
 
-    # Destination port for the listener
+    # -- Destination port for the listener   
     port: 9411
 
-    # Destination's API or collector endpoint where the spans will
-    # be sent to
+    # -- Destination's API or collector endpoint where the spans will be sent to  
     endpoint: "/api/v2/spans"