charts/bitnami/apisix

Bitnami package for Apache APISIX

Apache APISIX is high-performance, real-time API Gateway. Features load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, amongst others.

Overview of Apache APISIX

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

helm install my-release oci://registry-1.docker.io/bitnamicharts/apisix

Looking to use Apache APISIX in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

⚠️ Important Notice: Upcoming changes to the Bitnami Catalog

Beginning August 28th, 2025, Bitnami will evolve its public catalog to offer a curated set of hardened, security-focused images under the new Bitnami Secure Images initiative. As part of this transition:

• Granting community users access for the first time to security-optimized versions of popular container images.
• Bitnami will begin deprecating support for non-hardened, Debian-based software images in its free tier and will gradually remove non-latest tags from the public catalog. As a result, community users will have access to a reduced number of hardened images. These images are published only under the “latest” tag and are intended for development purposes
• Starting August 28th, over two weeks, all existing container images, including older or versioned tags (e.g., 2.50.0, 10.6), will be migrated from the public catalog (docker.io/bitnami) to the “Bitnami Legacy” repository (docker.io/bitnamilegacy), where they will no longer receive updates.
• For production workloads and long-term support, users are encouraged to adopt Bitnami Secure Images, which include hardened containers, smaller attack surfaces, CVE transparency (via VEX/KEV), SBOMs, and enterprise support.

These changes aim to improve the security posture of all Bitnami users by promoting best practices for software supply chain integrity and up-to-date deployments. For more details, visit the Bitnami Secure Images announcement.

Introduction

This chart bootstraps a Apache APISIX deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

• Kubernetes 1.23+
• Helm 3.8.0+

Installing the Chart

To install the chart with the release name my-release:

helm install my-release my-repo/apisix

The command deploys apisix on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Configuration and installation details

Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.

Prometheus metrics

This chart can be integrated with Prometheus by setting *.metrics.enabled (under the dataPlane, controlPlane and ingressController sections) to true. This will expose the APISIX native Prometheus port in both the containers and services. The services will also have the necessary annotations to be automatically scraped by Prometheus.

Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.

Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value *.metrics.serviceMonitor.enabled=true (under the dataPlane, controlPlane and ingressController sections). Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Update credentials

The Bitnami APISIX chart, when upgrading, reuses the secret previously rendered by the chart or the one specified in auth.existingSecret. To update credentials, use one of the following:

• Run helm upgrade specifying a new password in dashboard.password
• Run helm upgrade specifying a new secret in dashboard.existingSecret

Deployment modes

Apache APISIX supports multiple deployment modes. The Bitnami APISIX chart deploys the decoupled mode by default, but it is possible to deploy in traditional or standalone modes as well.

Traditional mode

The following values configure the traditional mode:

dataPlane:
  enabled: false
controlPlane:
  extraConfig:
    deployment:
      role: traditional
      role_traditional:
        config_provider: etcd
  service:
    extraPorts:
      - name: http
        port: 80
        targetPort: 9080
      - name: https
        port: 443
        targetPort: 9443

Standalone mode

The following values configure the standalone mode:

controlPlane:
  enabled: false
ingressController:
  enabled: false
etcd:
  enabled: false
dashboard:
  enabled: false
dataPlane:
  extraConfig:
    deployment:
      role_data_plane:
        config_provider: yaml
  extraVolumes:
    - name: routes
      configMap:
        name: apisix-routes
  extraVolumeMounts:
    - name: routes
      mountPath: /usr/local/apisix/conf/apisix.yaml
      subPath: apisix.yaml
extraDeploy:
  - apiVersion: v1
    kind: ConfigMap
    metadata:
      name: apisix-routes
    data:
      apisix.yaml: |-
        routes:
          -
            uri: /hello
            upstream:
                nodes:
                    "127.0.0.1:1980": 1
                type: roundrobin
        #END

Ingress

This chart provides support for Ingress resources. If you have an ingress controller installed on your cluster, such as nginx-ingress-controller or contour you can utilize the ingress controller to serve your application.To enable Ingress integration, set ingress.enabled to true.

The most common scenario is to have one host name mapped to the deployment. In this case, the ingress.hostname property can be used to set the host name. The ingress.tls parameter can be used to add the TLS configuration for this host.

However, it is also possible to have more than one host. To facilitate this, the ingress.extraHosts parameter (if available) can be set with the host names specified as an array. The ingress.extraTLS parameter (if available) can also be used to add the TLS configuration for extra hosts.

NOTE: For each host specified in the ingress.extraHosts parameter, it is necessary to set a name, path, and any annotations that the Ingress controller should know about. Not all annotations are supported by all Ingress controllers, but this annotation reference document lists the annotations supported by many popular Ingress controllers.

Adding the TLS parameter (where available) will cause the chart to generate HTTPS URLs, and the application will be available on port 443. The actual TLS secrets do not have to be generated by this chart. However, if TLS is enabled, the Ingress record will not work until the TLS secret exists.

Learn more about Ingress controllers.

Securing traffic using TLS

This chart facilitates the creation of TLS secrets for use with the Ingress controller (although this is not mandatory). There are several common use cases:

• Generate certificate secrets based on chart parameters.
• Enable externally generated certificates.
• Manage application certificates via an external service (like cert-manager).
• Create self-signed certificates within the chart (if supported).

In the first two cases, a certificate and a key are needed. Files are expected in .pem format.

Here is an example of a certificate file:

NOTE: There may be more than one certificate if there is a certificate chain.

-----BEGIN CERTIFICATE-----
MIID6TCCAtGgAwIBAgIJAIaCwivkeB5EMA0GCSqGSIb3DQEBCwUAMFYxCzAJBgNV
...
jScrvkiBO65F46KioCL9h5tDvomdU1aqpI/CBzhvZn1c0ZTf87tGQR8NK7v7
-----END CERTIFICATE-----

Here is an example of a certificate key:

-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAvLYcyu8f3skuRyUgeeNpeDvYBCDcgq+LsWap6zbX5f8oLqp4
...
wrj2wDbCDCFmfqnSJ+dKI3vFLlEz44sAV8jX/kd4Y6ZTQhlLbYc=
-----END RSA PRIVATE KEY-----

• If using Helm to manage the certificates based on the parameters, copy these values into the certificate and key values for a given *.ingress.secrets entry.
• If managing TLS secrets separately, it is necessary to create a TLS secret with name INGRESS_HOSTNAME-tls (where INGRESS_HOSTNAME is a placeholder to be replaced with the hostname you set using the *.ingress.hostname parameter).
• If your cluster has a cert-manager add-on to automate the management and issuance of TLS certificates, add to *.ingress.annotations the corresponding ones for cert-manager.
• If using self-signed certificates created by Helm, set both *.ingress.tls and *.ingress.selfSigned to true.

Backup and restore

To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.

External etcd support

You may want to have APISIX connect to an external etcd rather than installing one inside your cluster. Typical reasons for this are to use a managed database service, or to share a common database server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the externalEtcd parameter. You should also disable the etcd installation with the etcd.enabled option. Here is an example:

etcd:
  enabled: false
externalEtcd:
  hosts:
    - externalhost

Additional environment variables

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property inside the dataPlane, controlPlane, dashboard and ingressController sections.

dataPlane:
  extraEnvVars:
    - name: LOG_LEVEL
      value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values inside the dataPlane, controlPlane, dashboard and ingressController sections.

Sidecars

If additional containers are needed in the same pod as APISIX (such as additional metrics or logging exporters), they can be defined using the sidecars parameter inside the dataPlane, controlPlane, dashboard and ingressController sections.

