Skip to main content
API7.ai Logo

Helm Chart

The Apache APISIX Helm chart installs APISIX on Kubernetes and renders the gateway configuration from chart values. The chart supports configuration for both Kubernetes deployment resources and the APISIX runtime configuration generated into config.yaml.

For Kubernetes deployments, Helm values should be treated as the source of truth. Changes made directly to conf/config.yaml inside a running pod, or to the generated ConfigMap, are overwritten by the next Helm upgrade.

Chart Repository​

APISIX Helm Chart provides Helm-based installation and management of APISIX components on Kubernetes.

Add the APISIX Helm repository:

helm repo add apisix https://apache.github.io/apisix-helm-chart
helm repo update

Install or upgrade APISIX with a values file:

helm upgrade --install apisix apisix/apisix \
  -n apisix \
  --create-namespace \
  -f values.yaml

Chart Values​

Helm chart values define the configuration of a chart. They can come from the chart's default values.yaml file or be overridden during installation or upgrade to customize the deployment.

View Default Values​

To view the default values provided by the APISIX chart, run:

helm show values apisix/apisix

This command displays the values.yaml packaged with the latest published chart after helm repo update. It does not read values from an installed release. To inspect the values currently associated with a release, use helm get values.

The Apache APISIX Helm chart is versioned independently of APISIX. Use the latest published chart for field names, defaults, and the ConfigMap mapping. Set image.tag to the Docker image for this APISIX version when the chart's default image is a different release.

Published chart references that always follow the latest release:

The ConfigMap template in that chart is the mapping between Helm values and the generated APISIX config.yaml. It is the reference for cases where a native gateway configuration key has a different Helm value name, or when a plugin's static configuration section requires updates to config.yaml.

View Effective Values​

To view the values applied to an installed release, including defaults and overrides, run:

helm get values <release-name> -n <namespace> --all

Update Values​

To update a Helm release, export the full set of values for the release to a file:

helm get values <release-name> -n <namespace> --all -o yaml > values.yaml

Edit values.yaml, then apply the updated values:

helm upgrade <release-name> apisix/apisix -n <namespace> -f values.yaml