This is an automated email from the ASF dual-hosted git repository.
tokers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-helm-chart.git
The following commit(s) were added to refs/heads/master by this push:
new 650fcda docs: add README.md for apisix-dashboard (#193)
650fcda is described below
commit 650fcda7c26dc73d0b4eb0e8d086975c8043c52a
Author: Yu.Bozhong <y...@foxmail.com>
AuthorDate: Mon Dec 13 10:16:37 2021 +0800
docs: add README.md for apisix-dashboard (#193)
---
charts/apisix-dashboard/README.md | 57 +++++++++++++++++++++++++++++++++++++++
1 file changed, 57 insertions(+)
diff --git a/charts/apisix-dashboard/README.md
b/charts/apisix-dashboard/README.md
new file mode 100644
index 0000000..1dedf99
--- /dev/null
+++ b/charts/apisix-dashboard/README.md
@@ -0,0 +1,57 @@
+# Apache APISIX Dashboard
+
+[APISIX Dashboard](https://github.com/apache/apisix-dashboard/) is designed to
make it as easy as possible for users to operate Apache APISIX through a
frontend interface.
+
+This chart bootstraps an apisix-dashboard deployment on a
[Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh)
package manager.
+
+## Prerequisites
+
+APISIX Dashboard requires Kubernetes version 1.14+.
+
+## Get Repo Info
+
+```console
+helm repo add apisix https://charts.apiseven.com
+helm repo update
+```
+
+## Install Chart
+
+**Important:** only helm3 is supported
+
+```console
+helm install [RELEASE_NAME] apisix/apisix-dashboard
+```
+
+The command deploys apisix-dashboard 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 apisix/apisix-dashboard
+```