sidecars:
- name: your-image-name
  image: your-image
  imagePullPolicy: Always
  ports:
  - name: portname
    containerPort: 1234

If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts parameter (where available), as shown in the example below:

service:
  extraPorts:
  - name: extraPort
    port: 11311
    targetPort: 11311

NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the --enable-metrics=true parameter at deployment time. The sidecars parameter should therefore only be used for any extra sidecar containers.

If additional init containers are needed in the same pod, they can be defined using the initContainers parameter. Here is an example:

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Learn more about sidecar containers and init containers.

Pod affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod affinity in the kubernetes documentation.

As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters inside the dataPlane, controlPlane, dashboard and ingressController sections.

Parameters

Global parameters

Name	Description	Value
global.imageRegistry	Global Docker image registry	""
global.imagePullSecrets	Global Docker registry secret names as an array	[]
global.defaultStorageClass	Global default StorageClass for Persistent Volume(s)	""
global.security.allowInsecureImages	Allows skipping image verification	false
global.compatibility.openshift.adaptSecurityContext	Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation)	auto

Common parameters

Name	Description	Value
kubeVersion	Override Kubernetes version	""
apiVersions	Override Kubernetes API versions reported by .Capabilities	[]
nameOverride	String to partially override common.names.name	""
fullnameOverride	String to fully override common.names.fullname	""
namespaceOverride	String to fully override common.names.namespace	""
commonLabels	Labels to add to all deployed objects	{}
commonAnnotations	Annotations to add to all deployed objects	{}
clusterDomain	Kubernetes cluster domain name	cluster.local
extraDeploy	Array of extra objects to deploy with the release	[]
usePasswordFiles	Mount credentials as files instead of using environment variables	true
diagnosticMode.enabled	Enable diagnostic mode (all probes will be disabled and the command will be overridden)	false
diagnosticMode.command	Command to override all containers in the deployment	["sleep"]
diagnosticMode.args	Args to override all containers in the deployment	["infinity"]
image.registry	APISIX image registry	REGISTRY_NAME
image.repository	APISIX image repository	REPOSITORY_NAME/apisix
image.digest	APISIX image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended)	""
image.pullPolicy	APISIX image pull policy	IfNotPresent
image.pullSecrets	APISIX image pull secrets	[]
image.debug	Enable APISIX image debug mode	false

APISIX Data Plane parameters

Name	Description	Value
dataPlane.enabled	Enable APISIX Data Plane	true
dataPlane.useDaemonSet	Deploy Data Plane as DaemonSet	false
dataPlane.replicaCount	Number of APISIX Data Plane replicas to deploy	1
dataPlane.hostNetwork	Use hostNetwork in APISIX Data Plane	false
dataPlane.dnsPolicy	DNS policy for APISIX Data Plane pods	ClusterFirst
dataPlane.containerPorts.http	APISIX Data Plane HTTP container port	9080
dataPlane.containerPorts.https	APISIX Data Plane HTTPS container port	9443
dataPlane.containerPorts.control	APISIX Data Plane control container port	9090
dataPlane.containerPorts.metrics	APISIX Data Plane metrics container port	9099
dataPlane.livenessProbe.enabled	Enable livenessProbe on APISIX Data Plane containers	true
dataPlane.livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	5
dataPlane.livenessProbe.periodSeconds	Period seconds for livenessProbe	10
dataPlane.livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	5
dataPlane.livenessProbe.failureThreshold	Failure threshold for livenessProbe	5
dataPlane.livenessProbe.successThreshold	Success threshold for livenessProbe	1
dataPlane.readinessProbe.enabled	Enable readinessProbe on APISIX Data Plane containers	true
dataPlane.readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	5
dataPlane.readinessProbe.periodSeconds	Period seconds for readinessProbe	10
dataPlane.readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	5
dataPlane.readinessProbe.failureThreshold	Failure threshold for readinessProbe	5
dataPlane.readinessProbe.successThreshold	Success threshold for readinessProbe	1
dataPlane.startupProbe.enabled	Enable startupProbe on APISIX Data Plane containers	false
dataPlane.startupProbe.initialDelaySeconds	Initial delay seconds for startupProbe	5
dataPlane.startupProbe.periodSeconds	Period seconds for startupProbe	10
dataPlane.startupProbe.timeoutSeconds	Timeout seconds for startupProbe	5
dataPlane.startupProbe.failureThreshold	Failure threshold for startupProbe	5
dataPlane.startupProbe.successThreshold	Success threshold for startupProbe	1
dataPlane.customLivenessProbe	Custom livenessProbe that overrides the default one	{}
dataPlane.customReadinessProbe	Custom readinessProbe that overrides the default one	{}
dataPlane.customStartupProbe	Custom startupProbe that overrides the default one	{}
dataPlane.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if dataPlane.resources is set (dataPlane.resources is recommended for production).	nano
dataPlane.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
dataPlane.podSecurityContext.enabled	Enabled APISIX Data Plane pods' Security Context	true
dataPlane.podSecurityContext.fsGroupChangePolicy	Set filesystem group change policy	Always
dataPlane.podSecurityContext.sysctls	Set kernel settings using the sysctl interface	[]
dataPlane.podSecurityContext.supplementalGroups	Set filesystem extra groups	[]
dataPlane.podSecurityContext.fsGroup	Set APISIX Data Plane pod's Security Context fsGroup	1001
dataPlane.containerSecurityContext.enabled	Enabled APISIX Data Plane containers' Security Context	true
dataPlane.containerSecurityContext.seLinuxOptions	Set SELinux options in container	{}
dataPlane.containerSecurityContext.runAsUser	Set APISIX Data Plane containers' Security Context runAsUser	1001
dataPlane.containerSecurityContext.runAsGroup	Set APISIX Data Plane containers' Security Context runAsGroup	1001
dataPlane.containerSecurityContext.runAsNonRoot	Set APISIX Data Plane containers' Security Context runAsNonRoot	true
dataPlane.containerSecurityContext.privileged	Set APISIX Data Plane containers' Security Context privileged	false
dataPlane.containerSecurityContext.readOnlyRootFilesystem	Set APISIX Data Plane containers' Security Context runAsNonRoot	true
dataPlane.containerSecurityContext.allowPrivilegeEscalation	Set APISIX Data Plane container's privilege escalation	false
dataPlane.containerSecurityContext.capabilities.drop	Set APISIX Data Plane container's Security Context runAsNonRoot	["ALL"]
dataPlane.containerSecurityContext.seccompProfile.type	Set APISIX Data Plane container's Security Context seccomp profile	RuntimeDefault
dataPlane.command	Override default container command (useful when using custom images)	[]
dataPlane.args	Override default container args (useful when using custom images)	[]
dataPlane.automountServiceAccountToken	Mount Service Account token in pod	true
dataPlane.hostAliases	APISIX Data Plane pods host aliases	[]
dataPlane.defaultConfig	APISIX Data Plane configuration (evaluated as a template)	""
dataPlane.extraConfig	extra configuration parameters to add to the config.yaml file in APISIX Data Plane	{}
dataPlane.existingConfigMap	name of a ConfigMap with existing configuration for APISIX Data Plane	""
dataPlane.extraConfigExistingConfigMap	name of a ConfigMap with existing configuration for APISIX Data Plane	""
dataPlane.tls.enabled	Enable TLS transport in APISIX Data Plane	true
dataPlane.tls.autoGenerated	Auto-generate self-signed certificates	true
dataPlane.tls.existingSecret	Name of a secret containing the certificates	""
dataPlane.tls.certFilename	Path of the certificate file when mounted as a secret	tls.crt
dataPlane.tls.certKeyFilename	Path of the certificate key file when mounted as a secret	tls.key
dataPlane.tls.certCAFilename	Path of the certificate CA file when mounted as a secret	ca.crt
dataPlane.tls.cert	Content of the certificate to be added to the secret	""
dataPlane.tls.key	Content of the certificate key to be added to the secret	""
dataPlane.tls.ca	Content of the certificate CA to be added to the secret	""
dataPlane.podLabels	Extra labels for APISIX Data Plane pods	{}
dataPlane.podAnnotations	Annotations for APISIX Data Plane pods	{}
dataPlane.podAffinityPreset	Pod affinity preset. Ignored if apisix.affinity is set. Allowed values: soft or hard	""
dataPlane.podAntiAffinityPreset	Pod anti-affinity preset. Ignored if apisix.affinity is set. Allowed values: soft or hard	soft
dataPlane.pdb.create	Enable/disable a Pod Disruption Budget creation	true
dataPlane.pdb.minAvailable	Minimum number/percentage of pods that should remain scheduled	""
dataPlane.pdb.maxUnavailable	Maximum number/percentage of pods that may be made unavailable	""
dataPlane.nodeAffinityPreset.type	Node affinity preset type. Ignored if apisix.affinity is set. Allowed values: soft or hard	""
dataPlane.nodeAffinityPreset.key	Node label key to match. Ignored if apisix.affinity is set	""
dataPlane.nodeAffinityPreset.values	Node label values to match. Ignored if apisix.affinity is set	[]
dataPlane.affinity	Affinity for APISIX Data Plane pods assignment	{}
dataPlane.nodeSelector	Node labels for APISIX Data Plane pods assignment	{}
dataPlane.tolerations	Tolerations for APISIX Data Plane pods assignment	[]
dataPlane.updateStrategy.type	APISIX Data Plane statefulset strategy type	RollingUpdate
dataPlane.priorityClassName	APISIX Data Plane pods' priorityClassName	""
dataPlane.topologySpreadConstraints	Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template	[]
dataPlane.schedulerName	Name of the k8s scheduler (other than default) for APISIX Data Plane pods	""
dataPlane.terminationGracePeriodSeconds	Seconds Redmine pod needs to terminate gracefully	""
dataPlane.lifecycleHooks	for the APISIX Data Plane container(s) to automate configuration before or after startup	{}
dataPlane.extraEnvVars	Array with extra environment variables to add to APISIX Data Plane nodes	[]
dataPlane.extraEnvVarsCM	Name of existing ConfigMap containing extra env vars for APISIX Data Plane nodes	""
dataPlane.extraEnvVarsSecret	Name of existing Secret containing extra env vars for APISIX Data Plane nodes	""
dataPlane.extraVolumes	Optionally specify extra list of additional volumes for the APISIX Data Plane pod(s)	[]
dataPlane.extraVolumeMounts	Optionally specify extra list of additional volumeMounts for the APISIX Data Plane container(s)	[]
dataPlane.sidecars	Add additional sidecar containers to the APISIX Data Plane pod(s)	[]
dataPlane.initContainers	Add additional init containers to the APISIX Data Plane pod(s)	[]

