1# This file has been modified by Chainguard, Inc.
3# Copyright Chainguard, Inc. All Rights Reserved.
4# Chainguard, Inc. modifications are subject to the license
5# available at: https://www.chainguard.dev/legal/software-license-agreement
7# Copyright Broadcom, Inc. All Rights Reserved.
8# SPDX-License-Identifier: APACHE-2.0
10## @section Global parameters
11## Global Docker image parameters
12## Please, note that this will override the image parameters, including dependencies, configured to use the global value
13## Current available global Docker image parameters: imageRegistry, imagePullSecrets and storageClass
16## @param global.imageRegistry Global Docker image registry
17## @param global.useImageTags Pull every image by tag and ignore all image digests, including digests set in values. Use this when your registry mirror does not have the chart's default image digests.
18## @param global.imagePullSecrets Global Docker registry secret names as an array
19## @param global.defaultStorageClass Global default StorageClass for Persistent Volume(s)
26 ## - myRegistryKeySecretName
29 defaultStorageClass: ""
30 ## Security parameters
33 ## @param global.security.allowInsecureImages Allows skipping image verification
34 allowInsecureImages: false
35 ## Compatibility adaptations for Kubernetes platforms
38 ## Compatibility adaptations for Openshift
41 ## @param 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)
43 adaptSecurityContext: auto
45## @section Common parameters
48## @param kubeVersion Override Kubernetes version
51## @param apiVersions Override Kubernetes API versions reported by .Capabilities
54## @param nameOverride String to partially override common.names.name
57## @param fullnameOverride String to fully override common.names.fullname
60## @param namespaceOverride String to fully override common.names.namespace
63## @param commonLabels Labels to add to all deployed objects
66## @param commonAnnotations Annotations to add to all deployed objects
69## @param clusterDomain Kubernetes cluster domain name
71clusterDomain: cluster.local
72## @param extraDeploy Array of extra objects to deploy with the release
75## @param usePasswordFiles Mount credentials as files instead of using environment variables
78## Enable diagnostic mode in the deployment
81 ## @param diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden)
84 ## @param diagnosticMode.command Command to override all containers in the deployment
88 ## @param diagnosticMode.args Args to override all containers in the deployment
92## Iamguarded APISIX image
93## @param image.registry [default: REGISTRY_NAME] APISIX image registry
94## @param image.repository [default: REPOSITORY_NAME/apisix] APISIX image repository
95## @skip image.tag APISIX image tag (immutable tags are recommended)
96## @param 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)
97## @param image.pullPolicy APISIX image pull policy
98## @param image.pullSecrets APISIX image pull secrets
99## @param image.debug Enable APISIX image debug mode
103 repository: chainguard-private/apache-apisix-iamguarded
106 ## Specify a imagePullPolicy
107 ## ref: http://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
109 pullPolicy: IfNotPresent
110 ## Optionally specify an array of imagePullSecrets.
111 ## Secrets must be manually created in the namespace.
112 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
115 ## - myRegistryKeySecretName
121## @section APISIX Data Plane parameters
124 ## @param dataPlane.enabled Enable APISIX Data Plane
127 ## @param dataPlane.useDaemonSet Deploy Data Plane as DaemonSet
130 ## @param dataPlane.replicaCount Number of APISIX Data Plane replicas to deploy
133 ## @param dataPlane.hostNetwork Use hostNetwork in APISIX Data Plane
136 ## @param dataPlane.dnsPolicy DNS policy for APISIX Data Plane pods
137 ## ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-policies
138 ## NOTE: If you set hostNetwork=true, you must set dnsPolicy=ClusterFirstWithHostNet
140 dnsPolicy: ClusterFirst
141 ## @param dataPlane.containerPorts.http APISIX Data Plane HTTP container port
142 ## @param dataPlane.containerPorts.https APISIX Data Plane HTTPS container port
143 ## @param dataPlane.containerPorts.control APISIX Data Plane control container port
144 ## @param dataPlane.containerPorts.metrics APISIX Data Plane metrics container port
151 ## Configure extra options for APISIX Data Plane containers' liveness and readiness probes
152 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes
153 ## @param dataPlane.livenessProbe.enabled Enable livenessProbe on APISIX Data Plane containers
154 ## @param dataPlane.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
155 ## @param dataPlane.livenessProbe.periodSeconds Period seconds for livenessProbe
156 ## @param dataPlane.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
157 ## @param dataPlane.livenessProbe.failureThreshold Failure threshold for livenessProbe
158 ## @param dataPlane.livenessProbe.successThreshold Success threshold for livenessProbe
162 initialDelaySeconds: 5
167 ## @param dataPlane.readinessProbe.enabled Enable readinessProbe on APISIX Data Plane containers
168 ## @param dataPlane.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
169 ## @param dataPlane.readinessProbe.periodSeconds Period seconds for readinessProbe
170 ## @param dataPlane.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
171 ## @param dataPlane.readinessProbe.failureThreshold Failure threshold for readinessProbe
172 ## @param dataPlane.readinessProbe.successThreshold Success threshold for readinessProbe
176 initialDelaySeconds: 5
181 ## @param dataPlane.startupProbe.enabled Enable startupProbe on APISIX Data Plane containers
182 ## @param dataPlane.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe
183 ## @param dataPlane.startupProbe.periodSeconds Period seconds for startupProbe
184 ## @param dataPlane.startupProbe.timeoutSeconds Timeout seconds for startupProbe
185 ## @param dataPlane.startupProbe.failureThreshold Failure threshold for startupProbe
186 ## @param dataPlane.startupProbe.successThreshold Success threshold for startupProbe
190 initialDelaySeconds: 5
195 ## @param dataPlane.customLivenessProbe Custom livenessProbe that overrides the default one
197 customLivenessProbe: {}
198 ## @param dataPlane.customReadinessProbe Custom readinessProbe that overrides the default one
200 customReadinessProbe: {}
201 ## @param dataPlane.customStartupProbe Custom startupProbe that overrides the default one
203 customStartupProbe: {}
204 ## APISIX Data Plane resource requests and limits
205 ## ref: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
206 ## @param 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).
208 resourcesPreset: "nano"
209 ## @param dataPlane.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
220 ## Configure Pods Security Context
221 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
222 ## @param dataPlane.podSecurityContext.enabled Enabled APISIX Data Plane pods' Security Context
223 ## @param dataPlane.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy
224 ## @param dataPlane.podSecurityContext.sysctls Set kernel settings using the sysctl interface
225 ## @param dataPlane.podSecurityContext.supplementalGroups Set filesystem extra groups
226 ## @param dataPlane.podSecurityContext.fsGroup Set APISIX Data Plane pod's Security Context fsGroup
230 fsGroupChangePolicy: Always
232 supplementalGroups: []
234 ## Configure Container Security Context
235 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
236 ## @param dataPlane.containerSecurityContext.enabled Enabled APISIX Data Plane containers' Security Context
237 ## @param dataPlane.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
238 ## @param dataPlane.containerSecurityContext.runAsUser Set APISIX Data Plane containers' Security Context runAsUser
239 ## @param dataPlane.containerSecurityContext.runAsGroup Set APISIX Data Plane containers' Security Context runAsGroup
240 ## @param dataPlane.containerSecurityContext.runAsNonRoot Set APISIX Data Plane containers' Security Context runAsNonRoot
241 ## @param dataPlane.containerSecurityContext.privileged Set APISIX Data Plane containers' Security Context privileged
242 ## @param dataPlane.containerSecurityContext.readOnlyRootFilesystem Set APISIX Data Plane containers' Security Context runAsNonRoot
243 ## @param dataPlane.containerSecurityContext.allowPrivilegeEscalation Set APISIX Data Plane container's privilege escalation
244 ## @param dataPlane.containerSecurityContext.capabilities.drop Set APISIX Data Plane container's Security Context runAsNonRoot
245 ## @param dataPlane.containerSecurityContext.seccompProfile.type Set APISIX Data Plane container's Security Context seccomp profile
247 containerSecurityContext:
254 readOnlyRootFilesystem: true
255 allowPrivilegeEscalation: false
260 ## @param dataPlane.command Override default container command (useful when using custom images)
263 ## @param dataPlane.args Override default container args (useful when using custom images)
266 ## @param dataPlane.automountServiceAccountToken Mount Service Account token in pod
268 automountServiceAccountToken: true
269 ## @param dataPlane.hostAliases APISIX Data Plane pods host aliases
270 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
273 ## @param dataPlane.defaultConfig [string] APISIX Data Plane configuration (evaluated as a template)
276 {{- if .Values.dataPlane.metrics.enabled }}
279 export_uri: /apisix/prometheus/metrics
280 metric_prefix: apisix_
281 enable_export_server: true
284 port: {{ .Values.dataPlane.containerPorts.metrics }}
287 node_listen: {{ .Values.dataPlane.containerPorts.http }}
289 {{- if .Values.dataPlane.tls.enabled }}
293 - port: {{ .Values.dataPlane.containerPorts.https }}
294 ssl_trusted_certificate: /iamguarded/certs/{{ .Values.dataPlane.tls.certCAFilename }}
299 port: {{ .Values.dataPlane.containerPorts.control }}
301 error_log: /dev/stderr
303 access_log: /dev/stdout
305 access_log: /dev/stdout
306 http_configuration_snippet: |
311 config_provider: etcd
312 {{- if .Values.controlPlane.enabled }}
315 - {{ ternary "https" "http" .Values.controlPlane.tls.enabled }}://{{ include "apisix.control-plane.fullname" . }}:{{ .Values.controlPlane.service.ports.configServer }}
319 {{- if or .Values.etcd.enabled .Values.externalEtcd.servers }}
322 {{- if .Values.etcd.enabled }}
323 {{- $replicas := $.Values.etcd.replicaCount | int }}
324 {{- range $i, $_e := until $replicas }}
325 - {{ printf "%s://%s-%d.%s:%v" (ternary "https" "http" $.Values.etcd.auth.client.secureTransport) (include "apisix.etcd.fullname" $ ) $i (include "apisix.etcd.headlessServiceName" $) ( include "apisix.etcd.port" $ ) }}
328 {{- range $node := .Values.externalEtcd.servers }}
329 - {{ ternary "https" "http" $.Values.externalEtcd.secureTransport }}://{{ printf "%s:%v" $node (include "apisix.etcd.port" $) }}
336 {{- if (include "apisix.etcd.authEnabled" .) }}
337 user: "{{ print "{{APISIX_ETCD_USER}}" }}"
338 password: "{{ print "{{APISIX_ETCD_PASSWORD}}" }}"
341 {{- if .Values.dataPlane.tls.enabled }}
343 {{- if .Values.dataPlane.tls.enabled }}
344 cert: /iamguarded/certs/{{ .Values.dataPlane.tls.certFilename }}
345 cert_key: /iamguarded/certs/{{ .Values.dataPlane.tls.certKeyFilename }}
346 {{- if .Values.dataPlane.tls.certCAFilename }}
347 client_ca_cert: /iamguarded/certs/{{ .Values.dataPlane.tls.certCAFilename }}
354 # apiserver schema, options [http, https]
355 schema: https #default https
357 # apiserver host, options [ipv4, ipv6, domain, environment variable]
358 host: ${KUBERNETES_SERVICE_HOST} #default ${KUBERNETES_SERVICE_HOST}
360 # apiserver port, options [port number, environment variable]
361 port: ${KUBERNETES_SERVICE_PORT} #default ${KUBERNETES_SERVICE_PORT}
364 # serviceaccount token or token_file
365 token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
367 default_weight: 50 # weight assigned to each discovered endpoint. default 50, minimum 0
368 ## @param dataPlane.extraConfig [object] extra configuration parameters to add to the config.yaml file in APISIX Data Plane
371 ## @param dataPlane.existingConfigMap name of a ConfigMap with existing configuration for APISIX Data Plane
373 existingConfigMap: ""
374 ## @param dataPlane.extraConfigExistingConfigMap name of a ConfigMap with existing configuration for APISIX Data Plane
376 extraConfigExistingConfigMap: ""
378 ## @param dataPlane.tls.enabled Enable TLS transport in APISIX Data Plane
381 ## @param dataPlane.tls.autoGenerated Auto-generate self-signed certificates
384 ## @param dataPlane.tls.existingSecret Name of a secret containing the certificates
387 ## @param dataPlane.tls.certFilename Path of the certificate file when mounted as a secret
389 certFilename: tls.crt
390 ## @param dataPlane.tls.certKeyFilename Path of the certificate key file when mounted as a secret
392 certKeyFilename: tls.key
393 ## @param dataPlane.tls.certCAFilename Path of the certificate CA file when mounted as a secret
395 certCAFilename: ca.crt
396 ## @param dataPlane.tls.cert Content of the certificate to be added to the secret
399 ## @param dataPlane.tls.key Content of the certificate key to be added to the secret
402 ## @param dataPlane.tls.ca Content of the certificate CA to be added to the secret
405 ## @param dataPlane.podLabels Extra labels for APISIX Data Plane pods
406 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
409 ## @param dataPlane.podAnnotations Annotations for APISIX Data Plane pods
410 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
413 ## @param dataPlane.podAffinityPreset Pod affinity preset. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
414 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
416 podAffinityPreset: ""
417 ## @param dataPlane.podAntiAffinityPreset Pod anti-affinity preset. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
418 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
420 podAntiAffinityPreset: soft
421 ## Pod Disruption Budget configuration
422 ## ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb
423 ## @param dataPlane.pdb.create Enable/disable a Pod Disruption Budget creation
424 ## @param dataPlane.pdb.minAvailable Minimum number/percentage of pods that should remain scheduled
425 ## @param dataPlane.pdb.maxUnavailable Maximum number/percentage of pods that may be made unavailable
431 ## Node apisix.affinity preset
432 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
435 ## @param dataPlane.nodeAffinityPreset.type Node affinity preset type. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
438 ## @param dataPlane.nodeAffinityPreset.key Node label key to match. Ignored if `apisix.affinity` is set
441 ## @param dataPlane.nodeAffinityPreset.values Node label values to match. Ignored if `apisix.affinity` is set
448 ## @param dataPlane.affinity Affinity for APISIX Data Plane pods assignment
449 ## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
450 ## NOTE: `apisix.podAffinityPreset`, `apisix.podAntiAffinityPreset`, and `apisix.nodeAffinityPreset` will be ignored when it's set
453 ## @param dataPlane.nodeSelector Node labels for APISIX Data Plane pods assignment
454 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
457 ## @param dataPlane.tolerations Tolerations for APISIX Data Plane pods assignment
458 ## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
461 ## @param dataPlane.updateStrategy.type APISIX Data Plane statefulset strategy type
462 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
466 ## Can be set to RollingUpdate or OnDelete
469 ## @param dataPlane.priorityClassName APISIX Data Plane pods' priorityClassName
471 priorityClassName: ""
472 ## @param dataPlane.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template
473 ## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/#spread-constraints-for-pods
475 topologySpreadConstraints: []
476 ## @param dataPlane.schedulerName Name of the k8s scheduler (other than default) for APISIX Data Plane pods
477 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
480 ## @param dataPlane.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully
481 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
483 terminationGracePeriodSeconds: ""
484 ## @param dataPlane.lifecycleHooks for the APISIX Data Plane container(s) to automate configuration before or after startup
487 ## @param dataPlane.extraEnvVars Array with extra environment variables to add to APISIX Data Plane nodes
494 ## @param dataPlane.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for APISIX Data Plane nodes
497 ## @param dataPlane.extraEnvVarsSecret Name of existing Secret containing extra env vars for APISIX Data Plane nodes
499 extraEnvVarsSecret: ""
500 ## @param dataPlane.extraVolumes Optionally specify extra list of additional volumes for the APISIX Data Plane pod(s)
503 ## @param dataPlane.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the APISIX Data Plane container(s)
505 extraVolumeMounts: []
506 ## @param dataPlane.sidecars Add additional sidecar containers to the APISIX Data Plane pod(s)
509 ## - name: your-image-name
511 ## imagePullPolicy: Always
514 ## containerPort: 1234
517 ## @param dataPlane.initContainers Add additional init containers to the APISIX Data Plane pod(s)
518 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
521 ## - name: your-image-name
523 ## imagePullPolicy: Always
524 ## command: ['sh', '-c', 'echo "hello world"']
527 ## @section APISIX Data Plane Traffic Exposure Parameters
530 ## @param dataPlane.service.type APISIX Data Plane service type
533 ## @param dataPlane.service.ports.http APISIX Data Plane service HTTP port
534 ## @param dataPlane.service.ports.https APISIX Data Plane service HTTPS port
535 ## @param dataPlane.service.ports.metrics APISIX Data Plane service HTTPS port
541 ## Node ports to expose
542 ## @param dataPlane.service.nodePorts.http Node port for HTTP
543 ## @param dataPlane.service.nodePorts.https Node port for HTTPS
544 ## @param dataPlane.service.nodePorts.metrics Node port for metrics
545 ## NOTE: choose port between <30000-32767>
551 ## @param dataPlane.service.clusterIP APISIX Data Plane service Cluster IP
556 ## @param dataPlane.service.loadBalancerIP APISIX Data Plane service Load Balancer IP
557 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
560 ## @param dataPlane.service.loadBalancerSourceRanges APISIX Data Plane service Load Balancer sources
561 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
563 ## loadBalancerSourceRanges:
566 loadBalancerSourceRanges: []
567 ## @param dataPlane.service.externalIPs APISIX Data Plane service External IPs
568 ## https://kubernetes.io/docs/concepts/services-networking/service/#external-ips
575 ## @param dataPlane.service.externalTrafficPolicy APISIX Data Plane service external traffic policy
576 ## ref http://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-web-source-ip
578 externalTrafficPolicy: Cluster
579 ## @param dataPlane.service.annotations Additional custom annotations for APISIX Data Plane service
582 ## @param dataPlane.service.extraPorts Extra ports to expose in APISIX Data Plane service (normally used with the `sidecars` value)
585 ## @param dataPlane.service.sessionAffinity Control where web requests go, to the same pod or round-robin
586 ## Values: WebIP or None
587 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/
589 sessionAffinity: None
590 ## @param dataPlane.service.sessionAffinityConfig Additional settings for the sessionAffinity
591 ## sessionAffinityConfig:
593 ## timeoutSeconds: 300
595 sessionAffinityConfig: {}
597 ## Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
600 ## @param dataPlane.networkPolicy.enabled Specifies whether a NetworkPolicy should be created
603 ## @param dataPlane.networkPolicy.allowExternal Don't require server label for connections
604 ## The Policy model to apply. When set to false, only pods with the correct
605 ## server label will have network access to the ports server is listening
606 ## on. When true, server will accept connections from any source
607 ## (with the correct destination port).
610 ## @param dataPlane.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
612 allowExternalEgress: true
613 ## @param dataPlane.networkPolicy.kubeAPIServerPorts [array] List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)
615 kubeAPIServerPorts: [443, 6443, 8443]
616 ## @param dataPlane.networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
626 ## - matchExpressions:
632 ## @param dataPlane.networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)
642 ## - matchExpressions:
649 ## @param dataPlane.networkPolicy.ingressNSMatchLabels [object] Labels to match to allow traffic from other namespaces
650 ## @param dataPlane.networkPolicy.ingressNSPodMatchLabels [object] Pod labels to match to allow traffic from other namespaces
652 ingressNSMatchLabels: {}
653 ingressNSPodMatchLabels: {}
654 ## ref: http://kubernetes.io/docs/concepts/services-networking/ingress/
657 ## @param dataPlane.ingress.enabled Enable ingress record generation for APISIX Data Plane
660 ## @param dataPlane.ingress.pathType Ingress path type
662 pathType: ImplementationSpecific
663 ## @param dataPlane.ingress.apiVersion Force Ingress API version (automatically detected if not set)
666 ## @param dataPlane.ingress.hostname Default host for the ingress record
668 hostname: apisix-data-plane.local
669 ## @param dataPlane.ingress.ingressClassName IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)
670 ## This is supported in Kubernetes 1.18+ and required if you have more than one IngressClass marked as the default for your cluster .
671 ## ref: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/
674 ## @param dataPlane.ingress.path Default path for the ingress record
675 ## NOTE: You may need to set this to '/*' in order to use this with ALB ingress controllers
678 ## @param dataPlane.ingress.annotations Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.
679 ## Use this parameter to set the required annotations for cert-manager, see
680 ## ref: https://cert-manager.io/docs/usage/ingress/#supported-annotations
683 ## kubernetes.io/ingress.class: nginx
684 ## cert-manager.io/cluster-issuer: cluster-issuer-name
687 ## @param dataPlane.ingress.tls Enable TLS configuration for the host defined at `dataPlane.ingress.hostname` parameter
688 ## TLS certificates will be retrieved from a TLS secret with name: `{{- printf "%s-tls" .Values.ingress.hostname }}`
690 ## - Use the `dataPlane.ingress.secrets` parameter to create this TLS secret
691 ## - Rely on cert-manager to create it by setting the corresponding annotations
692 ## - Rely on Helm to create self-signed certificates by setting `dataPlane.ingress.selfSigned=true`
695 ## @param dataPlane.ingress.selfSigned Create a TLS secret for this ingress record using self-signed certificates generated by Helm
698 ## @param dataPlane.ingress.extraHosts An array with additional hostname(s) to be covered with the ingress record
701 ## - name: apisix.local
705 ## @param dataPlane.ingress.extraPaths An array with additional arbitrary paths that may need to be added to the ingress under the main host
710 ## serviceName: ssl-redirect
711 ## servicePort: use-annotation
714 ## @param dataPlane.ingress.extraTls TLS configuration for additional hostname(s) to be covered with this ingress record
715 ## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/#tls
720 ## secretName: apisix.local-tls
723 ## @param dataPlane.ingress.secrets Custom TLS certificates as secrets
724 ## NOTE: 'key' and 'certificate' are expected in PEM format
725 ## NOTE: 'name' should line up with a 'secretName' set further up
726 ## If it is not set and you're using cert-manager, this is unneeded, as it will create a secret for you with valid certificates
727 ## If it is not set and you're NOT using cert-manager either, self-signed certificates will be created valid for 365 days
728 ## It is also possible to create and manage the certificates outside of this helm chart
729 ## Please see README.md for more information
732 ## - name: apisix.local-tls
734 ## -----BEGIN RSA PRIVATE KEY-----
736 ## -----END RSA PRIVATE KEY-----
738 ## -----BEGIN CERTIFICATE-----
740 ## -----END CERTIFICATE-----
743 ## @param dataPlane.ingress.extraRules Additional rules to be covered with this ingress record
744 ## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-rules
747 ## - host: example.local
757 ## @section APISIX Data Plane Autoscaling configuration
758 ## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
762 ## @param dataPlane.autoscaling.vpa.enabled Enable VPA
765 ## @param dataPlane.autoscaling.vpa.annotations Annotations for VPA resource
768 ## @param dataPlane.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
770 controlledResources: []
771 ## @param dataPlane.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
775 ## @param dataPlane.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
780 ## @param 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
781 ## Possible values are "Off", "Initial", "Recreate", and "Auto".
785 ## @param dataPlane.autoscaling.hpa.enabled Enable HPA for APISIX Data Plane
788 ## @param dataPlane.autoscaling.hpa.minReplicas Minimum number of APISIX Data Plane replicas
791 ## @param dataPlane.autoscaling.hpa.maxReplicas Maximum number of APISIX Data Plane replicas
794 ## @param dataPlane.autoscaling.hpa.targetCPU Target CPU utilization percentage
797 ## @param dataPlane.autoscaling.hpa.targetMemory Target Memory utilization percentage
800 ## @section APISIX Data Plane RBAC Parameters
803 ## RBAC configuration
806 ## @param dataPlane.rbac.create Specifies whether RBAC resources should be created
809 ## @param dataPlane.rbac.rules Custom RBAC rules to set
821 ## ServiceAccount configuration
824 ## @param dataPlane.serviceAccount.create Specifies whether a ServiceAccount should be created
827 ## @param dataPlane.serviceAccount.name The name of the ServiceAccount to use.
828 ## If not set and create is true, a name is generated using the common.names.fullname template
831 ## @param dataPlane.serviceAccount.annotations Additional Service Account annotations (evaluated as a template)
834 ## @param dataPlane.serviceAccount.automountServiceAccountToken Automount service account token for the APISIX Data Plane service account
836 automountServiceAccountToken: false
837 ## @section APISIX Data Plane Metrics Parameters
840 ## Prometheus metrics
843 ## @param dataPlane.metrics.enabled Enable the export of Prometheus metrics
846 ## @param dataPlane.metrics.annotations [object] Annotations for the APISIX Data Plane service in order to scrape metrics
848 prometheus.io/scrape: "true"
849 prometheus.io/port: "{{ .Values.dataPlane.service.ports.metrics }}"
850 prometheus.io/path: "/apisix/prometheus/metrics"
851 ## Prometheus Operator ServiceMonitor configuration
854 ## @param dataPlane.metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
857 ## @param dataPlane.metrics.serviceMonitor.namespace Namespace in which Prometheus is running
860 ## @param dataPlane.metrics.serviceMonitor.annotations Additional custom annotations for the ServiceMonitor
863 ## @param dataPlane.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor
866 ## @param dataPlane.metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in Prometheus
869 ## @param dataPlane.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels
872 ## @param dataPlane.metrics.serviceMonitor.interval Interval at which metrics should be scraped.
873 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
878 ## @param dataPlane.metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended
879 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
881 ## scrapeTimeout: 10s
884 ## @param dataPlane.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics
886 metricRelabelings: []
887 ## @param dataPlane.metrics.serviceMonitor.relabelings Specify general relabeling
890 ## @param dataPlane.metrics.serviceMonitor.selector Prometheus instance selector labels
892 ## prometheus: my-prometheus
895## @section APISIX Control Plane Parameters
898 ## @param controlPlane.enabled Enable APISIX Control Plane
901 ## @param controlPlane.replicaCount Number of APISIX Control Plane replicas to deploy
904 ## @param controlPlane.hostNetwork Use hostNetwork
907 ## @param controlPlane.dnsPolicy DNS policy for APISIX Control Plane pods
908 ## ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-policies
909 ## NOTE: If you set hostNetwork=true, you must set dnsPolicy=ClusterFirstWithHostNet
911 dnsPolicy: ClusterFirst
912 ## @param controlPlane.useDaemonSet Deploy as DaemonSet
915 ## @param controlPlane.dashboardEnabled Enable APISIX Control Plane to expose APISIX Dashboards
917 dashboardEnabled: true
918 ## @param controlPlane.containerPorts.adminAPI APISIX Control Plane Admin API port
919 ## @param controlPlane.containerPorts.configServer APISIX Control Plane config port
920 ## @param controlPlane.containerPorts.control APISIX Control Plane control port
921 ## @param controlPlane.containerPorts.metrics APISIX Control Plane metrics port
928 ## Configure extra options for APISIX Control Plane containers' liveness and readiness probes
929 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes
930 ## @param controlPlane.livenessProbe.enabled Enable livenessProbe on APISIX Control Plane containers
931 ## @param controlPlane.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
932 ## @param controlPlane.livenessProbe.periodSeconds Period seconds for livenessProbe
933 ## @param controlPlane.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
934 ## @param controlPlane.livenessProbe.failureThreshold Failure threshold for livenessProbe
935 ## @param controlPlane.livenessProbe.successThreshold Success threshold for livenessProbe
939 initialDelaySeconds: 5
944 ## @param controlPlane.readinessProbe.enabled Enable readinessProbe on APISIX Control Plane containers
945 ## @param controlPlane.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
946 ## @param controlPlane.readinessProbe.periodSeconds Period seconds for readinessProbe
947 ## @param controlPlane.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
948 ## @param controlPlane.readinessProbe.failureThreshold Failure threshold for readinessProbe
949 ## @param controlPlane.readinessProbe.successThreshold Success threshold for readinessProbe
953 initialDelaySeconds: 5
958 ## @param controlPlane.startupProbe.enabled Enable startupProbe on APISIX Control Plane containers
959 ## @param controlPlane.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe
960 ## @param controlPlane.startupProbe.periodSeconds Period seconds for startupProbe
961 ## @param controlPlane.startupProbe.timeoutSeconds Timeout seconds for startupProbe
962 ## @param controlPlane.startupProbe.failureThreshold Failure threshold for startupProbe
963 ## @param controlPlane.startupProbe.successThreshold Success threshold for startupProbe
967 initialDelaySeconds: 5
972 ## @param controlPlane.customLivenessProbe Custom livenessProbe that overrides the default one
974 customLivenessProbe: {}
975 ## @param controlPlane.customReadinessProbe Custom readinessProbe that overrides the default one
977 customReadinessProbe: {}
978 ## @param controlPlane.customStartupProbe Custom startupProbe that overrides the default one
980 customStartupProbe: {}
981 ## APISIX Control Plane resource requests and limits
982 ## ref: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
983 ## @param 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).
985 resourcesPreset: "nano"
986 ## @param controlPlane.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
997 ## Configure Pods Security Context
998 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
999 ## @param controlPlane.podSecurityContext.enabled Enabled APISIX Control Plane pods' Security Context
1000 ## @param controlPlane.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy
1001 ## @param controlPlane.podSecurityContext.sysctls Set kernel settings using the sysctl interface
1002 ## @param controlPlane.podSecurityContext.supplementalGroups Set filesystem extra groups
1003 ## @param controlPlane.podSecurityContext.fsGroup Set APISIX Control Plane pod's Security Context fsGroup
1007 fsGroupChangePolicy: Always
1009 supplementalGroups: []
1011 ## Configure Container Security Context
1012 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
1013 ## @param controlPlane.containerSecurityContext.enabled Enabled APISIX Control Plane containers' Security Context
1014 ## @param controlPlane.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1015 ## @param controlPlane.containerSecurityContext.runAsUser Set APISIX Control Plane containers' Security Context runAsUser
1016 ## @param controlPlane.containerSecurityContext.runAsGroup Set APISIX Control Plane containers' Security Context runAsGroup
1017 ## @param controlPlane.containerSecurityContext.runAsNonRoot Set APISIX Control Plane containers' Security Context runAsNonRoot
1018 ## @param controlPlane.containerSecurityContext.privileged Set APISIX Control Plane containers' Security Context privileged
1019 ## @param controlPlane.containerSecurityContext.readOnlyRootFilesystem Set APISIX Control Plane containers' Security Context runAsNonRoot
1020 ## @param controlPlane.containerSecurityContext.allowPrivilegeEscalation Set APISIX Control Plane container's privilege escalation
1021 ## @param controlPlane.containerSecurityContext.capabilities.drop Set APISIX Control Plane container's Security Context runAsNonRoot
1022 ## @param controlPlane.containerSecurityContext.seccompProfile.type Set APISIX Control Plane container's Security Context seccomp profile
1024 containerSecurityContext:
1031 readOnlyRootFilesystem: true
1032 allowPrivilegeEscalation: false
1036 type: RuntimeDefault
1037 ## @param controlPlane.command Override default container command (useful when using custom images)
1040 ## @param controlPlane.args Override default container args (useful when using custom images)
1043 ## @param controlPlane.automountServiceAccountToken Mount Service Account token in pod
1045 automountServiceAccountToken: true
1046 ## @param controlPlane.hostAliases APISIX Control Plane pods host aliases
1047 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
1050 ## @param controlPlane.apiTokenAdmin Admin API Token for APISIX Control Plane
1053 ## @param controlPlane.apiTokenViewer Viewer API Token for APISIX Control Plane
1056 ## @param controlPlane.existingSecret Name of a secret containing API Tokens for APISIX Control Plane
1059 ## @param controlPlane.existingSecretAdminTokenKey Key inside the secret containing the Admin API Tokens for APISIX Control Plane
1061 existingSecretAdminTokenKey: ""
1062 ## @param controlPlane.existingSecretViewerTokenKey Key inside the secret containing the Viewer API Tokens for APISIX Control Plane
1064 existingSecretViewerTokenKey: ""
1065 ## @param controlPlane.defaultConfig [string] APISIX Control Plane configuration (evaluated as a template)
1068 {{- if .Values.controlPlane.metrics.enabled }}
1071 export_uri: /apisix/prometheus/metrics
1072 metric_prefix: apisix_
1073 enable_export_server: true
1076 port: {{ .Values.controlPlane.containerPorts.metrics }}
1079 error_log: /dev/stderr
1081 access_log: /dev/stdout
1083 access_log: /dev/stdout
1084 http_configuration_snippet: |
1085 proxy_buffering off;
1089 port: {{ .Values.controlPlane.containerPorts.control }}
1093 config_provider: etcd
1095 listen: 0.0.0.0:{{ .Values.controlPlane.containerPorts.configServer }}
1096 cert: /iamguarded/certs/{{ .Values.controlPlane.tls.certFilename }}
1097 cert_key: /iamguarded/certs/{{ .Values.controlPlane.tls.certKeyFilename }}
1100 {{- if .Values.etcd.enabled }}
1101 {{- $replicas := $.Values.etcd.replicaCount | int }}
1102 {{- range $i, $_e := until $replicas }}
1103 - {{ printf "%s://%s-%d.%s:%v" (ternary "https" "http" $.Values.etcd.auth.client.secureTransport) (include "apisix.etcd.fullname" $ ) $i (include "apisix.etcd.headlessServiceName" $) ( include "apisix.etcd.port" $ ) }} {{- end }}
1105 {{- range $node := .Values.externalEtcd.servers }}
1106 - {{ ternary "https" "http" $.Values.externalEtcd.secureTransport }}://{{ printf "%s:%v" $node (include "apisix.etcd.port" $) }}
1113 {{- if (include "apisix.etcd.authEnabled" .) }}
1114 user: "{{ print "{{APISIX_ETCD_USER}}" }}"
1115 password: "{{ print "{{APISIX_ETCD_PASSWORD}}" }}"
1117 {{- if .Values.controlPlane.tls.enabled }}
1119 {{- if .Values.controlPlane.tls.enabled }}
1120 cert: /iamguarded/certs/{{ .Values.controlPlane.tls.certFilename }}
1121 cert_key: /iamguarded/certs/{{ .Values.controlPlane.tls.certKeyFilename }}
1122 {{- if .Values.controlPlane.tls.certCAFilename }}
1123 client_ca_cert: /iamguarded/certs/{{ .Values.controlPlane.tls.certCAFilename }}
1128 {{- if .Values.controlPlane.tls.enabled }}
1131 admin_ssl_cert: /iamguarded/certs/{{ .Values.controlPlane.tls.certFilename }}
1132 admin_ssl_cert_key: /iamguarded/certs/{{ .Values.controlPlane.tls.certKeyFilename }}
1138 key: "{{ print "{{APISIX_ADMIN_API_TOKEN}}" }}"
1141 key: "{{ print "{{APISIX_VIEWER_API_TOKEN}}" }}"
1144 port: {{ .Values.controlPlane.containerPorts.adminAPI }}
1145 enable_admin_cors: true # Admin API support CORS response headers.
1146 enable_admin_ui: {{ ternary "true" "false" .Values.controlPlane.dashboardEnabled }}
1150 schema: https #default https
1151 # apiserver host, options [ipv4, ipv6, domain, environment variable]
1152 host: ${KUBERNETES_SERVICE_HOST}
1153 # apiserver port, options [port number, environment variable]
1154 port: ${KUBERNETES_SERVICE_PORT}
1156 # serviceaccount token or token_file
1157 token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
1158 default_weight: 50 # weight assigned to each discovered endpoint. default 50, minimum 0
1159 ## @param controlPlane.extraConfig [object] extra configuration parameters to add to the config.yaml file in APISIX Control plane
1162 ## @param controlPlane.existingConfigMap name of a ConfigMap with existing configuration for APISIX Control Plane
1164 existingConfigMap: ""
1165 ## @param controlPlane.extraConfigExistingConfigMap name of a ConfigMap with existing configuration for APISIX Control Plane
1167 extraConfigExistingConfigMap: ""
1169 ## @param controlPlane.tls.enabled Enable TLS transport in APISIX Control Plane
1172 ## @param controlPlane.tls.autoGenerated Auto-generate self-signed certificates
1175 ## @param controlPlane.tls.existingSecret Name of a secret containing the certificates
1178 ## @param controlPlane.tls.certFilename Path of the certificate file when mounted as a secret
1180 certFilename: tls.crt
1181 ## @param controlPlane.tls.certKeyFilename Path of the certificate key file when mounted as a secret
1183 certKeyFilename: tls.key
1184 ## @param controlPlane.tls.certCAFilename Path of the certificate CA file when mounted as a secret
1186 certCAFilename: ca.crt
1187 ## @param controlPlane.tls.cert Content of the certificate to be added to the secret
1190 ## @param controlPlane.tls.key Content of the certificate key to be added to the secret
1193 ## @param controlPlane.tls.ca Content of the certificate CA to be added to the secret
1196 ## @param controlPlane.podLabels Extra labels for APISIX Control Plane pods
1197 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1200 ## @param controlPlane.podAnnotations Annotations for APISIX Control Plane pods
1201 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
1204 ## @param controlPlane.podAffinityPreset Pod affinity preset. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
1205 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
1207 podAffinityPreset: ""
1208 ## @param controlPlane.podAntiAffinityPreset Pod anti-affinity preset. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
1209 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
1211 podAntiAffinityPreset: soft
1212 ## Pod Disruption Budget configuration
1213 ## ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb
1214 ## @param controlPlane.pdb.create Enable/disable a Pod Disruption Budget creation
1215 ## @param controlPlane.pdb.minAvailable Minimum number/percentage of pods that should remain scheduled
1216 ## @param controlPlane.pdb.maxUnavailable Maximum number/percentage of pods that may be made unavailable
1222 ## Node apisix.affinity preset
1223 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
1226 ## @param controlPlane.nodeAffinityPreset.type Node affinity preset type. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
1229 ## @param controlPlane.nodeAffinityPreset.key Node label key to match. Ignored if `apisix.affinity` is set
1232 ## @param controlPlane.nodeAffinityPreset.values Node label values to match. Ignored if `apisix.affinity` is set
1239 ## @param controlPlane.affinity Affinity for APISIX Control Plane pods assignment
1240 ## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
1241 ## NOTE: `apisix.podAffinityPreset`, `apisix.podAntiAffinityPreset`, and `apisix.nodeAffinityPreset` will be ignored when it's set
1244 ## @param controlPlane.nodeSelector Node labels for APISIX Control Plane pods assignment
1245 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
1248 ## @param controlPlane.tolerations Tolerations for APISIX Control Plane pods assignment
1249 ## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1252 ## @param controlPlane.updateStrategy.type APISIX Control Plane statefulset strategy type
1253 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
1257 ## Can be set to RollingUpdate or OnDelete
1260 ## @param controlPlane.priorityClassName APISIX Control Plane pods' priorityClassName
1262 priorityClassName: ""
1263 ## @param controlPlane.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template
1264 ## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/#spread-constraints-for-pods
1266 topologySpreadConstraints: []
1267 ## @param controlPlane.schedulerName Name of the k8s scheduler (other than default) for APISIX Control Plane pods
1268 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
1271 ## @param controlPlane.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully
1272 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
1274 terminationGracePeriodSeconds: ""
1275 ## @param controlPlane.lifecycleHooks for the APISIX Control Plane container(s) to automate configuration before or after startup
1278 ## @param controlPlane.extraEnvVars Array with extra environment variables to add to APISIX Control Plane nodes
1285 ## @param controlPlane.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for APISIX Control Plane nodes
1288 ## @param controlPlane.extraEnvVarsSecret Name of existing Secret containing extra env vars for APISIX Control Plane nodes
1290 extraEnvVarsSecret: ""
1291 ## @param controlPlane.extraVolumes Optionally specify extra list of additional volumes for the APISIX Control Plane pod(s)
1294 ## @param controlPlane.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the APISIX Control Plane container(s)
1296 extraVolumeMounts: []
1297 ## @param controlPlane.sidecars Add additional sidecar containers to the APISIX Control Plane pod(s)
1300 ## - name: your-image-name
1301 ## image: your-image
1302 ## imagePullPolicy: Always
1305 ## containerPort: 1234
1308 ## @param controlPlane.initContainers Add additional init containers to the APISIX Control Plane pod(s)
1309 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
1312 ## - name: your-image-name
1313 ## image: your-image
1314 ## imagePullPolicy: Always
1315 ## command: ['sh', '-c', 'echo "hello world"']
1318 ## @section APISIX Control Plane Traffic Exposure Parameters
1321 ## @param controlPlane.service.type APISIX Control Plane service type
1324 ## @param controlPlane.service.ports.adminAPI APISIX Control Plane service Admin API port
1325 ## @param controlPlane.service.ports.configServer APISIX Control Plane service Config Server port
1326 ## @param controlPlane.service.ports.metrics APISIX Control Plane service metrics port
1332 ## Node ports to expose
1333 ## @param controlPlane.service.nodePorts.adminAPI Node port for Admin API
1334 ## @param controlPlane.service.nodePorts.configServer Node port for Config Server
1335 ## @param controlPlane.service.nodePorts.metrics Node port for Metrics
1336 ## NOTE: choose port between <30000-32767>
1342 ## @param controlPlane.service.clusterIP APISIX Control Plane service Cluster IP
1347 ## @param controlPlane.service.loadBalancerIP APISIX Control Plane service Load Balancer IP
1348 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
1351 ## @param controlPlane.service.loadBalancerSourceRanges APISIX Control Plane service Load Balancer sources
1352 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
1354 ## loadBalancerSourceRanges:
1357 loadBalancerSourceRanges: []
1358 ## @param controlPlane.service.externalIPs APISIX Control Plane service External IPs
1359 ## https://kubernetes.io/docs/concepts/services-networking/service/#external-ips
1366 ## @param controlPlane.service.externalTrafficPolicy APISIX Control Plane service external traffic policy
1367 ## ref http://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-web-source-ip
1369 externalTrafficPolicy: Cluster
1370 ## @param controlPlane.service.annotations Additional custom annotations for APISIX Control Plane service
1373 ## @param controlPlane.service.extraPorts Extra ports to expose in APISIX Control Plane service (normally used with the `sidecars` value)
1376 ## @param controlPlane.service.sessionAffinity Control where web requests go, to the same pod or round-robin
1377 ## Values: WebIP or None
1378 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/
1380 sessionAffinity: None
1381 ## @param controlPlane.service.sessionAffinityConfig Additional settings for the sessionAffinity
1382 ## sessionAffinityConfig:
1384 ## timeoutSeconds: 300
1386 sessionAffinityConfig: {}
1388 ## Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
1391 ## @param controlPlane.networkPolicy.enabled Specifies whether a NetworkPolicy should be created
1394 ## @param controlPlane.networkPolicy.allowExternal Don't require server label for connections
1395 ## The Policy model to apply. When set to false, only pods with the correct
1396 ## server label will have network access to the ports server is listening
1397 ## on. When true, server will accept connections from any source
1398 ## (with the correct destination port).
1401 ## @param controlPlane.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
1403 allowExternalEgress: true
1404 ## @param controlPlane.networkPolicy.kubeAPIServerPorts [array] List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)
1406 kubeAPIServerPorts: [443, 6443, 8443]
1407 ## @param controlPlane.networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
1417 ## - matchExpressions:
1423 ## @param controlPlane.networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)
1433 ## - matchExpressions:
1440 ## @param controlPlane.networkPolicy.ingressNSMatchLabels [object] Labels to match to allow traffic from other namespaces
1441 ## @param controlPlane.networkPolicy.ingressNSPodMatchLabels [object] Pod labels to match to allow traffic from other namespaces
1443 ingressNSMatchLabels: {}
1444 ingressNSPodMatchLabels: {}
1445 ## ref: http://kubernetes.io/docs/concepts/services-networking/ingress/
1448 ## @param controlPlane.ingress.enabled Enable ingress record generation for APISIX Control Plane
1451 ## @param controlPlane.ingress.pathType Ingress path type
1453 pathType: ImplementationSpecific
1454 ## @param controlPlane.ingress.apiVersion Force Ingress API version (automatically detected if not set)
1457 ## @param controlPlane.ingress.hostname Default host for the ingress record
1459 hostname: apisix-control-plane.local
1460 ## @param controlPlane.ingress.ingressClassName IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)
1461 ## This is supported in Kubernetes 1.18+ and required if you have more than one IngressClass marked as the default for your cluster .
1462 ## ref: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/
1464 ingressClassName: ""
1465 ## @param controlPlane.ingress.path Default path for the ingress record
1466 ## NOTE: You may need to set this to '/*' in order to use this with ALB ingress controllers
1469 ## @param controlPlane.ingress.annotations Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.
1470 ## Use this parameter to set the required annotations for cert-manager, see
1471 ## ref: https://cert-manager.io/docs/usage/ingress/#supported-annotations
1474 ## kubernetes.io/ingress.class: nginx
1475 ## cert-manager.io/cluster-issuer: cluster-issuer-name
1478 ## @param controlPlane.ingress.tls Enable TLS configuration for the host defined at `controlPlane.ingress.hostname` parameter
1479 ## TLS certificates will be retrieved from a TLS secret with name: `{{- printf "%s-tls" .Values.ingress.hostname }}`
1481 ## - Use the `controlPlane.ingress.secrets` parameter to create this TLS secret
1482 ## - Rely on cert-manager to create it by setting the corresponding annotations
1483 ## - Rely on Helm to create self-signed certificates by setting `controlPlane.ingress.selfSigned=true`
1486 ## @param controlPlane.ingress.selfSigned Create a TLS secret for this ingress record using self-signed certificates generated by Helm
1489 ## @param controlPlane.ingress.extraHosts An array with additional hostname(s) to be covered with the ingress record
1492 ## - name: apisix.local
1496 ## @param controlPlane.ingress.extraPaths An array with additional arbitrary paths that may need to be added to the ingress under the main host
1501 ## serviceName: ssl-redirect
1502 ## servicePort: use-annotation
1505 ## @param controlPlane.ingress.extraTls TLS configuration for additional hostname(s) to be covered with this ingress record
1506 ## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/#tls
1511 ## secretName: apisix.local-tls
1514 ## @param controlPlane.ingress.secrets Custom TLS certificates as secrets
1515 ## NOTE: 'key' and 'certificate' are expected in PEM format
1516 ## NOTE: 'name' should line up with a 'secretName' set further up
1517 ## If it is not set and you're using cert-manager, this is unneeded, as it will create a secret for you with valid certificates
1518 ## If it is not set and you're NOT using cert-manager either, self-signed certificates will be created valid for 365 days
1519 ## It is also possible to create and manage the certificates outside of this helm chart
1520 ## Please see README.md for more information
1523 ## - name: apisix.local-tls
1525 ## -----BEGIN RSA PRIVATE KEY-----
1527 ## -----END RSA PRIVATE KEY-----
1529 ## -----BEGIN CERTIFICATE-----
1531 ## -----END CERTIFICATE-----
1534 ## @param controlPlane.ingress.extraRules Additional rules to be covered with this ingress record
1535 ## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-rules
1538 ## - host: example.local
1543 ## name: example-svc
1548 ## @section APISIX Control Plane Autoscaling configuration
1549 ## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
1553 ## @param controlPlane.autoscaling.vpa.enabled Enable VPA
1556 ## @param controlPlane.autoscaling.vpa.annotations Annotations for VPA resource
1559 ## @param controlPlane.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
1561 controlledResources: []
1562 ## @param controlPlane.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
1566 ## @param controlPlane.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
1571 ## @param 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
1572 ## Possible values are "Off", "Initial", "Recreate", and "Auto".
1576 ## @param controlPlane.autoscaling.hpa.enabled Enable HPA for APISIX Control Plane
1579 ## @param controlPlane.autoscaling.hpa.minReplicas Minimum number of APISIX Control Plane replicas
1582 ## @param controlPlane.autoscaling.hpa.maxReplicas Maximum number of APISIX Control Plane replicas
1585 ## @param controlPlane.autoscaling.hpa.targetCPU Target CPU utilization percentage
1588 ## @param controlPlane.autoscaling.hpa.targetMemory Target Memory utilization percentage
1591 ## @section APISIX Control Plane RBAC parameters
1594 ## RBAC configuration
1597 ## @param controlPlane.rbac.create Specifies whether RBAC resources should be created
1600 ## @param controlPlane.rbac.rules Custom RBAC rules to set
1612 ## ServiceAccount configuration
1615 ## @param controlPlane.serviceAccount.create Specifies whether a ServiceAccount should be created
1618 ## @param controlPlane.serviceAccount.name The name of the ServiceAccount to use.
1619 ## If not set and create is true, a name is generated using the common.names.fullname template
1622 ## @param controlPlane.serviceAccount.annotations Additional Service Account annotations (evaluated as a template)
1625 ## @param controlPlane.serviceAccount.automountServiceAccountToken Automount service account token for the APISIX Control Plane service account
1627 automountServiceAccountToken: false
1628 ## @section APISIX Control Plane Metrics Parameters
1631 ## Prometheus metrics
1634 ## @param controlPlane.metrics.enabled Enable the export of Prometheus metrics
1637 ## @param controlPlane.metrics.annotations [object] Annotations for the APISIX Control Plane service in order to scrape metrics
1639 prometheus.io/scrape: "true"
1640 prometheus.io/port: "{{ .Values.controlPlane.service.ports.metrics }}"
1641 prometheus.io/path: "/apisix/prometheus/metrics"
1642 ## Prometheus Operator ServiceMonitor configuration
1645 ## @param controlPlane.metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
1648 ## @param controlPlane.metrics.serviceMonitor.namespace Namespace in which Prometheus is running
1651 ## @param controlPlane.metrics.serviceMonitor.annotations Additional custom annotations for the ServiceMonitor
1654 ## @param controlPlane.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor
1657 ## @param controlPlane.metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in Prometheus
1660 ## @param controlPlane.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels
1663 ## @param controlPlane.metrics.serviceMonitor.interval Interval at which metrics should be scraped.
1664 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
1669 ## @param controlPlane.metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended
1670 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
1672 ## scrapeTimeout: 10s
1675 ## @param controlPlane.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics
1677 metricRelabelings: []
1678 ## @param controlPlane.metrics.serviceMonitor.relabelings Specify general relabeling
1681 ## @param controlPlane.metrics.serviceMonitor.selector Prometheus instance selector labels
1683 ## prometheus: my-prometheus
1686## @section APISIX Ingress Controller Parameters
1689 ## @param ingressController.enabled Enable APISIX Ingress Controller
1692 ## Iamguarded APISIX Ingress Controller image
1693 ## @param ingressController.image.registry [default: REGISTRY_NAME] APISIX Ingress Controller image registry
1694 ## @param ingressController.image.repository [default: REPOSITORY_NAME/apisix-ingress-controller] APISIX Ingress Controller image repository
1695 ## @skip ingressController.image.tag APISIX Ingress Controller image tag (immutable tags are recommended)
1696 ## @param 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)
1697 ## @param ingressController.image.pullPolicy APISIX Ingress Controller image pull policy
1698 ## @param ingressController.image.pullSecrets APISIX Ingress Controller image pull secrets
1699 ## @param ingressController.image.debug Enable APISIX Ingress Controller image debug mode
1703 repository: chainguard-private/apisix-ingress-controller-iamguarded
1706 ## Specify a imagePullPolicy
1707 ## ref: http://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
1709 pullPolicy: IfNotPresent
1710 ## Optionally specify an array of imagePullSecrets.
1711 ## Secrets must be manually created in the namespace.
1712 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
1715 ## - myRegistryKeySecretName
1718 ## Enable debug mode
1721 ## ADC server sidecar image (required by the new APISIX ingress controller to communicate with APISIX)
1722 ## @param ingressController.adcServer.image.registry ADC server image registry
1723 ## @param ingressController.adcServer.image.repository ADC server image repository
1724 ## @param ingressController.adcServer.image.tag ADC server image tag
1725 ## @param ingressController.adcServer.image.digest ADC server image digest (overrides tag when set)
1726 ## @param ingressController.adcServer.image.pullPolicy ADC server image pull policy
1727 ## @param ingressController.adcServer.logLevel ADC server log level
1732 repository: chainguard-private/adc-iamguarded
1735 pullPolicy: IfNotPresent
1737 ## @param ingressController.replicaCount Number of APISIX Ingress Controller replicas to deploy
1740 ## @param ingressController.containerPorts.http APISIX Ingress Controller http container port (metrics)
1741 ## @param ingressController.containerPorts.https APISIX Ingress Controller https container port
1742 ## @param ingressController.containerPorts.probe APISIX Ingress Controller health probe container port
1748 ## @param ingressController.gatewayProxy.create Create a GatewayProxy resource pointing to the APISIX control plane
1752 ## Configure extra options for APISIX Ingress Controller containers' liveness and readiness probes
1753 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes
1754 ## @param ingressController.livenessProbe.enabled Enable livenessProbe on APISIX Ingress Controller containers
1755 ## @param ingressController.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
1756 ## @param ingressController.livenessProbe.periodSeconds Period seconds for livenessProbe
1757 ## @param ingressController.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
1758 ## @param ingressController.livenessProbe.failureThreshold Failure threshold for livenessProbe
1759 ## @param ingressController.livenessProbe.successThreshold Success threshold for livenessProbe
1763 initialDelaySeconds: 5
1768 ## @param ingressController.readinessProbe.enabled Enable readinessProbe on APISIX Ingress Controller containers
1769 ## @param ingressController.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
1770 ## @param ingressController.readinessProbe.periodSeconds Period seconds for readinessProbe
1771 ## @param ingressController.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
1772 ## @param ingressController.readinessProbe.failureThreshold Failure threshold for readinessProbe
1773 ## @param ingressController.readinessProbe.successThreshold Success threshold for readinessProbe
1777 initialDelaySeconds: 5
1782 ## @param ingressController.startupProbe.enabled Enable startupProbe on APISIX Ingress Controller containers
1783 ## @param ingressController.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe
1784 ## @param ingressController.startupProbe.periodSeconds Period seconds for startupProbe
1785 ## @param ingressController.startupProbe.timeoutSeconds Timeout seconds for startupProbe
1786 ## @param ingressController.startupProbe.failureThreshold Failure threshold for startupProbe
1787 ## @param ingressController.startupProbe.successThreshold Success threshold for startupProbe
1791 initialDelaySeconds: 5
1796 ## @param ingressController.customLivenessProbe Custom livenessProbe that overrides the default one
1798 customLivenessProbe: {}
1799 ## @param ingressController.customReadinessProbe Custom readinessProbe that overrides the default one
1801 customReadinessProbe: {}
1802 ## @param ingressController.customStartupProbe Custom startupProbe that overrides the default one
1804 customStartupProbe: {}
1805 ## APISIX Ingress Controller resource requests and limits
1806 ## ref: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
1807 ## @param 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).
1809 resourcesPreset: "nano"
1810 ## @param ingressController.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
1821 ## Configure Pods Security Context
1822 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
1823 ## @param ingressController.podSecurityContext.enabled Enabled APISIX Ingress Controller pods' Security Context
1824 ## @param ingressController.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy
1825 ## @param ingressController.podSecurityContext.sysctls Set kernel settings using the sysctl interface
1826 ## @param ingressController.podSecurityContext.supplementalGroups Set filesystem extra groups
1827 ## @param ingressController.podSecurityContext.fsGroup Set APISIX Ingress Controller pod's Security Context fsGroup
1831 fsGroupChangePolicy: Always
1833 supplementalGroups: []
1835 ## Configure Container Security Context
1836 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
1837 ## @param ingressController.containerSecurityContext.enabled Enabled APISIX Ingress Controller containers' Security Context
1838 ## @param ingressController.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1839 ## @param ingressController.containerSecurityContext.runAsUser Set APISIX Ingress Controller containers' Security Context runAsUser
1840 ## @param ingressController.containerSecurityContext.runAsGroup Set APISIX Ingress Controller containers' Security Context runAsGroup
1841 ## @param ingressController.containerSecurityContext.runAsNonRoot Set APISIX Ingress Controller containers' Security Context runAsNonRoot
1842 ## @param ingressController.containerSecurityContext.privileged Set APISIX Ingress Controller containers' Security Context privileged
1843 ## @param ingressController.containerSecurityContext.readOnlyRootFilesystem Set APISIX Ingress Controller containers' Security Context runAsNonRoot
1844 ## @param ingressController.containerSecurityContext.allowPrivilegeEscalation Set APISIX Ingress Controller container's privilege escalation
1845 ## @param ingressController.containerSecurityContext.capabilities.drop Set APISIX Ingress Controller container's Security Context runAsNonRoot
1846 ## @param ingressController.containerSecurityContext.seccompProfile.type Set APISIX Ingress Controller container's Security Context seccomp profile
1848 containerSecurityContext:
1855 readOnlyRootFilesystem: true
1856 allowPrivilegeEscalation: false
1860 type: RuntimeDefault
1861 ## @param ingressController.command Override default container command (useful when using custom images)
1864 ## @param ingressController.args Override default container args (useful when using custom images)
1867 ## @param ingressController.automountServiceAccountToken Mount Service Account token in pod
1869 automountServiceAccountToken: true
1870 ## @param ingressController.hostAliases APISIX Ingress Controller pods host aliases
1871 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
1874 ## @param ingressController.podLabels Extra labels for APISIX Ingress Controller pods
1875 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1878 ## @param ingressController.podAnnotations Annotations for APISIX Ingress Controller pods
1879 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
1882 ## @param ingressController.podAffinityPreset Pod affinity preset. Ignored if `injector.affinity` is set. Allowed values: `soft` or `hard`
1883 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
1885 podAffinityPreset: ""
1886 ## @param ingressController.podAntiAffinityPreset Pod anti-affinity preset. Ignored if `injector.affinity` is set. Allowed values: `soft` or `hard`
1887 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
1889 podAntiAffinityPreset: soft
1890 ## Pod Disruption Budget configuration
1891 ## ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb
1892 ## @param ingressController.pdb.create Enable/disable a Pod Disruption Budget creation
1893 ## @param ingressController.pdb.minAvailable Minimum number/percentage of pods that should remain scheduled
1894 ## @param ingressController.pdb.maxUnavailable Maximum number/percentage of pods that may be made unavailable
1900 ## Node injector.affinity preset
1901 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
1904 ## @param ingressController.nodeAffinityPreset.type Node affinity preset type. Ignored if `injector.affinity` is set. Allowed values: `soft` or `hard`
1907 ## @param ingressController.nodeAffinityPreset.key Node label key to match. Ignored if `injector.affinity` is set
1910 ## @param ingressController.nodeAffinityPreset.values Node label values to match. Ignored if `injector.affinity` is set
1917 ## @param ingressController.affinity Affinity for APISIX Ingress Controller pods assignment
1918 ## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
1919 ## NOTE: `injector.podAffinityPreset`, `injector.podAntiAffinityPreset`, and `injector.nodeAffinityPreset` will be ignored when it's set
1922 ## @param ingressController.nodeSelector Node labels for APISIX Ingress Controller pods assignment
1923 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
1926 ## @param ingressController.tolerations Tolerations for APISIX Ingress Controller pods assignment
1927 ## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1930 ## @param ingressController.updateStrategy.type APISIX Ingress Controller statefulset strategy type
1931 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
1935 ## Can be set to RollingUpdate or OnDelete
1938 ## @param ingressController.priorityClassName APISIX Ingress Controller pods' priorityClassName
1940 priorityClassName: ""
1941 ## @param ingressController.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template
1942 ## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/#spread-constraints-for-pods
1944 topologySpreadConstraints: []
1945 ## @param ingressController.schedulerName Name of the k8s scheduler (other than default) for APISIX Ingress Controller pods
1946 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
1949 ## @param ingressController.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully
1950 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
1952 terminationGracePeriodSeconds: ""
1953 ## @param ingressController.lifecycleHooks for the APISIX Ingress Controller container(s) to automate configuration before or after startup
1956 ## @param ingressController.extraEnvVars Array with extra environment variables to add to APISIX Ingress Controller nodes
1963 ## @param ingressController.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for APISIX Ingress Controller nodes
1966 ## @param ingressController.extraEnvVarsSecret Name of existing Secret containing extra env vars for APISIX Ingress Controller nodes
1968 extraEnvVarsSecret: ""
1969 ## @param ingressController.extraVolumes Optionally specify extra list of additional volumes for the APISIX Ingress Controller pod(s)
1972 ## @param ingressController.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the APISIX Ingress Controller container(s)
1974 extraVolumeMounts: []
1975 ## @param ingressController.sidecars Add additional sidecar containers to the APISIX Ingress Controller pod(s)
1978 ## - name: your-image-name
1979 ## image: your-image
1980 ## imagePullPolicy: Always
1983 ## containerPort: 1234
1986 ## @param ingressController.initContainers Add additional init containers to the APISIX Ingress Controller pod(s)
1987 ## ref: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
1990 ## - name: your-image-name
1991 ## image: your-image
1992 ## imagePullPolicy: Always
1993 ## command: ['sh', '-c', 'echo "hello world"']
1996 ## @param ingressController.ingressClass.create Specifies whether a IngressClass should be created
1997 ## @param ingressController.ingressClass.name IngressClass that will be be used to implement the APISIX Ingress Controller Ingress
1998 ## @param ingressController.ingressClass.annotations Additional annotations for the APISIX Ingress Controller IngressClass
2004 ## @param ingressController.defaultConfig [string] APISIX Ingress Controller configuration (evaluated as a template)
2009 log_output: "stderr"
2010 {{- if .Values.ingressController.tls.enabled }}
2011 https_listen: ":{{ .Values.ingressController.containerPorts.https }}"
2012 cert_file: "/iamguarded/certs/{{ .Values.ingressController.tls.certFilename }}"
2013 key_file: "/iamguarded/certs/{{ .Values.ingressController.tls.certKeyFilename }}"
2015 http_listen: ":{{ .Values.ingressController.containerPorts.http }}"
2016 ingress_publish_service: "{{ include "common.names.namespace" . }}/{{ ternary (include "apisix.data-plane.fullname" .) (include "apisix.control-plane.fullname" .) .Values.dataPlane.enabled }}"
2017 enable_profiling: true
2018 apisix-resource-sync-interval: 1h
2021 resync_interval: "6h"
2022 election_id: "{{ include "apisix.ingress-controller.fullname" . }}-leader"
2023 ingress_class: {{ .Values.ingressController.ingressClass.name | quote }}
2024 ingress_version: "networking/v1"
2025 watch_endpointslices: false
2026 apisix_route_version: "apisix.apache.org/v2"
2027 enable_gateway_api: false
2028 apisix_version: "apisix.apache.org/v2"
2029 plugin_metadata_cm: ""
2031 admin_api_version: "v3"
2032 default_cluster_base_url: {{ ternary "https" "http" .Values.controlPlane.tls.enabled }}://{{ include "apisix.control-plane.fullname" . }}:{{ .Values.controlPlane.service.ports.adminAPI }}/apisix/admin
2033 default_cluster_admin_key: "{{ print "{{APISIX_ADMIN_API_TOKEN}}" }}"
2034 default_cluster_name: "default"
2035 ## @param ingressController.extraConfig Extra configuration parameters for APISIX Ingress Controller
2038 ## @param ingressController.existingConfigMap name of a ConfigMap with existing configuration for the APISIX Ingress Controller
2040 existingConfigMap: ""
2041 ## @param ingressController.extraConfigExistingConfigMap name of a ConfigMap with existing configuration for the APISIX Ingress Controller
2043 extraConfigExistingConfigMap: ""
2045 ## @param ingressController.tls.enabled Enable TLS transport in APISIX Ingress Controller
2048 ## @param ingressController.tls.autoGenerated Auto-generate self-signed certificates
2051 ## @param ingressController.tls.existingSecret Name of a secret containing the certificates
2054 ## @param ingressController.tls.certFilename Path of the certificate file when mounted as a secret
2056 certFilename: tls.crt
2057 ## @param ingressController.tls.certKeyFilename Path of the certificate key file when mounted as a secret
2059 certKeyFilename: tls.key
2060 ## @param ingressController.tls.certCAFilename Path of the certificate CA file when mounted as a secret
2062 certCAFilename: ca.crt
2063 ## @param ingressController.tls.cert Content of the certificate to be added to the secret
2066 ## @param ingressController.tls.key Content of the certificate key to be added to the secret
2069 ## @param ingressController.tls.ca Content of the certificate CA to be added to the secret
2072 ## @section APISIX Ingress Controller Traffic Exposure Parameters
2075 ## @param ingressController.service.type APISIX Ingress Controller service type
2078 ## @param ingressController.service.ports.http APISIX Ingress Controller service HTTP port
2079 ## @param ingressController.service.ports.https APISIX Ingress Controller service HTTPS port
2084 ## Node ports to expose
2085 ## @param ingressController.service.nodePorts.http Node port for HTTP
2086 ## @param ingressController.service.nodePorts.https Node port for HTTPS
2087 ## NOTE: choose port between <30000-32767>
2092 ## @param ingressController.service.clusterIP APISIX Ingress Controller service Cluster IP
2097 ## @param ingressController.service.loadBalancerIP APISIX Ingress Controller service Load Balancer IP
2098 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
2101 ## @param ingressController.service.loadBalancerSourceRanges APISIX Ingress Controller service Load Balancer sources
2102 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
2104 ## loadBalancerSourceRanges:
2107 loadBalancerSourceRanges: []
2108 ## @param ingressController.service.externalIPs APISIX Ingress Controller service External IPs
2109 ## https://kubernetes.io/docs/concepts/services-networking/service/#external-ips
2116 ## @param ingressController.service.externalTrafficPolicy APISIX Ingress Controller service external traffic policy
2117 ## ref http://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-web-source-ip
2119 externalTrafficPolicy: Cluster
2120 ## @param ingressController.service.annotations Additional custom annotations for APISIX Ingress Controller service
2123 ## @param ingressController.service.extraPorts Extra ports to expose in APISIX Ingress Controller service (normally used with the `sidecars` value)
2126 ## @param ingressController.service.sessionAffinity Control where web requests go, to the same pod or round-robin
2127 ## Values: WebIP or None
2128 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/
2130 sessionAffinity: None
2131 ## @param ingressController.service.sessionAffinityConfig Additional settings for the sessionAffinity
2132 ## sessionAffinityConfig:
2134 ## timeoutSeconds: 300
2136 sessionAffinityConfig: {}
2138 ## Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
2141 ## @param ingressController.networkPolicy.enabled Specifies whether a NetworkPolicy should be created
2144 ## @param ingressController.networkPolicy.allowExternal Don't require server label for connections
2145 ## The Policy model to apply. When set to false, only pods with the correct
2146 ## server label will have network access to the ports server is listening
2147 ## on. When true, server will accept connections from any source
2148 ## (with the correct destination port).
2151 ## @param ingressController.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
2153 allowExternalEgress: true
2154 ## @param ingressController.networkPolicy.kubeAPIServerPorts [array] List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)
2156 kubeAPIServerPorts: [443, 6443, 8443]
2157 ## @param ingressController.networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
2167 ## - matchExpressions:
2173 ## @param ingressController.networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)
2183 ## - matchExpressions:
2190 ## @param ingressController.networkPolicy.ingressNSMatchLabels [object] Labels to match to allow traffic from other namespaces
2191 ## @param ingressController.networkPolicy.ingressNSPodMatchLabels [object] Pod labels to match to allow traffic from other namespaces
2193 ingressNSMatchLabels: {}
2194 ingressNSPodMatchLabels: {}
2195 ## ref: http://kubernetes.io/docs/concepts/services-networking/ingress/
2198 ## @param ingressController.ingress.enabled Enable ingress record generation for APISIX Ingress Controller
2201 ## @param ingressController.ingress.pathType Ingress path type
2203 pathType: ImplementationSpecific
2204 ## @param ingressController.ingress.apiVersion Force Ingress API version (automatically detected if not set)
2207 ## @param ingressController.ingress.hostname Default host for the ingress record
2209 hostname: apisix-ingress-controller.local
2210 ## @param ingressController.ingress.ingressClassName IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)
2211 ## This is supported in Kubernetes 1.18+ and required if you have more than one IngressClass marked as the default for your cluster .
2212 ## ref: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/
2214 ingressClassName: ""
2215 ## @param ingressController.ingress.path Default path for the ingress record
2216 ## NOTE: You may need to set this to '/*' in order to use this with ALB ingress controllers
2219 ## @param ingressController.ingress.annotations Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.
2220 ## Use this parameter to set the required annotations for cert-manager, see
2221 ## ref: https://cert-manager.io/docs/usage/ingress/#supported-annotations
2224 ## kubernetes.io/ingress.class: nginx
2225 ## cert-manager.io/cluster-issuer: cluster-issuer-name
2228 ## @param ingressController.ingress.tls Enable TLS configuration for the host defined at `ingressController.ingress.hostname` parameter
2229 ## TLS certificates will be retrieved from a TLS secret with name: `{{- printf "%s-tls" .Values.ingress.hostname }}`
2231 ## - Use the `ingressController.ingress.secrets` parameter to create this TLS secret
2232 ## - Rely on cert-manager to create it by setting the corresponding annotations
2233 ## - Rely on Helm to create self-signed certificates by setting `ingressController.ingress.selfSigned=true`
2236 ## @param ingressController.ingress.selfSigned Create a TLS secret for this ingress record using self-signed certificates generated by Helm
2239 ## @param ingressController.ingress.extraHosts An array with additional hostname(s) to be covered with the ingress record
2242 ## - name: apisix.local
2246 ## @param ingressController.ingress.extraPaths An array with additional arbitrary paths that may need to be added to the ingress under the main host
2251 ## serviceName: ssl-redirect
2252 ## servicePort: use-annotation
2255 ## @param ingressController.ingress.extraTls TLS configuration for additional hostname(s) to be covered with this ingress record
2256 ## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/#tls
2261 ## secretName: apisix.local-tls
2264 ## @param ingressController.ingress.secrets Custom TLS certificates as secrets
2265 ## NOTE: 'key' and 'certificate' are expected in PEM format
2266 ## NOTE: 'name' should line up with a 'secretName' set further up
2267 ## If it is not set and you're using cert-manager, this is unneeded, as it will create a secret for you with valid certificates
2268 ## If it is not set and you're NOT using cert-manager either, self-signed certificates will be created valid for 365 days
2269 ## It is also possible to create and manage the certificates outside of this helm chart
2270 ## Please see README.md for more information
2273 ## - name: apisix.local-tls
2275 ## -----BEGIN RSA PRIVATE KEY-----
2277 ## -----END RSA PRIVATE KEY-----
2279 ## -----BEGIN CERTIFICATE-----
2281 ## -----END CERTIFICATE-----
2284 ## @param ingressController.ingress.extraRules Additional rules to be covered with this ingress record
2285 ## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-rules
2288 ## - host: example.local
2293 ## name: example-svc
2298 ## @section APISIX Ingress Controller Autoscaling configuration
2299 ## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
2303 ## @param ingressController.autoscaling.vpa.enabled Enable VPA
2306 ## @param ingressController.autoscaling.vpa.annotations Annotations for VPA resource
2309 ## @param ingressController.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
2311 controlledResources: []
2312 ## @param ingressController.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
2316 ## @param ingressController.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
2321 ## @param 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
2322 ## Possible values are "Off", "Initial", "Recreate", and "Auto".
2326 ## @param ingressController.autoscaling.hpa.enabled Enable HPA for APISIX Ingress Controller
2329 ## @param ingressController.autoscaling.hpa.minReplicas Minimum number of APISIX Ingress Controller replicas
2332 ## @param ingressController.autoscaling.hpa.maxReplicas Maximum number of APISIX Ingress Controller replicas
2335 ## @param ingressController.autoscaling.hpa.targetCPU Target CPU utilization percentage
2338 ## @param ingressController.autoscaling.hpa.targetMemory Target Memory utilization percentage
2341 ## @section APISIX Ingress Controller RBAC Parameters
2344 ## RBAC configuration
2347 ## @param ingressController.rbac.create Specifies whether RBAC resources should be created
2350 ## @param ingressController.rbac.rules Custom RBAC rules to set
2362 ## ServiceAccount configuration
2365 ## @param ingressController.serviceAccount.create Specifies whether a ServiceAccount should be created
2368 ## @param ingressController.serviceAccount.name The name of the ServiceAccount to use.
2369 ## If not set and create is true, a name is generated using the common.names.fullname template
2372 ## @param ingressController.serviceAccount.annotations Additional Service Account annotations (evaluated as a template)
2375 ## @param ingressController.serviceAccount.automountServiceAccountToken Automount service account token for the server service account
2377 automountServiceAccountToken: false
2378 ## Prometheus metrics
2381 ## @param ingressController.metrics.enabled Enable the export of Prometheus metrics
2384 ## @param ingressController.metrics.annotations [object] Annotations for the APISIX Ingress Controller service in order to scrape metrics
2386 prometheus.io/scrape: "true"
2387 prometheus.io/port: "{{ .Values.ingressController.service.ports.http }}"
2388 ## Prometheus Operator ServiceMonitor configuration
2391 ## @param ingressController.metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
2394 ## @param ingressController.metrics.serviceMonitor.namespace Namespace in which Prometheus is running
2397 ## @param ingressController.metrics.serviceMonitor.annotations Additional custom annotations for the ServiceMonitor
2400 ## @param ingressController.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor
2403 ## @param ingressController.metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in Prometheus
2406 ## @param ingressController.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels
2409 ## @param ingressController.metrics.serviceMonitor.interval Interval at which metrics should be scraped.
2410 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
2415 ## @param ingressController.metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended
2416 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
2418 ## scrapeTimeout: 10s
2421 ## @param ingressController.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics
2423 metricRelabelings: []
2424 ## @param ingressController.metrics.serviceMonitor.relabelings Specify general relabeling
2427 ## @param ingressController.metrics.serviceMonitor.selector Prometheus instance selector labels
2429 ## prometheus: my-prometheus
2432## @section Init containers parameters
2435 ## @param waitContainer.image.registry [default: REGISTRY_NAME] Init container wait-container image registry
2436 ## @param waitContainer.image.repository [default: REPOSITORY_NAME/os-shell] Init container wait-container image name
2437 ## @skip waitContainer.image.tag Init container wait-container image tag
2438 ## @param waitContainer.image.digest Init container wait-container image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
2442 repository: chainguard-private/os-shell-iamguarded
2445 ## @param waitContainer.image.pullPolicy Init container wait-container image pull policy
2447 pullPolicy: IfNotPresent
2448 ## @param waitContainer.image.pullSecrets [array] Specify docker-registry secret names as an array
2449 ## Optionally specify an array of imagePullSecrets.
2450 ## Secrets must be manually created in the namespace.
2451 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
2454 ## - myRegistryKeySecretName
2457 ## Configure Container Security Context
2458 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
2459 ## @param waitContainer.containerSecurityContext.enabled Enabled APISIX Ingress Controller containers' Security Context
2460 ## @param waitContainer.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
2461 ## @param waitContainer.containerSecurityContext.runAsUser Set APISIX Ingress Controller containers' Security Context runAsUser
2462 ## @param waitContainer.containerSecurityContext.runAsGroup Set APISIX Ingress Controller containers' Security Context runAsGroup
2463 ## @param waitContainer.containerSecurityContext.runAsNonRoot Set APISIX Ingress Controller containers' Security Context runAsNonRoot
2464 ## @param waitContainer.containerSecurityContext.privileged Set APISIX Ingress Controller containers' Security Context privileged
2465 ## @param waitContainer.containerSecurityContext.readOnlyRootFilesystem Set APISIX Ingress Controller containers' Security Context readOnlyRootFilesystem
2466 ## @param waitContainer.containerSecurityContext.allowPrivilegeEscalation Set APISIX Ingress Controller containers' Security Context allowPrivilegeEscalation
2467 ## @param waitContainer.containerSecurityContext.capabilities.drop Set APISIX Ingress Controller containers' Security Context capabilities.drop
2468 ## @param waitContainer.containerSecurityContext.seccompProfile.type Set APISIX Ingress Controller containers' Security Context seccompProfile.type
2470 containerSecurityContext:
2477 readOnlyRootFilesystem: true
2478 allowPrivilegeEscalation: false
2482 type: RuntimeDefault
2483## @section External etcd settings
2486 ## @param externalEtcd.servers List of hostnames of the external etcd
2489 ## @param externalEtcd.port Port of the external etcd instance
2492 ## @param externalEtcd.user User of the external etcd instance
2495 ## @param externalEtcd.password Password of the external etcd instance
2498 ## @param externalEtcd.existingSecret Name of a secret containing the external etcd password
2501 ## @param externalEtcd.existingSecretPasswordKey Key inside the secret containing the external etcd password
2503 existingSecretPasswordKey: "etcd-root-password"
2504 ## @param externalEtcd.secureTransport Use TLS for client-to-server communications
2506 secureTransport: false
2507## @section etcd sub-chart parameters
2510 ## @param etcd.enabled Deploy etcd sub-chart
2513 ## @param etcd.replicaCount Number of etcd replicas
2516 ## @param etcd.containerPorts.client Container port for etcd
2520 ## @param etcd.auth.rbac.create Switch to enable RBAC authentication
2521 ## @param etcd.auth.rbac.rootPassword etcd root password
2522 ## @param etcd.auth.client.secureTransport use TLS for client-to-server communications
2526 ## Currently the data_plane is not working with etcd credentials enabled. This should be
2527 ## changed when this is fixed by APISIX
2531 secureTransport: false
2532 ## @param 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).
2534 resourcesPreset: "micro"
2535 ## @param etcd.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
2548 repository: chainguard-private/etcd-iamguarded
2551## @section Gateway API parameters
2553## Gateway API configuration
2556 ## @param gatewayApi.installCRDs Install Gateway API CRDs bundled with the chart
2557 ## Disable when the cluster already provides Gateway API CRDs (e.g. GKE with
2558 ## native Gateway API enabled) to avoid CRD ownership conflicts at install time.