You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by kv...@apache.org on 2021/05/10 07:10:00 UTC

[apisix-helm-chart] branch master updated: add README for charts/apisix-ingress-controller (#69)

This is an automated email from the ASF dual-hosted git repository.

kvn 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 6228fb7  add README for charts/apisix-ingress-controller (#69)
6228fb7 is described below

commit 6228fb7cdb010e85bb8f20c0d5ee285408f9a164
Author: Jintao Zhang <ta...@163.com>
AuthorDate: Mon May 10 15:09:54 2021 +0800

    add README for charts/apisix-ingress-controller (#69)
    
    Signed-off-by: Jintao Zhang <zh...@gmail.com>
---
 charts/apisix-ingress-controller/README.md | 59 ++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)

diff --git a/charts/apisix-ingress-controller/README.md b/charts/apisix-ingress-controller/README.md
new file mode 100644
index 0000000..b379834
--- /dev/null
+++ b/charts/apisix-ingress-controller/README.md
@@ -0,0 +1,59 @@
+# Apache APISIX ingress controller
+
+[APISIX Ingress controller](https://github.com/apache/apisix-ingress-controller/) for Kubernetes using Apache APISIX as a high performance reverse proxy and load balancer.
+
+If you have installed multiple ingress controller, add the `kubernetes.io/ingress.class: apisix` annotation to your Ingress resources.
+
+This chart bootstraps an apisix-ingress-controller deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
+
+## Prerequisites
+
+Apisix ingress controller 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-ingress-controller
+```
+
+The command deploys apisix-ingress-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 apisix/apisix-ingress-controller
+```