APISIX Data Plane Traffic Exposure Parameters

Name	Description	Value
dataPlane.service.type	APISIX Data Plane service type	LoadBalancer
dataPlane.service.ports.http	APISIX Data Plane service HTTP port	80
dataPlane.service.ports.https	APISIX Data Plane service HTTPS port	443
dataPlane.service.ports.metrics	APISIX Data Plane service HTTPS port	8080
dataPlane.service.nodePorts.http	Node port for HTTP	""
dataPlane.service.nodePorts.https	Node port for HTTPS	""
dataPlane.service.nodePorts.metrics	Node port for metrics	""
dataPlane.service.clusterIP	APISIX Data Plane service Cluster IP	""
dataPlane.service.loadBalancerIP	APISIX Data Plane service Load Balancer IP	""
dataPlane.service.loadBalancerSourceRanges	APISIX Data Plane service Load Balancer sources	[]
dataPlane.service.externalIPs	APISIX Data Plane service External IPs	[]
dataPlane.service.externalTrafficPolicy	APISIX Data Plane service external traffic policy	Cluster
dataPlane.service.annotations	Additional custom annotations for APISIX Data Plane service	{}
dataPlane.service.extraPorts	Extra ports to expose in APISIX Data Plane service (normally used with the sidecars value)	[]
dataPlane.service.sessionAffinity	Control where web requests go, to the same pod or round-robin	None
dataPlane.service.sessionAffinityConfig	Additional settings for the sessionAffinity	{}
dataPlane.networkPolicy.enabled	Specifies whether a NetworkPolicy should be created	true
dataPlane.networkPolicy.allowExternal	Don't require server label for connections	true
dataPlane.networkPolicy.allowExternalEgress	Allow the pod to access any range of port and all destinations.	true
dataPlane.networkPolicy.kubeAPIServerPorts	List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)	[]
dataPlane.networkPolicy.extraIngress	Add extra ingress rules to the NetworkPolicy	[]
dataPlane.networkPolicy.extraEgress	Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)	[]
dataPlane.networkPolicy.ingressNSMatchLabels	Labels to match to allow traffic from other namespaces	{}
dataPlane.networkPolicy.ingressNSPodMatchLabels	Pod labels to match to allow traffic from other namespaces	{}
dataPlane.ingress.enabled	Enable ingress record generation for APISIX Data Plane	false
dataPlane.ingress.pathType	Ingress path type	ImplementationSpecific
dataPlane.ingress.apiVersion	Force Ingress API version (automatically detected if not set)	""
dataPlane.ingress.hostname	Default host for the ingress record	apisix-data-plane.local
dataPlane.ingress.ingressClassName	IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)	""
dataPlane.ingress.path	Default path for the ingress record	/
dataPlane.ingress.annotations	Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.	{}
dataPlane.ingress.tls	Enable TLS configuration for the host defined at dataPlane.ingress.hostname parameter	false
dataPlane.ingress.selfSigned	Create a TLS secret for this ingress record using self-signed certificates generated by Helm	false
dataPlane.ingress.extraHosts	An array with additional hostname(s) to be covered with the ingress record	[]
dataPlane.ingress.extraPaths	An array with additional arbitrary paths that may need to be added to the ingress under the main host	[]
dataPlane.ingress.extraTls	TLS configuration for additional hostname(s) to be covered with this ingress record	[]
dataPlane.ingress.secrets	Custom TLS certificates as secrets	[]
dataPlane.ingress.extraRules	Additional rules to be covered with this ingress record	[]

APISIX Data Plane Autoscaling configuration

Name	Description	Value
dataPlane.autoscaling.vpa.enabled	Enable VPA	false
dataPlane.autoscaling.vpa.annotations	Annotations for VPA resource	{}
dataPlane.autoscaling.vpa.controlledResources	VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory	[]
dataPlane.autoscaling.vpa.maxAllowed	VPA Max allowed resources for the pod	{}
dataPlane.autoscaling.vpa.minAllowed	VPA Min allowed resources for the pod	{}
dataPlane.autoscaling.vpa.updatePolicy.updateMode	Autoscaling update policy Specifies whether recommended updates are applied when a Pod is started and whether recommended updates are applied during the life of a Pod	Auto
dataPlane.autoscaling.hpa.enabled	Enable HPA for APISIX Data Plane	false
dataPlane.autoscaling.hpa.minReplicas	Minimum number of APISIX Data Plane replicas	""
dataPlane.autoscaling.hpa.maxReplicas	Maximum number of APISIX Data Plane replicas	""
dataPlane.autoscaling.hpa.targetCPU	Target CPU utilization percentage	""
dataPlane.autoscaling.hpa.targetMemory	Target Memory utilization percentage	""

