添加helm-docs

Author: imroc

Makefile

@@ -208,3 +208,7 @@ generate-docs:
 		--output-path=./docs/api.md \
 		--renderer=markdown
 
+
+.PHONY: helm-docs
+helm-docs:
+	./hack/helm-docs.sh

charts/tke-extend-network-controller/README.md

@@ -0,0 +1,44 @@
+# tke-extend-network-controller
+
+![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square)
+
+A Network Controller for TKE
+
+**Homepage:** <https://github.com/imroc/tke-extend-network-controller>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| clusterID | string | `""` | Cluster ID of the current TKE Cluster. |
+| fullnameOverride | string | `""` |  |
+| image | object | `{"pullPolicy":"IfNotPresent","repository":"imroc/tke-extend-network-controller","tag":""}` | Image of the controller |
+| image.pullPolicy | string | `"IfNotPresent"` | ImagePullPolicy of the controller |
+| image.repository | string | `"imroc/tke-extend-network-controller"` | Image repository of the controller |
+| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
+| imagePullSecrets | list | `[]` | ImagePullSecrets of the controller |
+| livenessProbe.httpGet.path | string | `"/healthz"` |  |
+| livenessProbe.httpGet.port | int | `8081` |  |
+| livenessProbe.initialDelaySeconds | int | `15` |  |
+| livenessProbe.periodSeconds | int | `20` |  |
+| log | object | `{"encoder":"json","level":"info"}` | Logging otpions of the controller |
+| log.encoder | string | `"json"` | Log format of the controller, be one of 'json' or 'console' |
+| log.level | string | `"info"` | Log level of the controller, be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| readinessProbe.httpGet.path | string | `"/readyz"` |  |
+| readinessProbe.httpGet.port | int | `8081` |  |
+| readinessProbe.initialDelaySeconds | int | `5` |  |
+| readinessProbe.periodSeconds | int | `10` |  |
+| region | string | `""` | Region of the current TKE Cluster, optional. |
+| replicaCount | int | `1` | Replica count of the controller pod |
+| resources | object | `{}` |  |
+| secretID | string | `""` | Secret ID of the Tencent Cloud Account. |
+| secretKey | string | `""` | Secret Key of the Tencent Cloud Account. |
+| tolerations | list | `[]` |  |
+| vpcID | string | `""` | VPC ID of the current TKE Cluster. |
+| workerCount | int | `3` | Worker count of the controller |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/tke-extend-network-controller/values.yaml

@@ -2,26 +2,39 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
+# -- Replica count of the controller pod
 replicaCount: 1
 
+# -- Region of the current TKE Cluster, optional.
 region: ""
+# -- VPC ID of the current TKE Cluster.
 vpcID: ""
+# -- Secret ID of the Tencent Cloud Account.
 secretID: ""
+# -- Secret Key of the Tencent Cloud Account.
 secretKey: ""
+# -- Cluster ID of the current TKE Cluster.
 clusterID: ""
-
+# -- Worker count of the controller
 workerCount: 3
 
+# -- Logging otpions of the controller
 log:
-  level: "info" # be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
-  encoder: "json" # json or console
+  # -- Log level of the controller, be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
+  level: "info"
+  # -- Log format of the controller, be one of 'json' or 'console'
+  encoder: "json"
 
+# -- Image of the controller
 image:
+  # -- Image repository of the controller
   repository: imroc/tke-extend-network-controller
+  # -- ImagePullPolicy of the controller
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
+# -- ImagePullSecrets of the controller
 imagePullSecrets: []
 nameOverride: ""
 fullnameOverride: ""

hack/helm-docs.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+cd charts/tke-extend-network-controller
+
+helm-docs