Helm Chart

The API7 Gateway Helm chart installs API7 Gateway data plane instances on Kubernetes and renders the gateway configuration from chart values. The chart supports configuration for both Kubernetes deployment resources and the gateway 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

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

Add the API7 Helm repository:

helm repo add api7 https://charts.api7.ai
helm repo update

Install or upgrade API7 Gateway with a values file:

helm upgrade --install api7-ee-3-gateway api7/gateway \
  -n api7 \
  --create-namespace \
  --version "~3.9.0" \
  -f values.yaml

The version constraint keeps the chart within the API7 Gateway 3.9.x release line while allowing compatible chart patch updates.

If API7 Dashboard generated your data plane installation command or values file, keep the generated connection settings, certificates, and token-related environment variables when you add custom values.

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 API7 Gateway chart, run:

helm show values api7/gateway

This command displays the values.yaml packaged with the latest chart. It does not read values from an installed release. For API7 Gateway 3.9.x, include --version "~3.9.0" to inspect the current 3.9.x chart values. To inspect the values currently associated with a release, use helm get values.

For chart references that match this API7 Gateway version, see the values reference for readable field descriptions and values.yaml for the raw default values and nesting:

• API7 Gateway Helm chart values reference table
• API7 Gateway Helm chart values.yaml
• API7 Gateway Helm chart ConfigMap template

The ConfigMap template is the chart-side mapping between Helm values and the generated gateway 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> api7/gateway --version "~3.9.0" -n <namespace> -f values.yaml