APISIX Data Plane RBAC Parameters

Name	Description	Value
dataPlane.rbac.create	Specifies whether RBAC resources should be created	true
dataPlane.rbac.rules	Custom RBAC rules to set	[]
dataPlane.serviceAccount.create	Specifies whether a ServiceAccount should be created	true
dataPlane.serviceAccount.name	The name of the ServiceAccount to use.	""
dataPlane.serviceAccount.annotations	Additional Service Account annotations (evaluated as a template)	{}
dataPlane.serviceAccount.automountServiceAccountToken	Automount service account token for the APISIX Data Plane service account	false

APISIX Data Plane Metrics Parameters

Name	Description	Value
dataPlane.metrics.enabled	Enable the export of Prometheus metrics	false
dataPlane.metrics.annotations	Annotations for the APISIX Data Plane service in order to scrape metrics	{}
dataPlane.metrics.serviceMonitor.enabled	if true, creates a Prometheus Operator ServiceMonitor (also requires metrics.enabled to be true)	false
dataPlane.metrics.serviceMonitor.namespace	Namespace in which Prometheus is running	""
dataPlane.metrics.serviceMonitor.annotations	Additional custom annotations for the ServiceMonitor	{}
dataPlane.metrics.serviceMonitor.labels	Extra labels for the ServiceMonitor	{}
dataPlane.metrics.serviceMonitor.jobLabel	The name of the label on the target service to use as the job name in Prometheus	""
dataPlane.metrics.serviceMonitor.honorLabels	honorLabels chooses the metric's labels on collisions with target labels	false
dataPlane.metrics.serviceMonitor.interval	Interval at which metrics should be scraped.	""
dataPlane.metrics.serviceMonitor.scrapeTimeout	Timeout after which the scrape is ended	""
dataPlane.metrics.serviceMonitor.metricRelabelings	Specify additional relabeling of metrics	[]
dataPlane.metrics.serviceMonitor.relabelings	Specify general relabeling	[]
dataPlane.metrics.serviceMonitor.selector	Prometheus instance selector labels	{}

APISIX Control Plane Parameters

Name	Description	Value
controlPlane.enabled	Enable APISIX Control Plane	true
controlPlane.replicaCount	Number of APISIX Control Plane replicas to deploy	1
controlPlane.hostNetwork	Use hostNetwork	false
controlPlane.dnsPolicy	DNS policy for APISIX Control Plane pods	ClusterFirst
controlPlane.useDaemonSet	Deploy as DaemonSet	false
controlPlane.dashboardEnabled	Enable APISIX Control Plane to expose APISIX Dashboards	true
controlPlane.containerPorts.adminAPI	APISIX Control Plane Admin API port	9180
controlPlane.containerPorts.configServer	APISIX Control Plane config port	9280
controlPlane.containerPorts.control	APISIX Control Plane control port	9090
controlPlane.containerPorts.metrics	APISIX Control Plane metrics port	9099
controlPlane.livenessProbe.enabled	Enable livenessProbe on APISIX Control Plane containers	true
controlPlane.livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	5
controlPlane.livenessProbe.periodSeconds	Period seconds for livenessProbe	10
controlPlane.livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	5
controlPlane.livenessProbe.failureThreshold	Failure threshold for livenessProbe	5
controlPlane.livenessProbe.successThreshold	Success threshold for livenessProbe	1
controlPlane.readinessProbe.enabled	Enable readinessProbe on APISIX Control Plane containers	true
controlPlane.readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	5
controlPlane.readinessProbe.periodSeconds	Period seconds for readinessProbe	10
controlPlane.readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	5
controlPlane.readinessProbe.failureThreshold	Failure threshold for readinessProbe	5
controlPlane.readinessProbe.successThreshold	Success threshold for readinessProbe	1
controlPlane.startupProbe.enabled	Enable startupProbe on APISIX Control Plane containers	false
controlPlane.startupProbe.initialDelaySeconds	Initial delay seconds for startupProbe	5
controlPlane.startupProbe.periodSeconds	Period seconds for startupProbe	10
controlPlane.startupProbe.timeoutSeconds	Timeout seconds for startupProbe	5
controlPlane.startupProbe.failureThreshold	Failure threshold for startupProbe	5
controlPlane.startupProbe.successThreshold	Success threshold for startupProbe	1
controlPlane.customLivenessProbe	Custom livenessProbe that overrides the default one	{}
controlPlane.customReadinessProbe	Custom readinessProbe that overrides the default one	{}
controlPlane.customStartupProbe	Custom startupProbe that overrides the default one	{}
controlPlane.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if controlPlane.resources is set (controlPlane.resources is recommended for production).	nano
controlPlane.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
controlPlane.podSecurityContext.enabled	Enabled APISIX Control Plane pods' Security Context	true
controlPlane.podSecurityContext.fsGroupChangePolicy	Set filesystem group change policy	Always
controlPlane.podSecurityContext.sysctls	Set kernel settings using the sysctl interface	[]
controlPlane.podSecurityContext.supplementalGroups	Set filesystem extra groups	[]
controlPlane.podSecurityContext.fsGroup	Set APISIX Control Plane pod's Security Context fsGroup	1001
controlPlane.containerSecurityContext.enabled	Enabled APISIX Control Plane containers' Security Context	true
controlPlane.containerSecurityContext.seLinuxOptions	Set SELinux options in container	{}
controlPlane.containerSecurityContext.runAsUser	Set APISIX Control Plane containers' Security Context runAsUser	1001
controlPlane.containerSecurityContext.runAsGroup	Set APISIX Control Plane containers' Security Context runAsGroup	1001
controlPlane.containerSecurityContext.runAsNonRoot	Set APISIX Control Plane containers' Security Context runAsNonRoot	true
controlPlane.containerSecurityContext.privileged	Set APISIX Control Plane containers' Security Context privileged	false
controlPlane.containerSecurityContext.readOnlyRootFilesystem	Set APISIX Control Plane containers' Security Context runAsNonRoot	true
controlPlane.containerSecurityContext.allowPrivilegeEscalation	Set APISIX Control Plane container's privilege escalation	false
controlPlane.containerSecurityContext.capabilities.drop	Set APISIX Control Plane container's Security Context runAsNonRoot	["ALL"]
controlPlane.containerSecurityContext.seccompProfile.type	Set APISIX Control Plane container's Security Context seccomp profile	RuntimeDefault
controlPlane.command	Override default container command (useful when using custom images)	[]
controlPlane.args	Override default container args (useful when using custom images)	[]
controlPlane.automountServiceAccountToken	Mount Service Account token in pod	true
controlPlane.hostAliases	APISIX Control Plane pods host aliases	[]
controlPlane.apiTokenAdmin	Admin API Token for APISIX Control Plane	""
controlPlane.apiTokenViewer	Viewer API Token for APISIX Control Plane	""
controlPlane.existingSecret	Name of a secret containing API Tokens for APISIX Control Plane	""
controlPlane.existingSecretAdminTokenKey	Key inside the secret containing the Admin API Tokens for APISIX Control Plane	""
controlPlane.existingSecretViewerTokenKey	Key inside the secret containing the Viewer API Tokens for APISIX Control Plane	""
controlPlane.defaultConfig	APISIX Control Plane configuration (evaluated as a template)	""
controlPlane.extraConfig	extra configuration parameters to add to the config.yaml file in APISIX Control plane	{}
controlPlane.existingConfigMap	name of a ConfigMap with existing configuration for APISIX Control Plane	""
controlPlane.extraConfigExistingConfigMap	name of a ConfigMap with existing configuration for APISIX Control Plane	""
controlPlane.tls.enabled	Enable TLS transport in APISIX Control Plane	true
controlPlane.tls.autoGenerated	Auto-generate self-signed certificates	true
controlPlane.tls.existingSecret	Name of a secret containing the certificates	""
controlPlane.tls.certFilename	Path of the certificate file when mounted as a secret	tls.crt
controlPlane.tls.certKeyFilename	Path of the certificate key file when mounted as a secret	tls.key
controlPlane.tls.certCAFilename	Path of the certificate CA file when mounted as a secret	ca.crt
controlPlane.tls.cert	Content of the certificate to be added to the secret	""
controlPlane.tls.key	Content of the certificate key to be added to the secret	""
controlPlane.tls.ca	Content of the certificate CA to be added to the secret	""
controlPlane.podLabels	Extra labels for APISIX Control Plane pods	{}
controlPlane.podAnnotations	Annotations for APISIX Control Plane pods	{}
controlPlane.podAffinityPreset	Pod affinity preset. Ignored if apisix.affinity is set. Allowed values: soft or hard	""
controlPlane.podAntiAffinityPreset	Pod anti-affinity preset. Ignored if apisix.affinity is set. Allowed values: soft or hard	soft
controlPlane.pdb.create	Enable/disable a Pod Disruption Budget creation	true
controlPlane.pdb.minAvailable	Minimum number/percentage of pods that should remain scheduled	""
controlPlane.pdb.maxUnavailable	Maximum number/percentage of pods that may be made unavailable	""
controlPlane.nodeAffinityPreset.type	Node affinity preset type. Ignored if apisix.affinity is set. Allowed values: soft or hard	""
controlPlane.nodeAffinityPreset.key	Node label key to match. Ignored if apisix.affinity is set	""
controlPlane.nodeAffinityPreset.values	Node label values to match. Ignored if apisix.affinity is set	[]
controlPlane.affinity	Affinity for APISIX Control Plane pods assignment	{}
controlPlane.nodeSelector	Node labels for APISIX Control Plane pods assignment	{}
controlPlane.tolerations	Tolerations for APISIX Control Plane pods assignment	[]
controlPlane.updateStrategy.type	APISIX Control Plane statefulset strategy type	RollingUpdate
controlPlane.priorityClassName	APISIX Control Plane pods' priorityClassName	""
controlPlane.topologySpreadConstraints	Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template	[]
controlPlane.schedulerName	Name of the k8s scheduler (other than default) for APISIX Control Plane pods	""
controlPlane.terminationGracePeriodSeconds	Seconds Redmine pod needs to terminate gracefully	""
controlPlane.lifecycleHooks	for the APISIX Control Plane container(s) to automate configuration before or after startup	{}
controlPlane.extraEnvVars	Array with extra environment variables to add to APISIX Control Plane nodes	[]
controlPlane.extraEnvVarsCM	Name of existing ConfigMap containing extra env vars for APISIX Control Plane nodes	""
controlPlane.extraEnvVarsSecret	Name of existing Secret containing extra env vars for APISIX Control Plane nodes	""
controlPlane.extraVolumes	Optionally specify extra list of additional volumes for the APISIX Control Plane pod(s)	[]
controlPlane.extraVolumeMounts	Optionally specify extra list of additional volumeMounts for the APISIX Control Plane container(s)	[]
controlPlane.sidecars	Add additional sidecar containers to the APISIX Control Plane pod(s)	[]
controlPlane.initContainers	Add additional init containers to the APISIX Control Plane pod(s)	[]

