DirectorySecurity AdvisoriesPricing
Sign in
Directory
apisix logoHELM

apisix

Helm chart
iamguarded
Last changed
Request a free trial

Contact our team to test out this Helm chart and related images for free. Please also indicate any other images you would like to evaluate.

Overview
Chart tags
Default values
Chart metadata
Images

Tag:
Compare:

1
# This file has been modified by Chainguard, Inc.
2
#
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
6
#
7
# Copyright Broadcom, Inc. All Rights Reserved.
8
# SPDX-License-Identifier: APACHE-2.0
9
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
14
##
15
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)
20
##
21
global:
22
imageRegistry: ""
23
useImageTags: false
24
## E.g.
25
## imagePullSecrets:
26
## - myRegistryKeySecretName
27
##
28
imagePullSecrets: []
29
defaultStorageClass: ""
30
## Security parameters
31
##
32
security:
33
## @param global.security.allowInsecureImages Allows skipping image verification
34
allowInsecureImages: false
35
## Compatibility adaptations for Kubernetes platforms
36
##
37
compatibility:
38
## Compatibility adaptations for Openshift
39
##
40
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)
42
##
43
adaptSecurityContext: auto
44
org: ""
45
## @section Common parameters
46
##
47
48
## @param kubeVersion Override Kubernetes version
49
##
50
kubeVersion: ""
51
## @param apiVersions Override Kubernetes API versions reported by .Capabilities
52
##
53
apiVersions: []
54
## @param nameOverride String to partially override common.names.name
55
##
56
nameOverride: ""
57
## @param fullnameOverride String to fully override common.names.fullname
58
##
59
fullnameOverride: ""
60
## @param namespaceOverride String to fully override common.names.namespace
61
##
62
namespaceOverride: ""
63
## @param commonLabels Labels to add to all deployed objects
64
##
65
commonLabels: {}
66
## @param commonAnnotations Annotations to add to all deployed objects
67
##
68
commonAnnotations: {}
69
## @param clusterDomain Kubernetes cluster domain name
70
##
71
clusterDomain: cluster.local
72
## @param extraDeploy Array of extra objects to deploy with the release
73
##
74
extraDeploy: []
75
## @param usePasswordFiles Mount credentials as files instead of using environment variables
76
##
77
usePasswordFiles: true
78
## Enable diagnostic mode in the deployment
79
##
80
diagnosticMode:
81
## @param diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden)
82
##
83
enabled: false
84
## @param diagnosticMode.command Command to override all containers in the deployment
85
##
86
command:
87
- sleep
88
## @param diagnosticMode.args Args to override all containers in the deployment
89
##
90
args:
91
- infinity
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
100
##
101
image:
102
registry: cgr.dev
103
repository: chainguard-private/apache-apisix-iamguarded
104
tag: 3.20.0
105
digest: ""
106
## Specify a imagePullPolicy
107
## ref: http://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
108
##
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/
113
## e.g:
114
## pullSecrets:
115
## - myRegistryKeySecretName
116
##
117
pullSecrets: []
118
## Enable debug mode
119
##
120
debug: false
121
## @section APISIX Data Plane parameters
122
##
123
dataPlane:
124
## @param dataPlane.enabled Enable APISIX Data Plane
125
##
126
enabled: true
127
## @param dataPlane.useDaemonSet Deploy Data Plane as DaemonSet
128
##
129
useDaemonSet: false
130
## @param dataPlane.replicaCount Number of APISIX Data Plane replicas to deploy
131
##
132
replicaCount: 1
133
## @param dataPlane.hostNetwork Use hostNetwork in APISIX Data Plane
134
##
135
hostNetwork: false
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
139
##
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
145
##
146
containerPorts:
147
http: 9080
148
https: 9443
149
control: 9090
150
metrics: 9099
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
159
##
160
livenessProbe:
161
enabled: true
162
initialDelaySeconds: 5
163
periodSeconds: 10
164
timeoutSeconds: 5
165
failureThreshold: 5
166
successThreshold: 1
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
173
##
174
readinessProbe:
175
enabled: true
176
initialDelaySeconds: 5
177
periodSeconds: 10
178
timeoutSeconds: 5
179
failureThreshold: 5
180
successThreshold: 1
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
187
##
188
startupProbe:
189
enabled: false
190
initialDelaySeconds: 5
191
periodSeconds: 10
192
timeoutSeconds: 5
193
failureThreshold: 5
194
successThreshold: 1
195
## @param dataPlane.customLivenessProbe Custom livenessProbe that overrides the default one
196
##
197
customLivenessProbe: {}
198
## @param dataPlane.customReadinessProbe Custom readinessProbe that overrides the default one
199
##
200
customReadinessProbe: {}
201
## @param dataPlane.customStartupProbe Custom startupProbe that overrides the default one
202
##
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).
207
##
208
resourcesPreset: "nano"
209
## @param dataPlane.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
210
## Example:
211
## resources:
212
## requests:
213
## cpu: 2
214
## memory: 512Mi
215
## limits:
216
## cpu: 3
217
## memory: 1024Mi
218
##
219
resources: {}
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
227
##
228
podSecurityContext:
229
enabled: true
230
fsGroupChangePolicy: Always
231
sysctls: []
232
supplementalGroups: []
233
fsGroup: 1001
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
246
##
247
containerSecurityContext:
248
enabled: true
249
seLinuxOptions: {}
250
runAsUser: 1001
251
runAsGroup: 1001
252
runAsNonRoot: true
253
privileged: false
254
readOnlyRootFilesystem: true
255
allowPrivilegeEscalation: false
256
capabilities:
257
drop: ["ALL"]
258
seccompProfile:
259
type: RuntimeDefault
260
## @param dataPlane.command Override default container command (useful when using custom images)
261
##
262
command: []
263
## @param dataPlane.args Override default container args (useful when using custom images)
264
##
265
args: []
266
## @param dataPlane.automountServiceAccountToken Mount Service Account token in pod
267
##
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/
271
##
272
hostAliases: []
273
## @param dataPlane.defaultConfig [string] APISIX Data Plane configuration (evaluated as a template)
274
##
275
defaultConfig: |
276
{{- if .Values.dataPlane.metrics.enabled }}
277
plugin_attr:
278
prometheus:
279
export_uri: /apisix/prometheus/metrics
280
metric_prefix: apisix_
281
enable_export_server: true
282
export_addr:
283
ip: 0.0.0.0
284
port: {{ .Values.dataPlane.containerPorts.metrics }}
285
{{- end }}
286
apisix:
287
node_listen: {{ .Values.dataPlane.containerPorts.http }}
288
enable_admin: false
289
{{- if .Values.dataPlane.tls.enabled }}
290
ssl:
291
enable: true
292
listen:
293
- port: {{ .Values.dataPlane.containerPorts.https }}
294
ssl_trusted_certificate: /iamguarded/certs/{{ .Values.dataPlane.tls.certCAFilename }}
295
enable_http2: true
296
{{- end }}
297
control:
298
ip: 0.0.0.0
299
port: {{ .Values.dataPlane.containerPorts.control }}
300
nginx_config:
301
error_log: /dev/stderr
302
stream:
303
access_log: /dev/stdout
304
http:
305
access_log: /dev/stdout
306
http_configuration_snippet: |
307
proxy_buffering off;
308
deployment:
309
role: data_plane
310
role_data_plane:
311
config_provider: etcd
312
{{- if .Values.controlPlane.enabled }}
313
control_plane:
314
host:
315
- {{ ternary "https" "http" .Values.controlPlane.tls.enabled }}://{{ include "apisix.control-plane.fullname" . }}:{{ .Values.controlPlane.service.ports.configServer }}
316
prefix: /apisix
317
timeout: 30
318
{{- end }}
319
{{- if or .Values.etcd.enabled .Values.externalEtcd.servers }}
320
etcd:
321
host:
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" $ ) }}
326
{{- end }}
327
{{- else }}
328
{{- range $node := .Values.externalEtcd.servers }}
329
- {{ ternary "https" "http" $.Values.externalEtcd.secureTransport }}://{{ printf "%s:%v" $node (include "apisix.etcd.port" $) }}
330
{{- end }}
331
{{- end }}
332
prefix: /apisix
333
timeout: 30
334
use_grpc: false
335
startup_retry: 60
336
{{- if (include "apisix.etcd.authEnabled" .) }}
337
user: "{{ print "{{APISIX_ETCD_USER}}" }}"
338
password: "{{ print "{{APISIX_ETCD_PASSWORD}}" }}"
339
{{- end }}
340
{{- end }}
341
{{- if .Values.dataPlane.tls.enabled }}
342
certs:
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 }}
348
{{- end }}
349
{{- end }}
350
{{- end }}
351
discovery:
352
kubernetes:
353
service:
354
# apiserver schema, options [http, https]
355
schema: https #default https
356
357
# apiserver host, options [ipv4, ipv6, domain, environment variable]
358
host: ${KUBERNETES_SERVICE_HOST} #default ${KUBERNETES_SERVICE_HOST}
359
360
# apiserver port, options [port number, environment variable]
361
port: ${KUBERNETES_SERVICE_PORT} #default ${KUBERNETES_SERVICE_PORT}
362
363
client:
364
# serviceaccount token or token_file
365
token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
366
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
369
##
370
extraConfig: {}
371
## @param dataPlane.existingConfigMap name of a ConfigMap with existing configuration for APISIX Data Plane
372
##
373
existingConfigMap: ""
374
## @param dataPlane.extraConfigExistingConfigMap name of a ConfigMap with existing configuration for APISIX Data Plane
375
##
376
extraConfigExistingConfigMap: ""
377
tls:
378
## @param dataPlane.tls.enabled Enable TLS transport in APISIX Data Plane
379
##
380
enabled: true
381
## @param dataPlane.tls.autoGenerated Auto-generate self-signed certificates
382
##
383
autoGenerated: true
384
## @param dataPlane.tls.existingSecret Name of a secret containing the certificates
385
##
386
existingSecret: ""
387
## @param dataPlane.tls.certFilename Path of the certificate file when mounted as a secret
388
##
389
certFilename: tls.crt
390
## @param dataPlane.tls.certKeyFilename Path of the certificate key file when mounted as a secret
391
##
392
certKeyFilename: tls.key
393
## @param dataPlane.tls.certCAFilename Path of the certificate CA file when mounted as a secret
394
##
395
certCAFilename: ca.crt
396
## @param dataPlane.tls.cert Content of the certificate to be added to the secret
397
##
398
cert: ""
399
## @param dataPlane.tls.key Content of the certificate key to be added to the secret
400
##
401
key: ""
402
## @param dataPlane.tls.ca Content of the certificate CA to be added to the secret
403
##
404
ca: ""
405
## @param dataPlane.podLabels Extra labels for APISIX Data Plane pods
406
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
407
##
408
podLabels: {}
409
## @param dataPlane.podAnnotations Annotations for APISIX Data Plane pods
410
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
411
##
412
podAnnotations: {}
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
415
##
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
419
##
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
426
##
427
pdb:
428
create: true
429
minAvailable: ""
430
maxUnavailable: ""
431
## Node apisix.affinity preset
432
## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
433
##
434
nodeAffinityPreset:
435
## @param dataPlane.nodeAffinityPreset.type Node affinity preset type. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
436
##
437
type: ""
438
## @param dataPlane.nodeAffinityPreset.key Node label key to match. Ignored if `apisix.affinity` is set
439
##
440
key: ""
441
## @param dataPlane.nodeAffinityPreset.values Node label values to match. Ignored if `apisix.affinity` is set
442
## E.g.
443
## values:
444
## - e2e-az1
445
## - e2e-az2
446
##
447
values: []
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
451
##
452
affinity: {}
453
## @param dataPlane.nodeSelector Node labels for APISIX Data Plane pods assignment
454
## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
455
##
456
nodeSelector: {}
457
## @param dataPlane.tolerations Tolerations for APISIX Data Plane pods assignment
458
## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
459
##
460
tolerations: []
461
## @param dataPlane.updateStrategy.type APISIX Data Plane statefulset strategy type
462
## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
463
##
464
updateStrategy:
465
## StrategyType
466
## Can be set to RollingUpdate or OnDelete
467
##
468
type: RollingUpdate
469
## @param dataPlane.priorityClassName APISIX Data Plane pods' priorityClassName
470
##
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
474
##
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/
478
##
479
schedulerName: ""
480
## @param dataPlane.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully
481
## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
482
##
483
terminationGracePeriodSeconds: ""
484
## @param dataPlane.lifecycleHooks for the APISIX Data Plane container(s) to automate configuration before or after startup
485
##
486
lifecycleHooks: {}
487
## @param dataPlane.extraEnvVars Array with extra environment variables to add to APISIX Data Plane nodes
488
## e.g:
489
## extraEnvVars:
490
## - name: FOO
491
## value: "bar"
492
##
493
extraEnvVars: []
494
## @param dataPlane.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for APISIX Data Plane nodes
495
##
496
extraEnvVarsCM: ""
497
## @param dataPlane.extraEnvVarsSecret Name of existing Secret containing extra env vars for APISIX Data Plane nodes
498
##
499
extraEnvVarsSecret: ""
500
## @param dataPlane.extraVolumes Optionally specify extra list of additional volumes for the APISIX Data Plane pod(s)
501
##
502
extraVolumes: []
503
## @param dataPlane.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the APISIX Data Plane container(s)
504
##
505
extraVolumeMounts: []
506
## @param dataPlane.sidecars Add additional sidecar containers to the APISIX Data Plane pod(s)
507
## e.g:
508
## sidecars:
509
## - name: your-image-name
510
## image: your-image
511
## imagePullPolicy: Always
512
## ports:
513
## - name: portname
514
## containerPort: 1234
515
##
516
sidecars: []
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/
519
## e.g:
520
## initContainers:
521
## - name: your-image-name
522
## image: your-image
523
## imagePullPolicy: Always
524
## command: ['sh', '-c', 'echo "hello world"']
525
##
526
initContainers: []
527
## @section APISIX Data Plane Traffic Exposure Parameters
528
##
529
service:
530
## @param dataPlane.service.type APISIX Data Plane service type
531
##
532
type: LoadBalancer
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
536
##
537
ports:
538
http: 80
539
https: 443
540
metrics: 8080
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>
546
##
547
nodePorts:
548
http: ""
549
https: ""
550
metrics: ""
551
## @param dataPlane.service.clusterIP APISIX Data Plane service Cluster IP
552
## e.g.:
553
## clusterIP: None
554
##
555
clusterIP: ""
556
## @param dataPlane.service.loadBalancerIP APISIX Data Plane service Load Balancer IP
557
## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
558
##
559
loadBalancerIP: ""
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
562
## e.g:
563
## loadBalancerSourceRanges:
564
## - 10.10.10.0/24
565
##
566
loadBalancerSourceRanges: []
567
## @param dataPlane.service.externalIPs APISIX Data Plane service External IPs
568
## https://kubernetes.io/docs/concepts/services-networking/service/#external-ips
569
## e.g.
570
## externalIPs:
571
## - 10.10.10.1
572
## - 201.22.30.1
573
##
574
externalIPs: []
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
577
##
578
externalTrafficPolicy: Cluster
579
## @param dataPlane.service.annotations Additional custom annotations for APISIX Data Plane service
580
##
581
annotations: {}
582
## @param dataPlane.service.extraPorts Extra ports to expose in APISIX Data Plane service (normally used with the `sidecars` value)
583
##
584
extraPorts: []
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/
588
##
589
sessionAffinity: None
590
## @param dataPlane.service.sessionAffinityConfig Additional settings for the sessionAffinity
591
## sessionAffinityConfig:
592
## webIP:
593
## timeoutSeconds: 300
594
##
595
sessionAffinityConfig: {}
596
## Network Policies
597
## Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
598
##
599
networkPolicy:
600
## @param dataPlane.networkPolicy.enabled Specifies whether a NetworkPolicy should be created
601
##
602
enabled: true
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).
608
##
609
allowExternal: true
610
## @param dataPlane.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
611
##
612
allowExternalEgress: true
613
## @param dataPlane.networkPolicy.kubeAPIServerPorts [array] List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)
614
##
615
kubeAPIServerPorts: [443, 6443, 8443]
616
## @param dataPlane.networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
617
## e.g:
618
## extraIngress:
619
## - ports:
620
## - port: 1234
621
## from:
622
## - podSelector:
623
## - matchLabels:
624
## - role: frontend
625
## - podSelector:
626
## - matchExpressions:
627
## - key: role
628
## operator: In
629
## values:
630
## - frontend
631
extraIngress: []
632
## @param dataPlane.networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)
633
## e.g:
634
## extraEgress:
635
## - ports:
636
## - port: 1234
637
## to:
638
## - podSelector:
639
## - matchLabels:
640
## - role: frontend
641
## - podSelector:
642
## - matchExpressions:
643
## - key: role
644
## operator: In
645
## values:
646
## - frontend
647
##
648
extraEgress: []
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
651
##
652
ingressNSMatchLabels: {}
653
ingressNSPodMatchLabels: {}
654
## ref: http://kubernetes.io/docs/concepts/services-networking/ingress/
655
##
656
ingress:
657
## @param dataPlane.ingress.enabled Enable ingress record generation for APISIX Data Plane
658
##
659
enabled: false
660
## @param dataPlane.ingress.pathType Ingress path type
661
##
662
pathType: ImplementationSpecific
663
## @param dataPlane.ingress.apiVersion Force Ingress API version (automatically detected if not set)
664
##
665
apiVersion: ""
666
## @param dataPlane.ingress.hostname Default host for the ingress record
667
##
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/
672
##
673
ingressClassName: ""
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
676
##
677
path: /
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
681
## e.g:
682
## annotations:
683
## kubernetes.io/ingress.class: nginx
684
## cert-manager.io/cluster-issuer: cluster-issuer-name
685
##
686
annotations: {}
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 }}`
689
## You can:
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`
693
##
694
tls: false
695
## @param dataPlane.ingress.selfSigned Create a TLS secret for this ingress record using self-signed certificates generated by Helm
696
##
697
selfSigned: false
698
## @param dataPlane.ingress.extraHosts An array with additional hostname(s) to be covered with the ingress record
699
## e.g:
700
## extraHosts:
701
## - name: apisix.local
702
## path: /
703
##
704
extraHosts: []
705
## @param dataPlane.ingress.extraPaths An array with additional arbitrary paths that may need to be added to the ingress under the main host
706
## e.g:
707
## extraPaths:
708
## - path: /*
709
## backend:
710
## serviceName: ssl-redirect
711
## servicePort: use-annotation
712
##
713
extraPaths: []
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
716
## e.g:
717
## extraTls:
718
## - hosts:
719
## - apisix.local
720
## secretName: apisix.local-tls
721
##
722
extraTls: []
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
730
## e.g:
731
## secrets:
732
## - name: apisix.local-tls
733
## key: |-
734
## -----BEGIN RSA PRIVATE KEY-----
735
## ...
736
## -----END RSA PRIVATE KEY-----
737
## certificate: |-
738
## -----BEGIN CERTIFICATE-----
739
## ...
740
## -----END CERTIFICATE-----
741
##
742
secrets: []
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
745
## e.g:
746
## extraRules:
747
## - host: example.local
748
## http:
749
## path: /
750
## backend:
751
## service:
752
## name: example-svc
753
## port:
754
## name: http
755
##
756
extraRules: []
757
## @section APISIX Data Plane Autoscaling configuration
758
## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
759
##
760
autoscaling:
761
vpa:
762
## @param dataPlane.autoscaling.vpa.enabled Enable VPA
763
##
764
enabled: false
765
## @param dataPlane.autoscaling.vpa.annotations Annotations for VPA resource
766
##
767
annotations: {}
768
## @param dataPlane.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
769
##
770
controlledResources: []
771
## @param dataPlane.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
772
## cpu: 200m
773
## memory: 100Mi
774
maxAllowed: {}
775
## @param dataPlane.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
776
## cpu: 200m
777
## memory: 100Mi
778
minAllowed: {}
779
updatePolicy:
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".
782
##
783
updateMode: Auto
784
hpa:
785
## @param dataPlane.autoscaling.hpa.enabled Enable HPA for APISIX Data Plane
786
##
787
enabled: false
788
## @param dataPlane.autoscaling.hpa.minReplicas Minimum number of APISIX Data Plane replicas
789
##
790
minReplicas: ""
791
## @param dataPlane.autoscaling.hpa.maxReplicas Maximum number of APISIX Data Plane replicas
792
##
793
maxReplicas: ""
794
## @param dataPlane.autoscaling.hpa.targetCPU Target CPU utilization percentage
795
##
796
targetCPU: ""
797
## @param dataPlane.autoscaling.hpa.targetMemory Target Memory utilization percentage
798
##
799
targetMemory: ""
800
## @section APISIX Data Plane RBAC Parameters
801
##
802
803
## RBAC configuration
804
##
805
rbac:
806
## @param dataPlane.rbac.create Specifies whether RBAC resources should be created
807
##
808
create: true
809
## @param dataPlane.rbac.rules Custom RBAC rules to set
810
## e.g:
811
## rules:
812
## - apiGroups:
813
## - ""
814
## resources:
815
## - pods
816
## verbs:
817
## - get
818
## - list
819
##
820
rules: []
821
## ServiceAccount configuration
822
##
823
serviceAccount:
824
## @param dataPlane.serviceAccount.create Specifies whether a ServiceAccount should be created
825
##
826
create: true
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
829
##
830
name: ""
831
## @param dataPlane.serviceAccount.annotations Additional Service Account annotations (evaluated as a template)
832
##
833
annotations: {}
834
## @param dataPlane.serviceAccount.automountServiceAccountToken Automount service account token for the APISIX Data Plane service account
835
##
836
automountServiceAccountToken: false
837
## @section APISIX Data Plane Metrics Parameters
838
##
839
840
## Prometheus metrics
841
##
842
metrics:
843
## @param dataPlane.metrics.enabled Enable the export of Prometheus metrics
844
##
845
enabled: false
846
## @param dataPlane.metrics.annotations [object] Annotations for the APISIX Data Plane service in order to scrape metrics
847
annotations:
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
852
##
853
serviceMonitor:
854
## @param dataPlane.metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
855
##
856
enabled: false
857
## @param dataPlane.metrics.serviceMonitor.namespace Namespace in which Prometheus is running
858
##
859
namespace: ""
860
## @param dataPlane.metrics.serviceMonitor.annotations Additional custom annotations for the ServiceMonitor
861
##
862
annotations: {}
863
## @param dataPlane.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor
864
##
865
labels: {}
866
## @param dataPlane.metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in Prometheus
867
##
868
jobLabel: ""
869
## @param dataPlane.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels
870
##
871
honorLabels: false
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
874
## e.g:
875
## interval: 10s
876
##
877
interval: ""
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
880
## e.g:
881
## scrapeTimeout: 10s
882
##
883
scrapeTimeout: ""
884
## @param dataPlane.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics
885
##
886
metricRelabelings: []
887
## @param dataPlane.metrics.serviceMonitor.relabelings Specify general relabeling
888
##
889
relabelings: []
890
## @param dataPlane.metrics.serviceMonitor.selector Prometheus instance selector labels
891
## selector:
892
## prometheus: my-prometheus
893
##
894
selector: {}
895
## @section APISIX Control Plane Parameters
896
##
897
controlPlane:
898
## @param controlPlane.enabled Enable APISIX Control Plane
899
##
900
enabled: true
901
## @param controlPlane.replicaCount Number of APISIX Control Plane replicas to deploy
902
##
903
replicaCount: 1
904
## @param controlPlane.hostNetwork Use hostNetwork
905
##
906
hostNetwork: false
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
910
##
911
dnsPolicy: ClusterFirst
912
## @param controlPlane.useDaemonSet Deploy as DaemonSet
913
##
914
useDaemonSet: false
915
## @param controlPlane.dashboardEnabled Enable APISIX Control Plane to expose APISIX Dashboards
916
##
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
922
##
923
containerPorts:
924
adminAPI: 9180
925
configServer: 9280
926
control: 9090
927
metrics: 9099
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
936
##
937
livenessProbe:
938
enabled: true
939
initialDelaySeconds: 5
940
periodSeconds: 10
941
timeoutSeconds: 5
942
failureThreshold: 5
943
successThreshold: 1
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
950
##
951
readinessProbe:
952
enabled: true
953
initialDelaySeconds: 5
954
periodSeconds: 10
955
timeoutSeconds: 5
956
failureThreshold: 5
957
successThreshold: 1
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
964
##
965
startupProbe:
966
enabled: false
967
initialDelaySeconds: 5
968
periodSeconds: 10
969
timeoutSeconds: 5
970
failureThreshold: 5
971
successThreshold: 1
972
## @param controlPlane.customLivenessProbe Custom livenessProbe that overrides the default one
973
##
974
customLivenessProbe: {}
975
## @param controlPlane.customReadinessProbe Custom readinessProbe that overrides the default one
976
##
977
customReadinessProbe: {}
978
## @param controlPlane.customStartupProbe Custom startupProbe that overrides the default one
979
##
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).
984
##
985
resourcesPreset: "nano"
986
## @param controlPlane.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
987
## Example:
988
## resources:
989
## requests:
990
## cpu: 2
991
## memory: 512Mi
992
## limits:
993
## cpu: 3
994
## memory: 1024Mi
995
##
996
resources: {}
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
1004
##
1005
podSecurityContext:
1006
enabled: true
1007
fsGroupChangePolicy: Always
1008
sysctls: []
1009
supplementalGroups: []
1010
fsGroup: 1001
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
1023
##
1024
containerSecurityContext:
1025
enabled: true
1026
seLinuxOptions: {}
1027
runAsUser: 1001
1028
runAsGroup: 1001
1029
runAsNonRoot: true
1030
privileged: false
1031
readOnlyRootFilesystem: true
1032
allowPrivilegeEscalation: false
1033
capabilities:
1034
drop: ["ALL"]
1035
seccompProfile:
1036
type: RuntimeDefault
1037
## @param controlPlane.command Override default container command (useful when using custom images)
1038
##
1039
command: []
1040
## @param controlPlane.args Override default container args (useful when using custom images)
1041
##
1042
args: []
1043
## @param controlPlane.automountServiceAccountToken Mount Service Account token in pod
1044
##
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/
1048
##
1049
hostAliases: []
1050
## @param controlPlane.apiTokenAdmin Admin API Token for APISIX Control Plane
1051
##
1052
apiTokenAdmin: ""
1053
## @param controlPlane.apiTokenViewer Viewer API Token for APISIX Control Plane
1054
##
1055
apiTokenViewer: ""
1056
## @param controlPlane.existingSecret Name of a secret containing API Tokens for APISIX Control Plane
1057
##
1058
existingSecret: ""
1059
## @param controlPlane.existingSecretAdminTokenKey Key inside the secret containing the Admin API Tokens for APISIX Control Plane
1060
##
1061
existingSecretAdminTokenKey: ""
1062
## @param controlPlane.existingSecretViewerTokenKey Key inside the secret containing the Viewer API Tokens for APISIX Control Plane
1063
##
1064
existingSecretViewerTokenKey: ""
1065
## @param controlPlane.defaultConfig [string] APISIX Control Plane configuration (evaluated as a template)
1066
##
1067
defaultConfig: |
1068
{{- if .Values.controlPlane.metrics.enabled }}
1069
plugin_attr:
1070
prometheus:
1071
export_uri: /apisix/prometheus/metrics
1072
metric_prefix: apisix_
1073
enable_export_server: true
1074
export_addr:
1075
ip: 0.0.0.0
1076
port: {{ .Values.controlPlane.containerPorts.metrics }}
1077
{{- end }}
1078
nginx_config:
1079
error_log: /dev/stderr
1080
stream:
1081
access_log: /dev/stdout
1082
http:
1083
access_log: /dev/stdout
1084
http_configuration_snippet: |
1085
proxy_buffering off;
1086
apisix:
1087
control:
1088
ip: 0.0.0.0
1089
port: {{ .Values.controlPlane.containerPorts.control }}
1090
deployment:
1091
role: control_plane
1092
role_control_plane:
1093
config_provider: etcd
1094
conf_server:
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 }}
1098
etcd:
1099
host:
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 }}
1104
{{- else }}
1105
{{- range $node := .Values.externalEtcd.servers }}
1106
- {{ ternary "https" "http" $.Values.externalEtcd.secureTransport }}://{{ printf "%s:%v" $node (include "apisix.etcd.port" $) }}
1107
{{- end }}
1108
{{- end }}
1109
prefix: /apisix
1110
timeout: 30
1111
use_grpc: false
1112
startup_retry: 60
1113
{{- if (include "apisix.etcd.authEnabled" .) }}
1114
user: "{{ print "{{APISIX_ETCD_USER}}" }}"
1115
password: "{{ print "{{APISIX_ETCD_PASSWORD}}" }}"
1116
{{- end }}
1117
{{- if .Values.controlPlane.tls.enabled }}
1118
certs:
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 }}
1124
{{- end }}
1125
{{- end }}
1126
{{- end }}
1127
admin:
1128
{{- if .Values.controlPlane.tls.enabled }}
1129
https_admin: true
1130
admin_api_mtls:
1131
admin_ssl_cert: /iamguarded/certs/{{ .Values.controlPlane.tls.certFilename }}
1132
admin_ssl_cert_key: /iamguarded/certs/{{ .Values.controlPlane.tls.certKeyFilename }}
1133
{{- end }}
1134
allow_admin:
1135
- 0.0.0.0/0
1136
admin_key:
1137
- name: admin
1138
key: "{{ print "{{APISIX_ADMIN_API_TOKEN}}" }}"
1139
role: admin
1140
- name: viewer
1141
key: "{{ print "{{APISIX_VIEWER_API_TOKEN}}" }}"
1142
role: viewer
1143
admin_listen:
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 }}
1147
discovery:
1148
kubernetes:
1149
service:
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}
1155
client:
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
1160
##
1161
extraConfig: {}
1162
## @param controlPlane.existingConfigMap name of a ConfigMap with existing configuration for APISIX Control Plane
1163
##
1164
existingConfigMap: ""
1165
## @param controlPlane.extraConfigExistingConfigMap name of a ConfigMap with existing configuration for APISIX Control Plane
1166
##
1167
extraConfigExistingConfigMap: ""
1168
tls:
1169
## @param controlPlane.tls.enabled Enable TLS transport in APISIX Control Plane
1170
##
1171
enabled: true
1172
## @param controlPlane.tls.autoGenerated Auto-generate self-signed certificates
1173
##
1174
autoGenerated: true
1175
## @param controlPlane.tls.existingSecret Name of a secret containing the certificates
1176
##
1177
existingSecret: ""
1178
## @param controlPlane.tls.certFilename Path of the certificate file when mounted as a secret
1179
##
1180
certFilename: tls.crt
1181
## @param controlPlane.tls.certKeyFilename Path of the certificate key file when mounted as a secret
1182
##
1183
certKeyFilename: tls.key
1184
## @param controlPlane.tls.certCAFilename Path of the certificate CA file when mounted as a secret
1185
##
1186
certCAFilename: ca.crt
1187
## @param controlPlane.tls.cert Content of the certificate to be added to the secret
1188
##
1189
cert: ""
1190
## @param controlPlane.tls.key Content of the certificate key to be added to the secret
1191
##
1192
key: ""
1193
## @param controlPlane.tls.ca Content of the certificate CA to be added to the secret
1194
##
1195
ca: ""
1196
## @param controlPlane.podLabels Extra labels for APISIX Control Plane pods
1197
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1198
##
1199
podLabels: {}
1200
## @param controlPlane.podAnnotations Annotations for APISIX Control Plane pods
1201
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
1202
##
1203
podAnnotations: {}
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
1206
##
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
1210
##
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
1217
##
1218
pdb:
1219
create: true
1220
minAvailable: ""
1221
maxUnavailable: ""
1222
## Node apisix.affinity preset
1223
## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
1224
##
1225
nodeAffinityPreset:
1226
## @param controlPlane.nodeAffinityPreset.type Node affinity preset type. Ignored if `apisix.affinity` is set. Allowed values: `soft` or `hard`
1227
##
1228
type: ""
1229
## @param controlPlane.nodeAffinityPreset.key Node label key to match. Ignored if `apisix.affinity` is set
1230
##
1231
key: ""
1232
## @param controlPlane.nodeAffinityPreset.values Node label values to match. Ignored if `apisix.affinity` is set
1233
## E.g.
1234
## values:
1235
## - e2e-az1
1236
## - e2e-az2
1237
##
1238
values: []
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
1242
##
1243
affinity: {}
1244
## @param controlPlane.nodeSelector Node labels for APISIX Control Plane pods assignment
1245
## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
1246
##
1247
nodeSelector: {}
1248
## @param controlPlane.tolerations Tolerations for APISIX Control Plane pods assignment
1249
## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1250
##
1251
tolerations: []
1252
## @param controlPlane.updateStrategy.type APISIX Control Plane statefulset strategy type
1253
## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
1254
##
1255
updateStrategy:
1256
## StrategyType
1257
## Can be set to RollingUpdate or OnDelete
1258
##
1259
type: RollingUpdate
1260
## @param controlPlane.priorityClassName APISIX Control Plane pods' priorityClassName
1261
##
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
1265
##
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/
1269
##
1270
schedulerName: ""
1271
## @param controlPlane.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully
1272
## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
1273
##
1274
terminationGracePeriodSeconds: ""
1275
## @param controlPlane.lifecycleHooks for the APISIX Control Plane container(s) to automate configuration before or after startup
1276
##
1277
lifecycleHooks: {}
1278
## @param controlPlane.extraEnvVars Array with extra environment variables to add to APISIX Control Plane nodes
1279
## e.g:
1280
## extraEnvVars:
1281
## - name: FOO
1282
## value: "bar"
1283
##
1284
extraEnvVars: []
1285
## @param controlPlane.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for APISIX Control Plane nodes
1286
##
1287
extraEnvVarsCM: ""
1288
## @param controlPlane.extraEnvVarsSecret Name of existing Secret containing extra env vars for APISIX Control Plane nodes
1289
##
1290
extraEnvVarsSecret: ""
1291
## @param controlPlane.extraVolumes Optionally specify extra list of additional volumes for the APISIX Control Plane pod(s)
1292
##
1293
extraVolumes: []
1294
## @param controlPlane.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the APISIX Control Plane container(s)
1295
##
1296
extraVolumeMounts: []
1297
## @param controlPlane.sidecars Add additional sidecar containers to the APISIX Control Plane pod(s)
1298
## e.g:
1299
## sidecars:
1300
## - name: your-image-name
1301
## image: your-image
1302
## imagePullPolicy: Always
1303
## ports:
1304
## - name: portname
1305
## containerPort: 1234
1306
##
1307
sidecars: []
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/
1310
## e.g:
1311
## initContainers:
1312
## - name: your-image-name
1313
## image: your-image
1314
## imagePullPolicy: Always
1315
## command: ['sh', '-c', 'echo "hello world"']
1316
##
1317
initContainers: []
1318
## @section APISIX Control Plane Traffic Exposure Parameters
1319
##
1320
service:
1321
## @param controlPlane.service.type APISIX Control Plane service type
1322
##
1323
type: ClusterIP
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
1327
##
1328
ports:
1329
adminAPI: 9180
1330
configServer: 9280
1331
metrics: 8080
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>
1337
##
1338
nodePorts:
1339
adminAPI: ""
1340
configServer: ""
1341
metrics: ""
1342
## @param controlPlane.service.clusterIP APISIX Control Plane service Cluster IP
1343
## e.g.:
1344
## clusterIP: None
1345
##
1346
clusterIP: ""
1347
## @param controlPlane.service.loadBalancerIP APISIX Control Plane service Load Balancer IP
1348
## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
1349
##
1350
loadBalancerIP: ""
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
1353
## e.g:
1354
## loadBalancerSourceRanges:
1355
## - 10.10.10.0/24
1356
##
1357
loadBalancerSourceRanges: []
1358
## @param controlPlane.service.externalIPs APISIX Control Plane service External IPs
1359
## https://kubernetes.io/docs/concepts/services-networking/service/#external-ips
1360
## e.g.
1361
## externalIPs:
1362
## - 10.10.10.1
1363
## - 201.22.30.1
1364
##
1365
externalIPs: []
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
1368
##
1369
externalTrafficPolicy: Cluster
1370
## @param controlPlane.service.annotations Additional custom annotations for APISIX Control Plane service
1371
##
1372
annotations: {}
1373
## @param controlPlane.service.extraPorts Extra ports to expose in APISIX Control Plane service (normally used with the `sidecars` value)
1374
##
1375
extraPorts: []
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/
1379
##
1380
sessionAffinity: None
1381
## @param controlPlane.service.sessionAffinityConfig Additional settings for the sessionAffinity
1382
## sessionAffinityConfig:
1383
## webIP:
1384
## timeoutSeconds: 300
1385
##
1386
sessionAffinityConfig: {}
1387
## Network Policies
1388
## Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
1389
##
1390
networkPolicy:
1391
## @param controlPlane.networkPolicy.enabled Specifies whether a NetworkPolicy should be created
1392
##
1393
enabled: true
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).
1399
##
1400
allowExternal: true
1401
## @param controlPlane.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
1402
##
1403
allowExternalEgress: true
1404
## @param controlPlane.networkPolicy.kubeAPIServerPorts [array] List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)
1405
##
1406
kubeAPIServerPorts: [443, 6443, 8443]
1407
## @param controlPlane.networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
1408
## e.g:
1409
## extraIngress:
1410
## - ports:
1411
## - port: 1234
1412
## from:
1413
## - podSelector:
1414
## - matchLabels:
1415
## - role: frontend
1416
## - podSelector:
1417
## - matchExpressions:
1418
## - key: role
1419
## operator: In
1420
## values:
1421
## - frontend
1422
extraIngress: []
1423
## @param controlPlane.networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)
1424
## e.g:
1425
## extraEgress:
1426
## - ports:
1427
## - port: 1234
1428
## to:
1429
## - podSelector:
1430
## - matchLabels:
1431
## - role: frontend
1432
## - podSelector:
1433
## - matchExpressions:
1434
## - key: role
1435
## operator: In
1436
## values:
1437
## - frontend
1438
##
1439
extraEgress: []
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
1442
##
1443
ingressNSMatchLabels: {}
1444
ingressNSPodMatchLabels: {}
1445
## ref: http://kubernetes.io/docs/concepts/services-networking/ingress/
1446
##
1447
ingress:
1448
## @param controlPlane.ingress.enabled Enable ingress record generation for APISIX Control Plane
1449
##
1450
enabled: false
1451
## @param controlPlane.ingress.pathType Ingress path type
1452
##
1453
pathType: ImplementationSpecific
1454
## @param controlPlane.ingress.apiVersion Force Ingress API version (automatically detected if not set)
1455
##
1456
apiVersion: ""
1457
## @param controlPlane.ingress.hostname Default host for the ingress record
1458
##
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/
1463
##
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
1467
##
1468
path: /
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
1472
## e.g:
1473
## annotations:
1474
## kubernetes.io/ingress.class: nginx
1475
## cert-manager.io/cluster-issuer: cluster-issuer-name
1476
##
1477
annotations: {}
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 }}`
1480
## You can:
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`
1484
##
1485
tls: false
1486
## @param controlPlane.ingress.selfSigned Create a TLS secret for this ingress record using self-signed certificates generated by Helm
1487
##
1488
selfSigned: false
1489
## @param controlPlane.ingress.extraHosts An array with additional hostname(s) to be covered with the ingress record
1490
## e.g:
1491
## extraHosts:
1492
## - name: apisix.local
1493
## path: /
1494
##
1495
extraHosts: []
1496
## @param controlPlane.ingress.extraPaths An array with additional arbitrary paths that may need to be added to the ingress under the main host
1497
## e.g:
1498
## extraPaths:
1499
## - path: /*
1500
## backend:
1501
## serviceName: ssl-redirect
1502
## servicePort: use-annotation
1503
##
1504
extraPaths: []
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
1507
## e.g:
1508
## extraTls:
1509
## - hosts:
1510
## - apisix.local
1511
## secretName: apisix.local-tls
1512
##
1513
extraTls: []
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
1521
## e.g:
1522
## secrets:
1523
## - name: apisix.local-tls
1524
## key: |-
1525
## -----BEGIN RSA PRIVATE KEY-----
1526
## ...
1527
## -----END RSA PRIVATE KEY-----
1528
## certificate: |-
1529
## -----BEGIN CERTIFICATE-----
1530
## ...
1531
## -----END CERTIFICATE-----
1532
##
1533
secrets: []
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
1536
## e.g:
1537
## extraRules:
1538
## - host: example.local
1539
## http:
1540
## path: /
1541
## backend:
1542
## service:
1543
## name: example-svc
1544
## port:
1545
## name: http
1546
##
1547
extraRules: []
1548
## @section APISIX Control Plane Autoscaling configuration
1549
## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
1550
##
1551
autoscaling:
1552
vpa:
1553
## @param controlPlane.autoscaling.vpa.enabled Enable VPA
1554
##
1555
enabled: false
1556
## @param controlPlane.autoscaling.vpa.annotations Annotations for VPA resource
1557
##
1558
annotations: {}
1559
## @param controlPlane.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
1560
##
1561
controlledResources: []
1562
## @param controlPlane.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
1563
## cpu: 200m
1564
## memory: 100Mi
1565
maxAllowed: {}
1566
## @param controlPlane.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
1567
## cpu: 200m
1568
## memory: 100Mi
1569
minAllowed: {}
1570
updatePolicy:
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".
1573
##
1574
updateMode: Auto
1575
hpa:
1576
## @param controlPlane.autoscaling.hpa.enabled Enable HPA for APISIX Control Plane
1577
##
1578
enabled: false
1579
## @param controlPlane.autoscaling.hpa.minReplicas Minimum number of APISIX Control Plane replicas
1580
##
1581
minReplicas: ""
1582
## @param controlPlane.autoscaling.hpa.maxReplicas Maximum number of APISIX Control Plane replicas
1583
##
1584
maxReplicas: ""
1585
## @param controlPlane.autoscaling.hpa.targetCPU Target CPU utilization percentage
1586
##
1587
targetCPU: ""
1588
## @param controlPlane.autoscaling.hpa.targetMemory Target Memory utilization percentage
1589
##
1590
targetMemory: ""
1591
## @section APISIX Control Plane RBAC parameters
1592
##
1593
1594
## RBAC configuration
1595
##
1596
rbac:
1597
## @param controlPlane.rbac.create Specifies whether RBAC resources should be created
1598
##
1599
create: true
1600
## @param controlPlane.rbac.rules Custom RBAC rules to set
1601
## e.g:
1602
## rules:
1603
## - apiGroups:
1604
## - ""
1605
## resources:
1606
## - pods
1607
## verbs:
1608
## - get
1609
## - list
1610
##
1611
rules: []
1612
## ServiceAccount configuration
1613
##
1614
serviceAccount:
1615
## @param controlPlane.serviceAccount.create Specifies whether a ServiceAccount should be created
1616
##
1617
create: true
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
1620
##
1621
name: ""
1622
## @param controlPlane.serviceAccount.annotations Additional Service Account annotations (evaluated as a template)
1623
##
1624
annotations: {}
1625
## @param controlPlane.serviceAccount.automountServiceAccountToken Automount service account token for the APISIX Control Plane service account
1626
##
1627
automountServiceAccountToken: false
1628
## @section APISIX Control Plane Metrics Parameters
1629
##
1630
1631
## Prometheus metrics
1632
##
1633
metrics:
1634
## @param controlPlane.metrics.enabled Enable the export of Prometheus metrics
1635
##
1636
enabled: false
1637
## @param controlPlane.metrics.annotations [object] Annotations for the APISIX Control Plane service in order to scrape metrics
1638
annotations:
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
1643
##
1644
serviceMonitor:
1645
## @param controlPlane.metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
1646
##
1647
enabled: false
1648
## @param controlPlane.metrics.serviceMonitor.namespace Namespace in which Prometheus is running
1649
##
1650
namespace: ""
1651
## @param controlPlane.metrics.serviceMonitor.annotations Additional custom annotations for the ServiceMonitor
1652
##
1653
annotations: {}
1654
## @param controlPlane.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor
1655
##
1656
labels: {}
1657
## @param controlPlane.metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in Prometheus
1658
##
1659
jobLabel: ""
1660
## @param controlPlane.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels
1661
##
1662
honorLabels: false
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
1665
## e.g:
1666
## interval: 10s
1667
##
1668
interval: ""
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
1671
## e.g:
1672
## scrapeTimeout: 10s
1673
##
1674
scrapeTimeout: ""
1675
## @param controlPlane.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics
1676
##
1677
metricRelabelings: []
1678
## @param controlPlane.metrics.serviceMonitor.relabelings Specify general relabeling
1679
##
1680
relabelings: []
1681
## @param controlPlane.metrics.serviceMonitor.selector Prometheus instance selector labels
1682
## selector:
1683
## prometheus: my-prometheus
1684
##
1685
selector: {}
1686
## @section APISIX Ingress Controller Parameters
1687
##
1688
ingressController:
1689
## @param ingressController.enabled Enable APISIX Ingress Controller
1690
##
1691
enabled: true
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
1700
##
1701
image:
1702
registry: cgr.dev
1703
repository: chainguard-private/apisix-ingress-controller-iamguarded
1704
tag: 2.2.0
1705
digest: ""
1706
## Specify a imagePullPolicy
1707
## ref: http://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
1708
##
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/
1713
## e.g:
1714
## pullSecrets:
1715
## - myRegistryKeySecretName
1716
##
1717
pullSecrets: []
1718
## Enable debug mode
1719
##
1720
debug: false
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
1728
##
1729
adcServer:
1730
image:
1731
registry: cgr.dev
1732
repository: chainguard-private/adc-iamguarded
1733
tag: 0.31.0
1734
digest: ""
1735
pullPolicy: IfNotPresent
1736
logLevel: "info"
1737
## @param ingressController.replicaCount Number of APISIX Ingress Controller replicas to deploy
1738
##
1739
replicaCount: 1
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
1743
##
1744
containerPorts:
1745
http: 8080
1746
https: 8443
1747
probe: 8081
1748
## @param ingressController.gatewayProxy.create Create a GatewayProxy resource pointing to the APISIX control plane
1749
##
1750
gatewayProxy:
1751
create: true
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
1760
##
1761
livenessProbe:
1762
enabled: true
1763
initialDelaySeconds: 5
1764
periodSeconds: 10
1765
timeoutSeconds: 5
1766
failureThreshold: 5
1767
successThreshold: 1
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
1774
##
1775
readinessProbe:
1776
enabled: true
1777
initialDelaySeconds: 5
1778
periodSeconds: 10
1779
timeoutSeconds: 5
1780
failureThreshold: 5
1781
successThreshold: 1
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
1788
##
1789
startupProbe:
1790
enabled: false
1791
initialDelaySeconds: 5
1792
periodSeconds: 10
1793
timeoutSeconds: 5
1794
failureThreshold: 5
1795
successThreshold: 1
1796
## @param ingressController.customLivenessProbe Custom livenessProbe that overrides the default one
1797
##
1798
customLivenessProbe: {}
1799
## @param ingressController.customReadinessProbe Custom readinessProbe that overrides the default one
1800
##
1801
customReadinessProbe: {}
1802
## @param ingressController.customStartupProbe Custom startupProbe that overrides the default one
1803
##
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).
1808
##
1809
resourcesPreset: "nano"
1810
## @param ingressController.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
1811
## Example:
1812
## resources:
1813
## requests:
1814
## cpu: 2
1815
## memory: 512Mi
1816
## limits:
1817
## cpu: 3
1818
## memory: 1024Mi
1819
##
1820
resources: {}
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
1828
##
1829
podSecurityContext:
1830
enabled: true
1831
fsGroupChangePolicy: Always
1832
sysctls: []
1833
supplementalGroups: []
1834
fsGroup: 1001
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
1847
##
1848
containerSecurityContext:
1849
enabled: true
1850
seLinuxOptions: {}
1851
runAsUser: 1001
1852
runAsGroup: 1001
1853
runAsNonRoot: true
1854
privileged: false
1855
readOnlyRootFilesystem: true
1856
allowPrivilegeEscalation: false
1857
capabilities:
1858
drop: ["ALL"]
1859
seccompProfile:
1860
type: RuntimeDefault
1861
## @param ingressController.command Override default container command (useful when using custom images)
1862
##
1863
command: []
1864
## @param ingressController.args Override default container args (useful when using custom images)
1865
##
1866
args: []
1867
## @param ingressController.automountServiceAccountToken Mount Service Account token in pod
1868
##
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/
1872
##
1873
hostAliases: []
1874
## @param ingressController.podLabels Extra labels for APISIX Ingress Controller pods
1875
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
1876
##
1877
podLabels: {}
1878
## @param ingressController.podAnnotations Annotations for APISIX Ingress Controller pods
1879
## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
1880
##
1881
podAnnotations: {}
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
1884
##
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
1888
##
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
1895
##
1896
pdb:
1897
create: true
1898
minAvailable: ""
1899
maxUnavailable: ""
1900
## Node injector.affinity preset
1901
## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
1902
##
1903
nodeAffinityPreset:
1904
## @param ingressController.nodeAffinityPreset.type Node affinity preset type. Ignored if `injector.affinity` is set. Allowed values: `soft` or `hard`
1905
##
1906
type: ""
1907
## @param ingressController.nodeAffinityPreset.key Node label key to match. Ignored if `injector.affinity` is set
1908
##
1909
key: ""
1910
## @param ingressController.nodeAffinityPreset.values Node label values to match. Ignored if `injector.affinity` is set
1911
## E.g.
1912
## values:
1913
## - e2e-az1
1914
## - e2e-az2
1915
##
1916
values: []
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
1920
##
1921
affinity: {}
1922
## @param ingressController.nodeSelector Node labels for APISIX Ingress Controller pods assignment
1923
## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
1924
##
1925
nodeSelector: {}
1926
## @param ingressController.tolerations Tolerations for APISIX Ingress Controller pods assignment
1927
## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
1928
##
1929
tolerations: []
1930
## @param ingressController.updateStrategy.type APISIX Ingress Controller statefulset strategy type
1931
## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
1932
##
1933
updateStrategy:
1934
## StrategyType
1935
## Can be set to RollingUpdate or OnDelete
1936
##
1937
type: RollingUpdate
1938
## @param ingressController.priorityClassName APISIX Ingress Controller pods' priorityClassName
1939
##
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
1943
##
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/
1947
##
1948
schedulerName: ""
1949
## @param ingressController.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully
1950
## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
1951
##
1952
terminationGracePeriodSeconds: ""
1953
## @param ingressController.lifecycleHooks for the APISIX Ingress Controller container(s) to automate configuration before or after startup
1954
##
1955
lifecycleHooks: {}
1956
## @param ingressController.extraEnvVars Array with extra environment variables to add to APISIX Ingress Controller nodes
1957
## e.g:
1958
## extraEnvVars:
1959
## - name: FOO
1960
## value: "bar"
1961
##
1962
extraEnvVars: []
1963
## @param ingressController.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for APISIX Ingress Controller nodes
1964
##
1965
extraEnvVarsCM: ""
1966
## @param ingressController.extraEnvVarsSecret Name of existing Secret containing extra env vars for APISIX Ingress Controller nodes
1967
##
1968
extraEnvVarsSecret: ""
1969
## @param ingressController.extraVolumes Optionally specify extra list of additional volumes for the APISIX Ingress Controller pod(s)
1970
##
1971
extraVolumes: []
1972
## @param ingressController.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the APISIX Ingress Controller container(s)
1973
##
1974
extraVolumeMounts: []
1975
## @param ingressController.sidecars Add additional sidecar containers to the APISIX Ingress Controller pod(s)
1976
## e.g:
1977
## sidecars:
1978
## - name: your-image-name
1979
## image: your-image
1980
## imagePullPolicy: Always
1981
## ports:
1982
## - name: portname
1983
## containerPort: 1234
1984
##
1985
sidecars: []
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/
1988
## e.g:
1989
## initContainers:
1990
## - name: your-image-name
1991
## image: your-image
1992
## imagePullPolicy: Always
1993
## command: ['sh', '-c', 'echo "hello world"']
1994
##
1995
initContainers: []
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
1999
##
2000
ingressClass:
2001
create: true
2002
name: "apisix"
2003
annotations: {}
2004
## @param ingressController.defaultConfig [string] APISIX Ingress Controller configuration (evaluated as a template)
2005
##
2006
defaultConfig: |
2007
# log options
2008
log_level: "info"
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 }}"
2014
{{- end }}
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
2019
kubernetes:
2020
kubeconfig: ""
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: ""
2030
apisix:
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
2036
##
2037
extraConfig: {}
2038
## @param ingressController.existingConfigMap name of a ConfigMap with existing configuration for the APISIX Ingress Controller
2039
##
2040
existingConfigMap: ""
2041
## @param ingressController.extraConfigExistingConfigMap name of a ConfigMap with existing configuration for the APISIX Ingress Controller
2042
##
2043
extraConfigExistingConfigMap: ""
2044
tls:
2045
## @param ingressController.tls.enabled Enable TLS transport in APISIX Ingress Controller
2046
##
2047
enabled: true
2048
## @param ingressController.tls.autoGenerated Auto-generate self-signed certificates
2049
##
2050
autoGenerated: true
2051
## @param ingressController.tls.existingSecret Name of a secret containing the certificates
2052
##
2053
existingSecret: ""
2054
## @param ingressController.tls.certFilename Path of the certificate file when mounted as a secret
2055
##
2056
certFilename: tls.crt
2057
## @param ingressController.tls.certKeyFilename Path of the certificate key file when mounted as a secret
2058
##
2059
certKeyFilename: tls.key
2060
## @param ingressController.tls.certCAFilename Path of the certificate CA file when mounted as a secret
2061
##
2062
certCAFilename: ca.crt
2063
## @param ingressController.tls.cert Content of the certificate to be added to the secret
2064
##
2065
cert: ""
2066
## @param ingressController.tls.key Content of the certificate key to be added to the secret
2067
##
2068
key: ""
2069
## @param ingressController.tls.ca Content of the certificate CA to be added to the secret
2070
##
2071
ca: ""
2072
## @section APISIX Ingress Controller Traffic Exposure Parameters
2073
##
2074
service:
2075
## @param ingressController.service.type APISIX Ingress Controller service type
2076
##
2077
type: ClusterIP
2078
## @param ingressController.service.ports.http APISIX Ingress Controller service HTTP port
2079
## @param ingressController.service.ports.https APISIX Ingress Controller service HTTPS port
2080
##
2081
ports:
2082
http: 80
2083
https: 443
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>
2088
##
2089
nodePorts:
2090
http: ""
2091
https: ""
2092
## @param ingressController.service.clusterIP APISIX Ingress Controller service Cluster IP
2093
## e.g.:
2094
## clusterIP: None
2095
##
2096
clusterIP: ""
2097
## @param ingressController.service.loadBalancerIP APISIX Ingress Controller service Load Balancer IP
2098
## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
2099
##
2100
loadBalancerIP: ""
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
2103
## e.g:
2104
## loadBalancerSourceRanges:
2105
## - 10.10.10.0/24
2106
##
2107
loadBalancerSourceRanges: []
2108
## @param ingressController.service.externalIPs APISIX Ingress Controller service External IPs
2109
## https://kubernetes.io/docs/concepts/services-networking/service/#external-ips
2110
## e.g.
2111
## externalIPs:
2112
## - 10.10.10.1
2113
## - 201.22.30.1
2114
##
2115
externalIPs: []
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
2118
##
2119
externalTrafficPolicy: Cluster
2120
## @param ingressController.service.annotations Additional custom annotations for APISIX Ingress Controller service
2121
##
2122
annotations: {}
2123
## @param ingressController.service.extraPorts Extra ports to expose in APISIX Ingress Controller service (normally used with the `sidecars` value)
2124
##
2125
extraPorts: []
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/
2129
##
2130
sessionAffinity: None
2131
## @param ingressController.service.sessionAffinityConfig Additional settings for the sessionAffinity
2132
## sessionAffinityConfig:
2133
## webIP:
2134
## timeoutSeconds: 300
2135
##
2136
sessionAffinityConfig: {}
2137
## Network Policies
2138
## Ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
2139
##
2140
networkPolicy:
2141
## @param ingressController.networkPolicy.enabled Specifies whether a NetworkPolicy should be created
2142
##
2143
enabled: true
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).
2149
##
2150
allowExternal: true
2151
## @param ingressController.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
2152
##
2153
allowExternalEgress: true
2154
## @param ingressController.networkPolicy.kubeAPIServerPorts [array] List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)
2155
##
2156
kubeAPIServerPorts: [443, 6443, 8443]
2157
## @param ingressController.networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
2158
## e.g:
2159
## extraIngress:
2160
## - ports:
2161
## - port: 1234
2162
## from:
2163
## - podSelector:
2164
## - matchLabels:
2165
## - role: frontend
2166
## - podSelector:
2167
## - matchExpressions:
2168
## - key: role
2169
## operator: In
2170
## values:
2171
## - frontend
2172
extraIngress: []
2173
## @param ingressController.networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true)
2174
## e.g:
2175
## extraEgress:
2176
## - ports:
2177
## - port: 1234
2178
## to:
2179
## - podSelector:
2180
## - matchLabels:
2181
## - role: frontend
2182
## - podSelector:
2183
## - matchExpressions:
2184
## - key: role
2185
## operator: In
2186
## values:
2187
## - frontend
2188
##
2189
extraEgress: []
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
2192
##
2193
ingressNSMatchLabels: {}
2194
ingressNSPodMatchLabels: {}
2195
## ref: http://kubernetes.io/docs/concepts/services-networking/ingress/
2196
##
2197
ingress:
2198
## @param ingressController.ingress.enabled Enable ingress record generation for APISIX Ingress Controller
2199
##
2200
enabled: false
2201
## @param ingressController.ingress.pathType Ingress path type
2202
##
2203
pathType: ImplementationSpecific
2204
## @param ingressController.ingress.apiVersion Force Ingress API version (automatically detected if not set)
2205
##
2206
apiVersion: ""
2207
## @param ingressController.ingress.hostname Default host for the ingress record
2208
##
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/
2213
##
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
2217
##
2218
path: /
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
2222
## e.g:
2223
## annotations:
2224
## kubernetes.io/ingress.class: nginx
2225
## cert-manager.io/cluster-issuer: cluster-issuer-name
2226
##
2227
annotations: {}
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 }}`
2230
## You can:
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`
2234
##
2235
tls: false
2236
## @param ingressController.ingress.selfSigned Create a TLS secret for this ingress record using self-signed certificates generated by Helm
2237
##
2238
selfSigned: false
2239
## @param ingressController.ingress.extraHosts An array with additional hostname(s) to be covered with the ingress record
2240
## e.g:
2241
## extraHosts:
2242
## - name: apisix.local
2243
## path: /
2244
##
2245
extraHosts: []
2246
## @param ingressController.ingress.extraPaths An array with additional arbitrary paths that may need to be added to the ingress under the main host
2247
## e.g:
2248
## extraPaths:
2249
## - path: /*
2250
## backend:
2251
## serviceName: ssl-redirect
2252
## servicePort: use-annotation
2253
##
2254
extraPaths: []
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
2257
## e.g:
2258
## extraTls:
2259
## - hosts:
2260
## - apisix.local
2261
## secretName: apisix.local-tls
2262
##
2263
extraTls: []
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
2271
## e.g:
2272
## secrets:
2273
## - name: apisix.local-tls
2274
## key: |-
2275
## -----BEGIN RSA PRIVATE KEY-----
2276
## ...
2277
## -----END RSA PRIVATE KEY-----
2278
## certificate: |-
2279
## -----BEGIN CERTIFICATE-----
2280
## ...
2281
## -----END CERTIFICATE-----
2282
##
2283
secrets: []
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
2286
## e.g:
2287
## extraRules:
2288
## - host: example.local
2289
## http:
2290
## path: /
2291
## backend:
2292
## service:
2293
## name: example-svc
2294
## port:
2295
## name: http
2296
##
2297
extraRules: []
2298
## @section APISIX Ingress Controller Autoscaling configuration
2299
## ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
2300
##
2301
autoscaling:
2302
vpa:
2303
## @param ingressController.autoscaling.vpa.enabled Enable VPA
2304
##
2305
enabled: false
2306
## @param ingressController.autoscaling.vpa.annotations Annotations for VPA resource
2307
##
2308
annotations: {}
2309
## @param ingressController.autoscaling.vpa.controlledResources VPA List of resources that the vertical pod autoscaler can control. Defaults to cpu and memory
2310
##
2311
controlledResources: []
2312
## @param ingressController.autoscaling.vpa.maxAllowed VPA Max allowed resources for the pod
2313
## cpu: 200m
2314
## memory: 100Mi
2315
maxAllowed: {}
2316
## @param ingressController.autoscaling.vpa.minAllowed VPA Min allowed resources for the pod
2317
## cpu: 200m
2318
## memory: 100Mi
2319
minAllowed: {}
2320
updatePolicy:
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".
2323
##
2324
updateMode: Auto
2325
hpa:
2326
## @param ingressController.autoscaling.hpa.enabled Enable HPA for APISIX Ingress Controller
2327
##
2328
enabled: false
2329
## @param ingressController.autoscaling.hpa.minReplicas Minimum number of APISIX Ingress Controller replicas
2330
##
2331
minReplicas: ""
2332
## @param ingressController.autoscaling.hpa.maxReplicas Maximum number of APISIX Ingress Controller replicas
2333
##
2334
maxReplicas: ""
2335
## @param ingressController.autoscaling.hpa.targetCPU Target CPU utilization percentage
2336
##
2337
targetCPU: ""
2338
## @param ingressController.autoscaling.hpa.targetMemory Target Memory utilization percentage
2339
##
2340
targetMemory: ""
2341
## @section APISIX Ingress Controller RBAC Parameters
2342
##
2343
2344
## RBAC configuration
2345
##
2346
rbac:
2347
## @param ingressController.rbac.create Specifies whether RBAC resources should be created
2348
##
2349
create: true
2350
## @param ingressController.rbac.rules Custom RBAC rules to set
2351
## e.g:
2352
## rules:
2353
## - apiGroups:
2354
## - ""
2355
## resources:
2356
## - pods
2357
## verbs:
2358
## - get
2359
## - list
2360
##
2361
rules: []
2362
## ServiceAccount configuration
2363
##
2364
serviceAccount:
2365
## @param ingressController.serviceAccount.create Specifies whether a ServiceAccount should be created
2366
##
2367
create: true
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
2370
##
2371
name: ""
2372
## @param ingressController.serviceAccount.annotations Additional Service Account annotations (evaluated as a template)
2373
##
2374
annotations: {}
2375
## @param ingressController.serviceAccount.automountServiceAccountToken Automount service account token for the server service account
2376
##
2377
automountServiceAccountToken: false
2378
## Prometheus metrics
2379
##
2380
metrics:
2381
## @param ingressController.metrics.enabled Enable the export of Prometheus metrics
2382
##
2383
enabled: false
2384
## @param ingressController.metrics.annotations [object] Annotations for the APISIX Ingress Controller service in order to scrape metrics
2385
annotations:
2386
prometheus.io/scrape: "true"
2387
prometheus.io/port: "{{ .Values.ingressController.service.ports.http }}"
2388
## Prometheus Operator ServiceMonitor configuration
2389
##
2390
serviceMonitor:
2391
## @param ingressController.metrics.serviceMonitor.enabled if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
2392
##
2393
enabled: false
2394
## @param ingressController.metrics.serviceMonitor.namespace Namespace in which Prometheus is running
2395
##
2396
namespace: ""
2397
## @param ingressController.metrics.serviceMonitor.annotations Additional custom annotations for the ServiceMonitor
2398
##
2399
annotations: {}
2400
## @param ingressController.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor
2401
##
2402
labels: {}
2403
## @param ingressController.metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in Prometheus
2404
##
2405
jobLabel: ""
2406
## @param ingressController.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels
2407
##
2408
honorLabels: false
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
2411
## e.g:
2412
## interval: 10s
2413
##
2414
interval: ""
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
2417
## e.g:
2418
## scrapeTimeout: 10s
2419
##
2420
scrapeTimeout: ""
2421
## @param ingressController.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics
2422
##
2423
metricRelabelings: []
2424
## @param ingressController.metrics.serviceMonitor.relabelings Specify general relabeling
2425
##
2426
relabelings: []
2427
## @param ingressController.metrics.serviceMonitor.selector Prometheus instance selector labels
2428
## selector:
2429
## prometheus: my-prometheus
2430
##
2431
selector: {}
2432
## @section Init containers parameters
2433
##
2434
waitContainer:
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
2439
##
2440
image:
2441
registry: cgr.dev
2442
repository: chainguard-private/os-shell-iamguarded
2443
tag: 1.0.0
2444
digest: ""
2445
## @param waitContainer.image.pullPolicy Init container wait-container image pull policy
2446
##
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/
2452
## e.g:
2453
## pullSecrets:
2454
## - myRegistryKeySecretName
2455
##
2456
pullSecrets: []
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
2469
##
2470
containerSecurityContext:
2471
enabled: true
2472
seLinuxOptions: {}
2473
runAsUser: 1001
2474
runAsGroup: 1001
2475
runAsNonRoot: true
2476
privileged: false
2477
readOnlyRootFilesystem: true
2478
allowPrivilegeEscalation: false
2479
capabilities:
2480
drop: ["ALL"]
2481
seccompProfile:
2482
type: RuntimeDefault
2483
## @section External etcd settings
2484
##
2485
externalEtcd:
2486
## @param externalEtcd.servers List of hostnames of the external etcd
2487
##
2488
servers: []
2489
## @param externalEtcd.port Port of the external etcd instance
2490
##
2491
port: 2379
2492
## @param externalEtcd.user User of the external etcd instance
2493
##
2494
user: root
2495
## @param externalEtcd.password Password of the external etcd instance
2496
##
2497
password: ""
2498
## @param externalEtcd.existingSecret Name of a secret containing the external etcd password
2499
##
2500
existingSecret: ""
2501
## @param externalEtcd.existingSecretPasswordKey Key inside the secret containing the external etcd password
2502
##
2503
existingSecretPasswordKey: "etcd-root-password"
2504
## @param externalEtcd.secureTransport Use TLS for client-to-server communications
2505
##
2506
secureTransport: false
2507
## @section etcd sub-chart parameters
2508
##
2509
etcd:
2510
## @param etcd.enabled Deploy etcd sub-chart
2511
##
2512
enabled: true
2513
## @param etcd.replicaCount Number of etcd replicas
2514
##
2515
replicaCount: 3
2516
## @param etcd.containerPorts.client Container port for etcd
2517
##
2518
containerPorts:
2519
client: 2379
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
2523
##
2524
auth:
2525
rbac:
2526
## Currently the data_plane is not working with etcd credentials enabled. This should be
2527
## changed when this is fixed by APISIX
2528
create: false
2529
rootPassword: ""
2530
client:
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).
2533
##
2534
resourcesPreset: "micro"
2535
## @param etcd.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
2536
## Example:
2537
## resources:
2538
## requests:
2539
## cpu: 2
2540
## memory: 512Mi
2541
## limits:
2542
## cpu: 3
2543
## memory: 1024Mi
2544
##
2545
resources: {}
2546
image:
2547
registry: cgr.dev
2548
repository: chainguard-private/etcd-iamguarded
2549
tag: 3.7.3
2550
digest: ""
2551
## @section Gateway API parameters
2552
##
2553
## Gateway API configuration
2554
##
2555
gatewayApi:
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.
2559
##
2560
installCRDs: true
2561

The trusted source for open source

Talk to an expert
PrivacyTerms

Product

Chainguard ContainersChainguard LibrariesChainguard VMsChainguard OS PackagesChainguard ActionsChainguard Agent SkillsIntegrationsPricing
© 2026 Chainguard, Inc. All Rights Reserved.
Chainguard® and the Chainguard logo are registered trademarks of Chainguard, Inc. in the United States and/or other countries.
The other respective trademarks mentioned on this page are owned by the respective companies and use of them does not imply any affiliation or endorsement.