tao12345666333 commented on a change in pull request #74: URL: https://github.com/apache/apisix-helm-chart/pull/74#discussion_r631521907
########## File path: charts/apisix/README.md ########## @@ -0,0 +1,122 @@ +## Apache APISIX for Kubernetes + +Apache APISIX is a dynamic, real-time, high-performance API gateway. + +APISIX provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, and more. + +You can use Apache APISIX to handle traditional north-south traffic, as well as east-west traffic between services. It can also be used as a [k8s ingress controller](https://github.com/apache/apisix-ingress-controller/). + +This chart bootstraps all the components needed to run Apache APISIX on a Kubernetes Cluster using [Helm](https://helm.sh). + + +## TL;DR + +```sh +➜ helm repo add apisix https://charts.apiseven.com +➜ helm repo update + +➜ helm install apisix/apisix --generate-name +``` + +## Prerequisites + +* Kubernetes v1.14+ +* Helm v3+ + + +## Install + +To install the chart with the release name `my-apisix`: + +```sh +➜ helm repo add apisix https://charts.apiseven.com +➜ helm repo update + +➜ helm install my-apisix apisix/apisix +``` + +## Uninstall + + To uninstall/delete a Helm release `my-apisix`: + + ```sh +➜ helm delete my-apisix + ``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Parameters + +The following tables lists the configurable parameters of the apisix chart and their default values per section/component: + +### Global parameters + +| Parameter | Description | Default | +|---------------------------|-------------------------------------------------|---------------------------------------------------------| +| `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` (does not add image pull secrets to deployed pods) | + + +### apisix parameters + +| Parameter | Description | Default | +|------------------------------------------|-----------------------------------------------------|---------------------------------------------------------| +| `apisix.enabled` | Enable or disable Apache APISIX itself | `true` | +| `apisix.enabled` | Enable or disable Apache APISIX itself | `true` | +| `apisix.image.repository` | Apache APISIX image repository | `apache/apisix` | +| `apisix.image.tag` | Apache APISIX image tag | `{TAG_NAME}` (the latest Apache APISIX image tag) | +| `apisix.image.pullPolicy` | Apache APISIX image pull policy | `IfNotPresent` | +| `apisix.replicaCount` | Apache APISIX deploy replica count | `1` | +| `apisix.podAnnotations` | Annotations to add to each pod | `{}` | +| `apisix.podSecurityContext` | Set the securityContext for Apache APISIX pods | `{}` | +| `apisix.securityContext` | Set the securityContext for Apache APISIX container | `{}` | +| `apisix.resources` | Set pod resource requests & limits | `{}` | +| `apisix.nodeSelector` | Node labels for Apache APISIX pod assignment | `{}` | +| `apisix.tolerations` | List of node taints to tolerate | `{}` | +| `apisix.affinity` | Set affinity for Apache APISIX deploy | `{}` | +| `apisix.podAntiAffinity.enabled` | Enable or disable podAntiAffinity | `{}` | Review comment: typo -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