APISIX Control Plane Traffic Exposure Parameters

Name	Description	Value
controlPlane.service.type	APISIX Control Plane service type	ClusterIP
controlPlane.service.ports.adminAPI	APISIX Control Plane service Admin API port	9180
controlPlane.service.ports.configServer	APISIX Control Plane service Config Server port	9280
controlPlane.service.ports.metrics	APISIX Control Plane service metrics port	8080
controlPlane.service.nodePorts.adminAPI	Node port for Admin API	""
controlPlane.service.nodePorts.configServer	Node port for Config Server	""
controlPlane.service.nodePorts.metrics	Node port for Metrics	""
controlPlane.service.clusterIP	APISIX Control Plane service Cluster IP	""
controlPlane.service.loadBalancerIP	APISIX Control Plane service Load Balancer IP	""
controlPlane.service.loadBalancerSourceRanges	APISIX Control Plane service Load Balancer sources	[]
controlPlane.service.externalIPs	APISIX Control Plane service External IPs	[]
controlPlane.service.externalTrafficPolicy	APISIX Control Plane service external traffic policy	Cluster
controlPlane.service.annotations	Additional custom annotations for APISIX Control Plane service	{}
controlPlane.service.extraPorts	Extra ports to expose in APISIX Control Plane service (normally used with the sidecars value)	[]
controlPlane.service.sessionAffinity	Control where web requests go, to the same pod or round-robin	None
controlPlane.service.sessionAffinityConfig	Additional settings for the sessionAffinity	{}
controlPlane.networkPolicy.enabled	Specifies whether a NetworkPolicy should be created	true
controlPlane.networkPolicy.allowExternal	Don't require server label for connections	true
controlPlane.networkPolicy.allowExternalEgress	Allow the pod to access any range of port and all destinations.	true
controlPlane.networkPolicy.kubeAPIServerPorts	List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)	[]
controlPlane.networkPolicy.extraIngress	Add extra ingress rules to the NetworkPolicy	[]
controlPlane.networkPolicy.extraEgress	Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)	[]
controlPlane.networkPolicy.ingressNSMatchLabels	Labels to match to allow traffic from other namespaces	{}
controlPlane.networkPolicy.ingressNSPodMatchLabels	Pod labels to match to allow traffic from other namespaces	{}
controlPlane.ingress.enabled	Enable ingress record generation for APISIX Control Plane	false
controlPlane.ingress.pathType	Ingress path type	ImplementationSpecific
controlPlane.ingress.apiVersion	Force Ingress API version (automatically detected if not set)	""
controlPlane.ingress.hostname	Default host for the ingress record	apisix-control-plane.local
controlPlane.ingress.ingressClassName	IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)	""
controlPlane.ingress.path	Default path for the ingress record	/
controlPlane.ingress.annotations	Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.	{}
controlPlane.ingress.tls	Enable TLS configuration for the host defined at controlPlane.ingress.hostname parameter	false
controlPlane.ingress.selfSigned	Create a TLS secret for this ingress record using self-signed certificates generated by Helm	false
controlPlane.ingress.extraHosts	An array with additional hostname(s) to be covered with the ingress record	[]
controlPlane.ingress.extraPaths	An array with additional arbitrary paths that may need to be added to the ingress under the main host	[]
controlPlane.ingress.extraTls	TLS configuration for additional hostname(s) to be covered with this ingress record	[]
controlPlane.ingress.secrets	Custom TLS certificates as secrets	[]
controlPlane.ingress.extraRules	Additional rules to be covered with this ingress record	[]

APISIX Control Plane Autoscaling configuration

Name	Description	Value
controlPlane.autoscaling.vpa.enabled	Enable VPA	false
controlPlane.autoscaling.vpa.annotations	Annotations for VPA resource	{}
controlPlane.autoscaling.vpa.controlledResources	VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory	[]
controlPlane.autoscaling.vpa.maxAllowed	VPA Max allowed resources for the pod	{}
controlPlane.autoscaling.vpa.minAllowed	VPA Min allowed resources for the pod	{}
controlPlane.autoscaling.vpa.updatePolicy.updateMode	Autoscaling update policy Specifies whether recommended updates are applied when a Pod is started and whether recommended updates are applied during the life of a Pod	Auto
controlPlane.autoscaling.hpa.enabled	Enable HPA for APISIX Control Plane	false
controlPlane.autoscaling.hpa.minReplicas	Minimum number of APISIX Control Plane replicas	""
controlPlane.autoscaling.hpa.maxReplicas	Maximum number of APISIX Control Plane replicas	""
controlPlane.autoscaling.hpa.targetCPU	Target CPU utilization percentage	""
controlPlane.autoscaling.hpa.targetMemory	Target Memory utilization percentage	""

APISIX Control Plane RBAC parameters

Name	Description	Value
controlPlane.rbac.create	Specifies whether RBAC resources should be created	true
controlPlane.rbac.rules	Custom RBAC rules to set	[]
controlPlane.serviceAccount.create	Specifies whether a ServiceAccount should be created	true
controlPlane.serviceAccount.name	The name of the ServiceAccount to use.	""
controlPlane.serviceAccount.annotations	Additional Service Account annotations (evaluated as a template)	{}
controlPlane.serviceAccount.automountServiceAccountToken	Automount service account token for the APISIX Control Plane service account	false

APISIX Control Plane Metrics Parameters

Name	Description	Value
controlPlane.metrics.enabled	Enable the export of Prometheus metrics	false
controlPlane.metrics.annotations	Annotations for the APISIX Control Plane service in order to scrape metrics	{}
controlPlane.metrics.serviceMonitor.enabled	if true, creates a Prometheus Operator ServiceMonitor (also requires metrics.enabled to be true)	false
controlPlane.metrics.serviceMonitor.namespace	Namespace in which Prometheus is running	""
controlPlane.metrics.serviceMonitor.annotations	Additional custom annotations for the ServiceMonitor	{}
controlPlane.metrics.serviceMonitor.labels	Extra labels for the ServiceMonitor	{}
controlPlane.metrics.serviceMonitor.jobLabel	The name of the label on the target service to use as the job name in Prometheus	""
controlPlane.metrics.serviceMonitor.honorLabels	honorLabels chooses the metric's labels on collisions with target labels	false
controlPlane.metrics.serviceMonitor.interval	Interval at which metrics should be scraped.	""
controlPlane.metrics.serviceMonitor.scrapeTimeout	Timeout after which the scrape is ended	""
controlPlane.metrics.serviceMonitor.metricRelabelings	Specify additional relabeling of metrics	[]
controlPlane.metrics.serviceMonitor.relabelings	Specify general relabeling	[]
controlPlane.metrics.serviceMonitor.selector	Prometheus instance selector labels	{}

APISIX Ingress Controller Parameters

Name	Description	Value
ingressController.enabled	Enable APISIX Ingress Controller	true
ingressController.image.registry	APISIX Ingress Controller image registry	REGISTRY_NAME
ingressController.image.repository	APISIX Ingress Controller image repository	REPOSITORY_NAME/apisix-ingress-controller
ingressController.image.digest	APISIX Ingress Controller image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended)	""
ingressController.image.pullPolicy	APISIX Ingress Controller image pull policy	IfNotPresent
ingressController.image.pullSecrets	APISIX Ingress Controller image pull secrets	[]
ingressController.image.debug	Enable APISIX Ingress Controller image debug mode	false
ingressController.replicaCount	Number of APISIX Ingress Controller replicas to deploy	1
ingressController.containerPorts.http	APISIX Ingress Controller http container port	8080
ingressController.containerPorts.https	APISIX Ingress Controller https container port	8443
ingressController.livenessProbe.enabled	Enable livenessProbe on APISIX Ingress Controller containers	true
ingressController.livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	5
ingressController.livenessProbe.periodSeconds	Period seconds for livenessProbe	10
ingressController.livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	5
ingressController.livenessProbe.failureThreshold	Failure threshold for livenessProbe	5
ingressController.livenessProbe.successThreshold	Success threshold for livenessProbe	1
ingressController.readinessProbe.enabled	Enable readinessProbe on APISIX Ingress Controller containers	true
ingressController.readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	5
ingressController.readinessProbe.periodSeconds	Period seconds for readinessProbe	10
ingressController.readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	5
ingressController.readinessProbe.failureThreshold	Failure threshold for readinessProbe	5
ingressController.readinessProbe.successThreshold	Success threshold for readinessProbe	1
ingressController.startupProbe.enabled	Enable startupProbe on APISIX Ingress Controller containers	false
ingressController.startupProbe.initialDelaySeconds	Initial delay seconds for startupProbe	5
ingressController.startupProbe.periodSeconds	Period seconds for startupProbe	10
ingressController.startupProbe.timeoutSeconds	Timeout seconds for startupProbe	5
ingressController.startupProbe.failureThreshold	Failure threshold for startupProbe	5
ingressController.startupProbe.successThreshold	Success threshold for startupProbe	1
ingressController.customLivenessProbe	Custom livenessProbe that overrides the default one	{}
ingressController.customReadinessProbe	Custom readinessProbe that overrides the default one	{}
ingressController.customStartupProbe	Custom startupProbe that overrides the default one	{}
ingressController.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if ingressController.resources is set (ingressController.resources is recommended for production).	nano
ingressController.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
ingressController.podSecurityContext.enabled	Enabled APISIX Ingress Controller pods' Security Context	true
ingressController.podSecurityContext.fsGroupChangePolicy	Set filesystem group change policy	Always
ingressController.podSecurityContext.sysctls	Set kernel settings using the sysctl interface	[]
ingressController.podSecurityContext.supplementalGroups	Set filesystem extra groups	[]
ingressController.podSecurityContext.fsGroup	Set APISIX Ingress Controller pod's Security Context fsGroup	1001
ingressController.containerSecurityContext.enabled	Enabled APISIX Ingress Controller containers' Security Context	true
ingressController.containerSecurityContext.seLinuxOptions	Set SELinux options in container	{}
ingressController.containerSecurityContext.runAsUser	Set APISIX Ingress Controller containers' Security Context runAsUser	1001
ingressController.containerSecurityContext.runAsGroup	Set APISIX Ingress Controller containers' Security Context runAsGroup	1001
ingressController.containerSecurityContext.runAsNonRoot	Set APISIX Ingress Controller containers' Security Context runAsNonRoot	true
ingressController.containerSecurityContext.privileged	Set APISIX Ingress Controller containers' Security Context privileged	false
ingressController.containerSecurityContext.readOnlyRootFilesystem	Set APISIX Ingress Controller containers' Security Context runAsNonRoot	true
ingressController.containerSecurityContext.allowPrivilegeEscalation	Set APISIX Ingress Controller container's privilege escalation	false
ingressController.containerSecurityContext.capabilities.drop	Set APISIX Ingress Controller container's Security Context runAsNonRoot	["ALL"]
ingressController.containerSecurityContext.seccompProfile.type	Set APISIX Ingress Controller container's Security Context seccomp profile	RuntimeDefault
ingressController.command	Override default container command (useful when using custom images)	[]
ingressController.args	Override default container args (useful when using custom images)	[]
ingressController.automountServiceAccountToken	Mount Service Account token in pod	true
ingressController.hostAliases	APISIX Ingress Controller pods host aliases	[]
ingressController.podLabels	Extra labels for APISIX Ingress Controller pods	{}
ingressController.podAnnotations	Annotations for APISIX Ingress Controller pods	{}
ingressController.podAffinityPreset	Pod affinity preset. Ignored if injector.affinity is set. Allowed values: soft or hard	""
ingressController.podAntiAffinityPreset	Pod anti-affinity preset. Ignored if injector.affinity is set. Allowed values: soft or hard	soft
ingressController.pdb.create	Enable/disable a Pod Disruption Budget creation	true
ingressController.pdb.minAvailable	Minimum number/percentage of pods that should remain scheduled	""
ingressController.pdb.maxUnavailable	Maximum number/percentage of pods that may be made unavailable	""
ingressController.nodeAffinityPreset.type	Node affinity preset type. Ignored if injector.affinity is set. Allowed values: soft or hard	""
ingressController.nodeAffinityPreset.key	Node label key to match. Ignored if injector.affinity is set	""
ingressController.nodeAffinityPreset.values	Node label values to match. Ignored if injector.affinity is set	[]
ingressController.affinity	Affinity for APISIX Ingress Controller pods assignment	{}
ingressController.nodeSelector	Node labels for APISIX Ingress Controller pods assignment	{}
ingressController.tolerations	Tolerations for APISIX Ingress Controller pods assignment	[]
ingressController.updateStrategy.type	APISIX Ingress Controller statefulset strategy type	RollingUpdate
ingressController.priorityClassName	APISIX Ingress Controller pods' priorityClassName	""
ingressController.topologySpreadConstraints	Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template	[]
ingressController.schedulerName	Name of the k8s scheduler (other than default) for APISIX Ingress Controller pods	""
ingressController.terminationGracePeriodSeconds	Seconds Redmine pod needs to terminate gracefully	""
ingressController.lifecycleHooks	for the APISIX Ingress Controller container(s) to automate configuration before or after startup	{}
ingressController.extraEnvVars	Array with extra environment variables to add to APISIX Ingress Controller nodes	[]
ingressController.extraEnvVarsCM	Name of existing ConfigMap containing extra env vars for APISIX Ingress Controller nodes	""
ingressController.extraEnvVarsSecret	Name of existing Secret containing extra env vars for APISIX Ingress Controller nodes	""
ingressController.extraVolumes	Optionally specify extra list of additional volumes for the APISIX Ingress Controller pod(s)	[]
ingressController.extraVolumeMounts	Optionally specify extra list of additional volumeMounts for the APISIX Ingress Controller container(s)	[]
ingressController.sidecars	Add additional sidecar containers to the APISIX Ingress Controller pod(s)	[]
ingressController.initContainers	Add additional init containers to the APISIX Ingress Controller pod(s)	[]
ingressController.ingressClass.create	Specifies whether a IngressClass should be created	true
ingressController.ingressClass.name	IngressClass that will be be used to implement the APISIX Ingress Controller Ingress	apisix
ingressController.ingressClass.annotations	Additional annotations for the APISIX Ingress Controller IngressClass	{}
ingressController.defaultConfig	APISIX Ingress Controller configuration (evaluated as a template)	""
ingressController.extraConfig	Extra configuration parameters for APISIX Ingress Controller	{}
ingressController.existingConfigMap	name of a ConfigMap with existing configuration for the APISIX Ingress Controller	""
ingressController.extraConfigExistingConfigMap	name of a ConfigMap with existing configuration for the APISIX Ingress Controller	""
ingressController.tls.enabled	Enable TLS transport in APISIX Ingress Controller	true
ingressController.tls.autoGenerated	Auto-generate self-signed certificates	true
ingressController.tls.existingSecret	Name of a secret containing the certificates	""
ingressController.tls.certFilename	Path of the certificate file when mounted as a secret	tls.crt
ingressController.tls.certKeyFilename	Path of the certificate key file when mounted as a secret	tls.key
ingressController.tls.certCAFilename	Path of the certificate CA file when mounted as a secret	ca.crt
ingressController.tls.cert	Content of the certificate to be added to the secret	""
ingressController.tls.key	Content of the certificate key to be added to the secret	""
ingressController.tls.ca	Content of the certificate CA to be added to the secret	""

APISIX Ingress Controller Traffic Exposure Parameters

Name	Description	Value
ingressController.service.type	APISIX Ingress Controller service type	ClusterIP
ingressController.service.ports.http	APISIX Ingress Controller service HTTP port	80
ingressController.service.ports.https	APISIX Ingress Controller service HTTPS port	443
ingressController.service.nodePorts.http	Node port for HTTP	""
ingressController.service.nodePorts.https	Node port for HTTPS	""
ingressController.service.clusterIP	APISIX Ingress Controller service Cluster IP	""
ingressController.service.loadBalancerIP	APISIX Ingress Controller service Load Balancer IP	""
ingressController.service.loadBalancerSourceRanges	APISIX Ingress Controller service Load Balancer sources	[]
ingressController.service.externalIPs	APISIX Ingress Controller service External IPs	[]
ingressController.service.externalTrafficPolicy	APISIX Ingress Controller service external traffic policy	Cluster
ingressController.service.annotations	Additional custom annotations for APISIX Ingress Controller service	{}
ingressController.service.extraPorts	Extra ports to expose in APISIX Ingress Controller service (normally used with the sidecars value)	[]
ingressController.service.sessionAffinity	Control where web requests go, to the same pod or round-robin	None
ingressController.service.sessionAffinityConfig	Additional settings for the sessionAffinity	{}
ingressController.networkPolicy.enabled	Specifies whether a NetworkPolicy should be created	true
ingressController.networkPolicy.allowExternal	Don't require server label for connections	true
ingressController.networkPolicy.allowExternalEgress	Allow the pod to access any range of port and all destinations.	true
ingressController.networkPolicy.kubeAPIServerPorts	List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)	[]
ingressController.networkPolicy.extraIngress	Add extra ingress rules to the NetworkPolicy	[]
ingressController.networkPolicy.extraEgress	Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)	[]
ingressController.networkPolicy.ingressNSMatchLabels	Labels to match to allow traffic from other namespaces	{}
ingressController.networkPolicy.ingressNSPodMatchLabels	Pod labels to match to allow traffic from other namespaces	{}
ingressController.ingress.enabled	Enable ingress record generation for APISIX Ingress Controller	false
ingressController.ingress.pathType	Ingress path type	ImplementationSpecific
ingressController.ingress.apiVersion	Force Ingress API version (automatically detected if not set)	""
ingressController.ingress.hostname	Default host for the ingress record	apisix-ingress-controller.local
ingressController.ingress.ingressClassName	IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)	""
ingressController.ingress.path	Default path for the ingress record	/
ingressController.ingress.annotations	Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.	{}
ingressController.ingress.tls	Enable TLS configuration for the host defined at ingressController.ingress.hostname parameter	false
ingressController.ingress.selfSigned	Create a TLS secret for this ingress record using self-signed certificates generated by Helm	false
ingressController.ingress.extraHosts	An array with additional hostname(s) to be covered with the ingress record	[]
ingressController.ingress.extraPaths	An array with additional arbitrary paths that may need to be added to the ingress under the main host	[]
ingressController.ingress.extraTls	TLS configuration for additional hostname(s) to be covered with this ingress record	[]
ingressController.ingress.secrets	Custom TLS certificates as secrets	[]
ingressController.ingress.extraRules	Additional rules to be covered with this ingress record	[]

APISIX Ingress Controller Autoscaling configuration

Name	Description	Value
ingressController.autoscaling.vpa.enabled	Enable VPA	false
ingressController.autoscaling.vpa.annotations	Annotations for VPA resource	{}
ingressController.autoscaling.vpa.controlledResources	VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory	[]
ingressController.autoscaling.vpa.maxAllowed	VPA Max allowed resources for the pod	{}
ingressController.autoscaling.vpa.minAllowed	VPA Min allowed resources for the pod	{}
ingressController.autoscaling.vpa.updatePolicy.updateMode	Autoscaling update policy Specifies whether recommended updates are applied when a Pod is started and whether recommended updates are applied during the life of a Pod	Auto
ingressController.autoscaling.hpa.enabled	Enable HPA for APISIX Ingress Controller	false
ingressController.autoscaling.hpa.minReplicas	Minimum number of APISIX Ingress Controller replicas	""
ingressController.autoscaling.hpa.maxReplicas	Maximum number of APISIX Ingress Controller replicas	""
ingressController.autoscaling.hpa.targetCPU	Target CPU utilization percentage	""
ingressController.autoscaling.hpa.targetMemory	Target Memory utilization percentage	""

APISIX Ingress Controller RBAC Parameters

Name	Description	Value
ingressController.rbac.create	Specifies whether RBAC resources should be created	true
ingressController.rbac.rules	Custom RBAC rules to set	[]
ingressController.serviceAccount.create	Specifies whether a ServiceAccount should be created	true
ingressController.serviceAccount.name	The name of the ServiceAccount to use.	""
ingressController.serviceAccount.annotations	Additional Service Account annotations (evaluated as a template)	{}
ingressController.serviceAccount.automountServiceAccountToken	Automount service account token for the server service account	false
ingressController.metrics.enabled	Enable the export of Prometheus metrics	false
ingressController.metrics.annotations	Annotations for the APISIX Ingress Controller service in order to scrape metrics	{}
ingressController.metrics.serviceMonitor.enabled	if true, creates a Prometheus Operator ServiceMonitor (also requires metrics.enabled to be true)	false
ingressController.metrics.serviceMonitor.namespace	Namespace in which Prometheus is running	""
ingressController.metrics.serviceMonitor.annotations	Additional custom annotations for the ServiceMonitor	{}
ingressController.metrics.serviceMonitor.labels	Extra labels for the ServiceMonitor	{}
ingressController.metrics.serviceMonitor.jobLabel	The name of the label on the target service to use as the job name in Prometheus	""
ingressController.metrics.serviceMonitor.honorLabels	honorLabels chooses the metric's labels on collisions with target labels	false
ingressController.metrics.serviceMonitor.interval	Interval at which metrics should be scraped.	""
ingressController.metrics.serviceMonitor.scrapeTimeout	Timeout after which the scrape is ended	""
ingressController.metrics.serviceMonitor.metricRelabelings	Specify additional relabeling of metrics	[]
ingressController.metrics.serviceMonitor.relabelings	Specify general relabeling	[]
ingressController.metrics.serviceMonitor.selector	Prometheus instance selector labels	{}

Init containers parameters

Name	Description	Value
waitContainer.image.registry	Init container wait-container image registry	REGISTRY_NAME
waitContainer.image.repository	Init container wait-container image name	REPOSITORY_NAME/os-shell
waitContainer.image.digest	Init container wait-container image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag	""
waitContainer.image.pullPolicy	Init container wait-container image pull policy	IfNotPresent
waitContainer.image.pullSecrets	Specify docker-registry secret names as an array	[]
waitContainer.containerSecurityContext.enabled	Enabled APISIX Ingress Controller containers' Security Context	true
waitContainer.containerSecurityContext.seLinuxOptions	Set SELinux options in container	{}
waitContainer.containerSecurityContext.runAsUser	Set APISIX Ingress Controller containers' Security Context runAsUser	1001
waitContainer.containerSecurityContext.runAsGroup	Set APISIX Ingress Controller containers' Security Context runAsGroup	1001
waitContainer.containerSecurityContext.runAsNonRoot	Set APISIX Ingress Controller containers' Security Context runAsNonRoot	true
waitContainer.containerSecurityContext.privileged	Set APISIX Ingress Controller containers' Security Context privileged	false
waitContainer.containerSecurityContext.readOnlyRootFilesystem	Set APISIX Ingress Controller containers' Security Context readOnlyRootFilesystem	true
waitContainer.containerSecurityContext.allowPrivilegeEscalation	Set APISIX Ingress Controller containers' Security Context allowPrivilegeEscalation	false
waitContainer.containerSecurityContext.capabilities.drop	Set APISIX Ingress Controller containers' Security Context capabilities.drop	["ALL"]
waitContainer.containerSecurityContext.seccompProfile.type	Set APISIX Ingress Controller containers' Security Context seccompProfile.type	RuntimeDefault

External etcd settings

Name	Description	Value
externalEtcd.servers	List of hostnames of the external etcd	[]
externalEtcd.port	Port of the external etcd instance	2379
externalEtcd.user	User of the external etcd instance	root
externalEtcd.password	Password of the external etcd instance	""
externalEtcd.existingSecret	Name of a secret containing the external etcd password	""
externalEtcd.existingSecretPasswordKey	Key inside the secret containing the external etcd password	etcd-root-password
externalEtcd.secureTransport	Use TLS for client-to-server communications	false

etcd sub-chart parameters

Name	Description	Value
etcd.enabled	Deploy etcd sub-chart	true
etcd.replicaCount	Number of etcd replicas	3
etcd.containerPorts.client	Container port for etcd	2379
etcd.auth.rbac.create	Switch to enable RBAC authentication	false
etcd.auth.rbac.rootPassword	etcd root password	""
etcd.auth.client.secureTransport	use TLS for client-to-server communications	false
etcd.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).	micro
etcd.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}

The above parameters map to the env variables defined in bitnami/apisix. For more information please refer to the bitnami/apisix image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install my-release \
  --set controlPlane.enabled=true \
    my-repo/apisix

The above command enables the APISIX Control Plane deployment.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install my-release -f values.yaml my-repo/apisix

Tip

: You can use the default values.yaml

Troubleshooting

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading

To 6.0.0

This major release removes the bitnami/apisix-dashboard container and its deployment templates from the chart. Starting APISIX version 3.13.0, the dashboard component has been integrated into the bitnami/apisix container.

APISIX Dashboards no longer have a dedicated service, it will be exposed under the APISIX Control Plane adminAPI service port, under the /ui route.

All dashboard.* values have been removed. New value controlPlane.dashboardEnabled has been added.

To 5.0.0

This major updates the etcd subchart to it newest major, 12.0.0. For more information on this subchart's major, please refer to etcd upgrade notes.

To 4.0.0

This major updates the etcd subchart to it newest major, 11.0.0. For more information on this subchart's major, please refer to etcd upgrade notes.

To 3.7.0

This version introduces image verification for security purposes. To disable it, set global.security.allowInsecureImages to true. More details at GitHub issue.

To 3.0.0

This major bump changes the following security defaults:

• resourcesPreset is changed from none to the minimum size working in our test suites (NOTE: resourcesPreset is not meant for production usage, but resources adapted to your use case).
• global.compatibility.openshift.adaptSecurityContext is changed from disabled to auto.

This could potentially break any customization or init scripts used in your deployment. If this is the case, change the default values to the previous ones.

To 2.0.0

This major updates the etcd subchart to it newest major, 9.0.0. For more information on this subchart's major, please refer to etcd upgrade notes.

License

Copyright © 2025 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.