1# This file has been modified by Chainguard, Inc.
3# Copyright Chainguard, Inc. All Rights Reserved.
4# Chainguard, Inc. modifications are subject to the license
5# available at: https://www.chainguard.dev/legal/software-license-agreement
7# Copyright Broadcom, Inc. All Rights Reserved.
8# SPDX-License-Identifier: APACHE-2.0
10## @section Global parameters
11## Global Docker image parameters
12## Please, note that this will override the image parameters, including dependencies, configured to use the global value
13## Current available global Docker image parameters: imageRegistry, imagePullSecrets and storageClass
16## @param global.imageRegistry Global Docker image registry
17## @param global.imagePullSecrets Global Docker registry secret names as an array
18## @param global.defaultStorageClass Global default StorageClass for Persistent Volume(s)
19## @param global.storageClass DEPRECATED: use global.defaultStorageClass instead
20## @param global.redis.password Redis® password (overrides `password`)
26 ## - myRegistryKeySecretName
29 defaultStorageClass: ""
31 ## Security parameters
34 ## @param global.security.allowInsecureImages Allows skipping image verification
35 allowInsecureImages: false
38 ## Compatibility adaptations for Kubernetes platforms
41 ## Compatibility adaptations for Openshift
44 ## @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)
46 adaptSecurityContext: auto
48## @section Redis(R) Cluster Common parameters
51## @param nameOverride String to partially override common.names.fullname template (will maintain the release name)
54## @param fullnameOverride String to fully override common.names.fullname template
57## @param namespaceOverride String to fully override common.names.namespace template
60## @param clusterDomain Kubernetes Cluster Domain
62clusterDomain: cluster.local
63## @param commonAnnotations Annotations to add to all deployed objects
66## @param commonLabels Labels to add to all deployed objects
69## @param extraDeploy Array of extra objects to deploy with the release (evaluated as a template)
72## Enable diagnostic mode in the deployment
75 ## @param diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden)
78 ## @param diagnosticMode.command Command to override all containers in the deployment
82 ## @param diagnosticMode.args Args to override all containers in the deployment
86## Iamguarded Redis® image version
87## ref: https://hub.docker.com/r/iamguarded/redis/tags/
88## @param image.registry [default: REGISTRY_NAME] Redis® cluster image registry
89## @param image.repository [default: REPOSITORY_NAME/redis-cluster] Redis® cluster image repository
90## @skip image.tag Redis® cluster image tag (immutable tags are recommended)
91## @param image.digest Redis® cluster image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
92## @param image.pullPolicy Redis® cluster image pull policy
93## @param image.pullSecrets Specify docker-registry secret names as an array
94## @param image.debug Enable image debug mode
98 repository: chainguard-private/redis-cluster-iamguarded
101 ## Specify a imagePullPolicy
102 ## ref: https://kubernetes.io/docs/concepts/containers/images/#pre-pulled-images
104 pullPolicy: IfNotPresent
105 ## Optionally specify an array of imagePullSecrets.
106 ## Secrets must be manually created in the namespace.
107 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
110 ## - myRegistryKeySecretName
116## Network Policy configuration
117## ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/
120 ## @param networkPolicy.enabled Enable creation of NetworkPolicy resources
123 ## @param networkPolicy.allowExternal The Policy model to apply
124 ## When set to false, only pods with the correct client label will have network access to the ports Redis(R) Cluster is
125 ## listening on. When true, Redis(R) Cluster will accept connections from any source (with the correct destination port).
128 ## @param networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations.
130 allowExternalEgress: true
131 ## @param networkPolicy.extraIngress [array] Add extra ingress rules to the NetworkPolicy
141 ## - matchExpressions:
148 ## @param networkPolicy.extraEgress [array] Add extra ingress rules to the NetworkPolicy
158 ## - matchExpressions:
165 ## @param networkPolicy.ingressNSMatchLabels [object] Labels to match to allow traffic from other namespaces
166 ## @param networkPolicy.ingressNSPodMatchLabels [object] Pod labels to match to allow traffic from other namespaces
168 ingressNSMatchLabels: {}
169 ingressNSPodMatchLabels: {}
171 ## @param serviceAccount.create Specifies whether a ServiceAccount should be created
174 ## @param serviceAccount.name The name of the ServiceAccount to create
175 ## If not set and create is true, a name is generated using the fullname template
178 ## @param serviceAccount.annotations Annotations for Cassandra Service Account
181 ## @param serviceAccount.automountServiceAccountToken Automount API credentials for a service account.
183 automountServiceAccountToken: false
185 ## @param rbac.create Specifies whether RBAC resources should be created
189 ## @param rbac.role.rules Rules to create. It follows the role specification
194 ## - podsecuritypolicies
198 ## - gce.unprivileged
201## Redis® pod Security Context
202## @param podSecurityContext.enabled Enable Redis® pod Security Context
203## @param podSecurityContext.fsGroupChangePolicy Set filesystem group change policy
204## @param podSecurityContext.supplementalGroups Set filesystem extra groups
205## @param podSecurityContext.fsGroup Group ID for the pods
206## @param podSecurityContext.sysctls Set namespaced sysctls for the pods
210 fsGroupChangePolicy: Always
211 supplementalGroups: []
213 ## Uncomment the setting below to increase the net.core.somaxconn value
216 ## - name: net.core.somaxconn
220## @param podDisruptionBudget DEPRECATED please use pdb instead
221## ref: https://kubernetes.io/docs/concepts/workloads/pods/disruptions
223podDisruptionBudget: {}
224## Pod Disruption Budget configuration
225## ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/
228 ## @param pdb.create Created a PodDisruptionBudget
231 ## @param pdb.minAvailable Min number of pods that must still be available after the eviction.
232 ## You can specify an integer or a percentage by setting the value to a string representation of a percentage (eg. "50%"). It will be disabled if set to 0
235 ## @param pdb.maxUnavailable Max number of pods that can be unavailable after the eviction.
236 ## You can specify an integer or a percentage by setting the value to a string representation of a percentage (eg. "50%"). It will be disabled if set to 0
239## Containers Security Context
240## @param containerSecurityContext.enabled Enabled containers' Security Context
241## @param containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
242## @param containerSecurityContext.runAsUser Set containers' Security Context runAsUser
243## @param containerSecurityContext.runAsGroup Set containers' Security Context runAsGroup
244## @param containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot
245## @param containerSecurityContext.privileged Set container's Security Context privileged
246## @param containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem
247## @param containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation
248## @param containerSecurityContext.capabilities.drop List of capabilities to be dropped
249## @param containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile
251containerSecurityContext:
258 readOnlyRootFilesystem: true
259 allowPrivilegeEscalation: false
263 type: "RuntimeDefault"
264## @param usePassword Use password authentication
267## @param password Redis® password (ignored if existingSecret set)
268## Defaults to a random 10-character alphanumeric string if not set and usePassword is true
269## ref: https://github.com/iamguarded/containers/tree/main/iamguarded/redis#setting-the-server-password-on-first-run
272## @param existingSecret Name of existing secret object (for password authentication)
275## @param existingSecretPasswordKey Name of key containing password to be retrieved from the existing secret
277existingSecretPasswordKey: ""
278## @param usePasswordFiles Mount passwords as files instead of environment variables
280usePasswordFiles: true
285 ## @param tls.enabled Enable TLS support for replication traffic
288 ## @param tls.authClients Require clients to authenticate or not
291 ## @param tls.autoGenerated Generate automatically self-signed TLS certificates
294 ## @param tls.existingSecret The name of the existing secret that contains the TLS certificates
297 ## @param tls.certificatesSecret DEPRECATED. Use tls.existingSecret instead
299 certificatesSecret: ""
300 ## @param tls.certFilename Certificate filename
303 ## @param tls.certKeyFilename Certificate key filename
306 ## @param tls.certCAFilename CA Certificate filename
309 ## @param tls.dhParamsFilename File containing DH params (in order to support DH based ciphers)
312## Redis® Service properties for standalone mode.
315 ## @param service.ports.redis Kubernetes Redis service port
319 ## Node ports to expose
320 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
321 ## @param service.nodePorts.redis Node port for Redis
325 ## @param service.extraPorts Extra ports to expose in the service (normally used with the `sidecar` value)
328 ## @param service.annotations Provide any additional annotations which may be required.
329 ## This can be used to set the LoadBalancer service type to internal only.
330 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer
333 ## @param service.labels Additional labels for redis service
336 ## @param service.type Service type for default redis service
337 ## Setting this to LoadBalancer may require corresponding service annotations for loadbalancer creation to succeed.
338 ## Currently supported types are ClusterIP (default) and LoadBalancer
341 ## @param service.clusterIP Service Cluster IP
346 ## @param service.loadBalancerIP Load balancer IP if `service.type` is `LoadBalancer`
347 ## If service.type is LoadBalancer, request a specific static IP address if supported by the cloud provider, otherwise leave blank
350 ## @param service.loadBalancerClass Load Balancer class if service type is `LoadBalancer` (optional, cloud specific)
351 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
353 loadBalancerClass: ""
354 ## @param service.loadBalancerSourceRanges Service Load Balancer sources
355 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
357 ## loadBalancerSourceRanges:
360 loadBalancerSourceRanges: []
361 ## @param service.externalTrafficPolicy Service external traffic policy
362 ## ref https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip
364 externalTrafficPolicy: Cluster
365 ## @param service.sessionAffinity Session Affinity for Kubernetes service, can be "None" or "ClientIP"
366 ## If "ClientIP", consecutive client requests will be directed to the same Pod
367 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
369 sessionAffinity: None
370 ## @param service.sessionAffinityConfig Additional settings for the sessionAffinity
371 ## sessionAffinityConfig:
373 ## timeoutSeconds: 300
375 sessionAffinityConfig: {}
376 ## Headless service properties
379 ## @param service.headless.annotations Annotations for the headless service.
382## Enable persistence using Persistent Volume Claims
383## ref: https://kubernetes.io/docs/concepts/storage/persistent-volumes/
386 ## @param persistence.enabled Enable persistence on Redis®
387 ## If enabled, nodes are using Persistent Volume Claims
388 ## If disabled, an emptyDir volume is used. This is not recommended.
389 ## ref: https://github.com/iamguarded/charts/tree/main/iamguarded/redis-cluster#persistence
392 ## @param persistence.path Path to mount the volume at, to use other images Redis® images.
394 path: /iamguarded/redis/data
395 ## @param persistence.subPath The subdirectory of the volume to mount to, useful in dev environments and one PV for multiple services
398 ## @param persistence.storageClass Storage class of backing PVC
399 ## If defined, storageClassName: <storageClass>
400 ## If set to "-", storageClassName: "", which disables dynamic provisioning
401 ## If undefined (the default) or set to null, no storageClassName spec is
402 ## set, choosing the default provisioner. (gp2 on AWS, standard on
403 ## GKE, AWS & OpenStack)
406 ## @param persistence.annotations Persistent Volume Claim annotations
409 ## @param persistence.labels Persistent Volume Claim labels
412 ## @param persistence.accessModes Persistent Volume Access Modes
416 ## @param persistence.size Size of data volume
419 ## @param persistence.matchLabels Persistent Volume selectors
420 ## https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector
423 ## @param persistence.matchExpressions matchExpressions Persistent Volume selectors
426## persistentVolumeClaimRetentionPolicy
427## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#persistentvolumeclaim-retention
428## @param persistentVolumeClaimRetentionPolicy.enabled Controls if and how PVCs are deleted during the lifecycle of a StatefulSet
429## @param persistentVolumeClaimRetentionPolicy.whenScaled Volume retention behavior when the replica count of the StatefulSet is reduced
430## @param persistentVolumeClaimRetentionPolicy.whenDeleted Volume retention behavior that applies when the StatefulSet is deleted
431persistentVolumeClaimRetentionPolicy:
435## Init containers parameters:
436## volumePermissions: Change the owner of the persist volume mountpoint to RunAsUser:fsGroup
439 ## @param volumePermissions.enabled Enable init container that changes volume permissions in the registry (for cases where the default k8s `runAsUser` and `fsUser` values do not work)
442 ## @param volumePermissions.image.registry [default: REGISTRY_NAME] Init container volume-permissions image registry
443 ## @param volumePermissions.image.repository [default: REPOSITORY_NAME/os-shell] Init container volume-permissions image repository
444 ## @skip volumePermissions.image.tag Init container volume-permissions image tag
445 ## @param volumePermissions.image.digest Init container volume-permissions image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
446 ## @param volumePermissions.image.pullPolicy Init container volume-permissions image pull policy
447 ## @param volumePermissions.image.pullSecrets Specify docker-registry secret names as an array
451 repository: chainguard-private/os-shell-iamguarded
454 pullPolicy: IfNotPresent
455 ## Optionally specify an array of imagePullSecrets.
456 ## Secrets must be manually created in the namespace.
457 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
460 ## - myRegistryKeySecretName
463 ## Containers Security Context
464 ## @param volumePermissions.containerSecurityContext.enabled Enable Containers' Security Context
465 ## @param volumePermissions.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
466 ## @param volumePermissions.containerSecurityContext.runAsUser User ID for the containers.
467 ## @param volumePermissions.containerSecurityContext.privileged Run container as privileged
469 containerSecurityContext:
474 ## Container resource requests and limits
475 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
476 ## @param volumePermissions.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if volumePermissions.resources is set (volumePermissions.resources is recommended for production).
477 ## More information: https://github.com/iamguarded/charts/blob/main/iamguarded/common/templates/_resources.tpl#L15
479 resourcesPreset: "nano"
480 ## @param volumePermissions.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
491## @param serviceBindings.enabled Create secret for service binding (Experimental)
492## Ref: https://servicebinding.io/service-provider/
496## PodSecurityPolicy configuration
497## ref: https://kubernetes.io/docs/concepts/policy/pod-security-policy/
498## @param podSecurityPolicy.create Whether to create a PodSecurityPolicy. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later
502## @section Redis® statefulset parameters
505 ## @param redis.command Redis® entrypoint string. The command `redis-server` is executed if this is not provided
508 ## @param redis.args Arguments for the provided command if needed
511 ## @param redis.updateStrategy.type Argo Workflows statefulset strategy type
512 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
516 ## Can be set to RollingUpdate or OnDelete
519 ## @param redis.updateStrategy.rollingUpdate.partition Partition update strategy
520 ## https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#partitions
524 ## @param redis.podManagementPolicy Statefulset Pod management policy, it needs to be Parallel to be able to complete the cluster join
525 ## Ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#pod-management-policies
527 podManagementPolicy: Parallel
528 ## @param redis.automountServiceAccountToken Mount Service Account token in pod
530 automountServiceAccountToken: false
531 ## @param redis.hostAliases Deployment pod host aliases
532 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
535 ## @param redis.hostNetwork Host networking requested for this pod. Use the host's network namespace.
536 ## https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podspec-v1-core
539 ## @param redis.useAOFPersistence Whether to use AOF Persistence mode or not
540 ## It is strongly recommended to use this type when dealing with clusters
541 ## ref: https://redis.io/topics/persistence#append-only-file
542 ## ref: https://redis.io/topics/cluster-tutorial#creating-and-using-a-redis-cluster
544 useAOFPersistence: "yes"
545 ## @param redis.containerPorts.redis Redis® port
546 ## @param redis.containerPorts.bus The busPort should be obtained adding 10000 to the redisPort. By default: 10000 + 6379 = 16379
551 ## @param redis.lifecycleHooks LifecycleHook to set additional configuration before or after startup. Evaluated as a template
554 ## @param redis.extraVolumes Extra volumes to add to the deployment
557 ## @param redis.extraVolumeMounts Extra volume mounts to add to the container
559 extraVolumeMounts: []
560 ## @param redis.customLivenessProbe Override default liveness probe
562 customLivenessProbe: {}
563 ## @param redis.customReadinessProbe Override default readiness probe
565 customReadinessProbe: {}
566 ## @param redis.customStartupProbe Custom startupProbe that overrides the default one
568 customStartupProbe: {}
569 ## @param redis.initContainers Extra init containers to add to the deployment
572 ## @param redis.sidecars Extra sidecar containers to add to the deployment
575 ## @param redis.podLabels Additional labels for Redis® pod
576 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
579 ## @param redis.priorityClassName Redis® Master pod priorityClassName
581 priorityClassName: ""
582 ## @param redis.defaultConfigOverride Optional default Redis® configuration for the nodes
583 ## If not set, the default Redis configuration from the chart is used
584 ## ref: https://redis.io/topics/config
586 defaultConfigOverride: ""
587 ## @param redis.configmap Additional Redis® configuration for the nodes
588 ## ref: https://redis.io/topics/config
591 ## @param redis.extraEnvVars An array to add extra environment variables
593 ## - name: BEARER_AUTH
597 ## @param redis.extraEnvVarsCM ConfigMap with extra environment variables
600 ## @param redis.extraEnvVarsSecret Secret with extra environment variables
602 extraEnvVarsSecret: ""
603 ## @param redis.podAnnotations Redis® additional annotations
604 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
607 ## Redis® resource requests and limits
608 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
609 ## @param redis.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if redis.resources is set (redis.resources is recommended for production).
610 ## More information: https://github.com/iamguarded/charts/blob/main/iamguarded/common/templates/_resources.tpl#L15
612 resourcesPreset: "nano"
613 ## @param redis.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
624 ## @param redis.schedulerName Use an alternate scheduler, e.g. "stork".
625 ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
628 ## @param redis.shareProcessNamespace Enable shared process namespace in a pod.
629 ## If set to false (default), each container will run in separate namespace, redis will have PID=1.
630 ## If set to true, the /pause will run as init process and will reap any zombie PIDs,
631 ## for example, generated by a custom exec probe running longer than a probe timeoutSeconds.
632 ## Enable this only if customLivenessProbe or customReadinessProbe is used and zombie PIDs are accumulating.
633 ## Ref: https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/
635 shareProcessNamespace: false
636 ## @param redis.terminationGracePeriodSeconds Set custom gracefull termination period for redis container.
637 ## If not set the kubernetes default will be applied.
638 ## Customize it based on your workload. Huge redis with high load may wants more than default time to dump
639 ## their data before complete termination.
640 ## Ref: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#hook-handler-execution
642 terminationGracePeriodSeconds: 30
643 ## Configure extra options for Redis® liveness probes
644 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)
645 ## @param redis.livenessProbe.enabled Enable livenessProbe
646 ## @param redis.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe
647 ## @param redis.livenessProbe.periodSeconds Period seconds for livenessProbe
648 ## @param redis.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe
649 ## @param redis.livenessProbe.failureThreshold Failure threshold for livenessProbe
650 ## @param redis.livenessProbe.successThreshold Success threshold for livenessProbe
654 initialDelaySeconds: 5
659 ## Configure extra options for Redis® readiness probes
660 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)
661 ## @param redis.readinessProbe.enabled Enable readinessProbe
662 ## @param redis.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe
663 ## @param redis.readinessProbe.periodSeconds Period seconds for readinessProbe
664 ## @param redis.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe
665 ## @param redis.readinessProbe.failureThreshold Failure threshold for readinessProbe
666 ## @param redis.readinessProbe.successThreshold Success threshold for readinessProbe
670 initialDelaySeconds: 5
675 ## @param redis.startupProbe.enabled Enable startupProbe
676 ## @param redis.startupProbe.path Path to check for startupProbe
677 ## @param redis.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe
678 ## @param redis.startupProbe.periodSeconds Period seconds for startupProbe
679 ## @param redis.startupProbe.timeoutSeconds Timeout seconds for startupProbe
680 ## @param redis.startupProbe.failureThreshold Failure threshold for startupProbe
681 ## @param redis.startupProbe.successThreshold Success threshold for startupProbe
686 initialDelaySeconds: 300
691 ## @param redis.podAffinityPreset Redis® pod affinity preset. Ignored if `redis.affinity` is set. Allowed values: `soft` or `hard`
692 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
694 podAffinityPreset: ""
695 ## @param redis.podAntiAffinityPreset Redis® pod anti-affinity preset. Ignored if `redis.affinity` is set. Allowed values: `soft` or `hard`
696 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
698 podAntiAffinityPreset: soft
699 ## Redis® node affinity preset
700 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
703 ## @param redis.nodeAffinityPreset.type Redis® node affinity preset type. Ignored if `redis.affinity` is set. Allowed values: `soft` or `hard`
706 ## @param redis.nodeAffinityPreset.key Redis® node label key to match Ignored if `redis.affinity` is set.
708 ## key: "kubernetes.io/e2e-az-name"
711 ## @param redis.nodeAffinityPreset.values Redis® node label values to match. Ignored if `redis.affinity` is set.
718 ## @param redis.affinity Affinity settings for Redis® pod assignment
719 ## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
720 ## Note: redis.podAffinityPreset, redis.podAntiAffinityPreset, and redis.nodeAffinityPreset will be ignored when it's set
723 ## @param redis.nodeSelector Node labels for Redis® pods assignment
724 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
727 ## @param redis.tolerations Tolerations for Redis® pods assignment
728 ## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
731 ## @param redis.topologySpreadConstraints Pod topology spread constraints for Redis® pod
732 ## https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
733 ## The value is evaluated as a template
735 topologySpreadConstraints: []
736## @section Cluster update job parameters
739## Cluster update job settings
742 ## @param updateJob.activeDeadlineSeconds Number of seconds the Job to create the cluster will be waiting for the Nodes to be ready.
744 activeDeadlineSeconds: 600
745 ## @param updateJob.command Container command (using container default if not set)
748 ## @param updateJob.args Container args (using container default if not set)
751 ## @param updateJob.automountServiceAccountToken Mount Service Account token in pod
753 automountServiceAccountToken: false
754 ## @param updateJob.hostAliases Deployment pod host aliases
755 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
758 ## @param updateJob.helmHook Job Helm hook
759 ## https://helm.sh/docs/topics/charts_hooks/#the-available-hooks
761 helmHook: post-upgrade
762 ## @param updateJob.annotations Job annotations
765 ## @param updateJob.podAnnotations Job pod annotations
768 ## @param updateJob.podLabels Pod extra labels
769 ## ref: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
772 ## @param updateJob.extraEnvVars An array to add extra environment variables
774 ## - name: BEARER_AUTH
778 ## @param updateJob.extraEnvVarsCM ConfigMap containing extra environment variables
781 ## @param updateJob.extraEnvVarsSecret Secret containing extra environment variables
783 extraEnvVarsSecret: ""
784 ## @param updateJob.extraVolumes Extra volumes to add to the deployment
787 ## @param updateJob.extraVolumeMounts Extra volume mounts to add to the container
789 extraVolumeMounts: []
790 ## @param updateJob.initContainers Extra init containers to add to the deployment
793 ## @param updateJob.podAffinityPreset Update job pod affinity preset. Ignored if `updateJob.affinity` is set. Allowed values: `soft` or `hard`
794 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
796 podAffinityPreset: ""
797 ## @param updateJob.podAntiAffinityPreset Update job pod anti-affinity preset. Ignored if `updateJob.affinity` is set. Allowed values: `soft` or `hard`
798 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity
800 podAntiAffinityPreset: soft
801 ## Update job node affinity preset
802 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
805 ## @param updateJob.nodeAffinityPreset.type Update job node affinity preset type. Ignored if `updateJob.affinity` is set. Allowed values: `soft` or `hard`
808 ## @param updateJob.nodeAffinityPreset.key Update job node label key to match Ignored if `updateJob.affinity` is set.
810 ## key: "kubernetes.io/e2e-az-name"
813 ## @param updateJob.nodeAffinityPreset.values Update job node label values to match. Ignored if `updateJob.affinity` is set.
820 ## @param updateJob.affinity Affinity for update job pods assignment
821 ## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
822 ## Note: updateJob.podAffinityPreset, updateJob.podAntiAffinityPreset, and updateJob.nodeAffinityPreset will be ignored when it's set
825 ## @param updateJob.nodeSelector Node labels for update job pods assignment
826 ## ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
829 ## @param updateJob.tolerations Tolerations for update job pods assignment
830 ## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
833 ## @param updateJob.priorityClassName Priority class name
835 priorityClassName: ""
836 ## Container resource requests and limits
837 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
838 ## We usually recommend not to specify default resources and to leave this as a conscious
839 ## choice for the user. This also increases chances charts run on environments with little
840 ## resources, such as Minikube. If you do want to specify resources, uncomment the following
841 ## lines, adjust them as necessary, and remove the curly braces after 'resources:'.
842 ## @param updateJob.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if updateJob.resources is set (updateJob.resources is recommended for production).
843 ## More information: https://github.com/iamguarded/charts/blob/main/iamguarded/common/templates/_resources.tpl#L15
845 resourcesPreset: "nano"
846 ## @param updateJob.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
857## @section Cluster management parameters
860## Redis(R) Cluster settings
863 ## @param cluster.init Enable the initialization of the Redis(R) Cluster
866 ## Number of Redis® nodes to be deployed
869 ## This is total number of nodes including the replicas. Meaning there will be 3 master and 3 replica
870 ## nodes (as replica count is set to 1 by default, there will be 1 replica per master node).
871 ## Hence, nodes = numberOfMasterNodes + numberOfMasterNodes * replicas
873 ## @param cluster.nodes The number of master nodes should always be >= 3, otherwise cluster creation will fail
876 ## @param cluster.replicas Number of replicas for every master in the cluster
877 ## Parameter to be passed as --cluster-replicas to the redis-cli --cluster create
878 ## 1 means that we want a replica for every master created
881 ## Configuration to access the Redis(R) Cluster from outside the Kubernetes cluster
884 ## @param cluster.externalAccess.enabled Enable access to the Redis
887 ## @param cluster.externalAccess.hostMode Set cluster preferred endpoint type as hostname
888 ## ref: https://github.com/redis/redis/pull/9530
892 ## @param cluster.externalAccess.service.disableLoadBalancerIP Disable use of `Service.spec.loadBalancerIP`
894 disableLoadBalancerIP: false
895 ## @param cluster.externalAccess.service.loadBalancerIPAnnotaion Name of annotation to specify fixed IP for service in. Disables `Service.spec.loadBalancerIP` if not empty
897 loadBalancerIPAnnotaion: ""
898 ## @param cluster.externalAccess.service.type Type for the services used to expose every Pod
899 ## At this moment only LoadBalancer is supported
902 ## @param cluster.externalAccess.service.port Port for the services used to expose every Pod
905 ## @param cluster.externalAccess.service.loadBalancerIP Array of load balancer IPs for each Redis® node. Length must be the same as cluster.nodes
908 ## @param cluster.externalAccess.service.loadBalancerClass Load Balancer class if service type is `LoadBalancer` (optional, cloud specific)
909 ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer
911 loadBalancerClass: ""
912 ## @param cluster.externalAccess.service.loadBalancerSourceRanges Service Load Balancer sources
913 ## ref: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/#restrict-access-for-loadbalancer-service
915 ## loadBalancerSourceRanges:
918 loadBalancerSourceRanges: []
919 ## @param cluster.externalAccess.service.annotations Annotations to add to the services used to expose every Pod of the Redis(R) Cluster
922 ## This section allows to update the Redis® cluster nodes.
925 ## @param cluster.update.addNodes Boolean to specify if you want to add nodes after the upgrade
926 ## Setting this to true a hook will add nodes to the Redis® cluster after the upgrade. currentNumberOfNodes and currentNumberOfReplicas is required
929 ## @param cluster.update.currentNumberOfNodes Number of currently deployed Redis® nodes
931 currentNumberOfNodes: 6
932 ## @param cluster.update.currentNumberOfReplicas Number of currently deployed Redis® replicas
934 currentNumberOfReplicas: 1
935 ## @param cluster.update.newExternalIPs External IPs obtained from the services for the new nodes to add to the cluster
938## @section Metrics sidecar parameters
941## Prometheus Exporter / Metrics
944 ## @param metrics.enabled Start a side-car prometheus exporter
947 ## @param metrics.image.registry [default: REGISTRY_NAME] Redis® exporter image registry
948 ## @param metrics.image.repository [default: REPOSITORY_NAME/redis-exporter] Redis® exporter image name
949 ## @skip metrics.image.tag Redis® exporter image tag
950 ## @param metrics.image.digest Redis® exporter image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
951 ## @param metrics.image.pullPolicy Redis® exporter image pull policy
952 ## @param metrics.image.pullSecrets Specify docker-registry secret names as an array
956 repository: chainguard-private/prometheus-redis-exporter-iamguarded
959 pullPolicy: IfNotPresent
960 ## Optionally specify an array of imagePullSecrets.
961 ## Secrets must be manually created in the namespace.
962 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
965 ## - myRegistryKeySecretName
968 ## @param metrics.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if metrics.resources is set (metrics.resources is recommended for production).
969 ## More information: https://github.com/iamguarded/charts/blob/main/iamguarded/common/templates/_resources.tpl#L15
971 resourcesPreset: "nano"
972 ## @param metrics.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)
981 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
984 ## @param metrics.extraArgs Extra arguments for the binary; possible values [here](https://github.com/oliver006/redis_exporter)
986 ## check-keys: myKey,myOtherKey
989 ## @param metrics.extraEnvVars Array with extra environment variables to add to Redis® exporter
996 ## @param metrics.containerPorts.http Metrics HTTP container port
1000 ## @param metrics.podAnnotations [object] Additional annotations for Metrics exporter pod
1003 prometheus.io/scrape: "true"
1004 prometheus.io/port: "9121"
1005 ## @param metrics.podLabels Additional labels for Metrics exporter pod
1008 ## Containers' Security Context - All fields other than `enabled` get added to the metrics container's security context
1009 ## @param metrics.containerSecurityContext.enabled Enabled containers' Security Context
1010 ## @param metrics.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1011 ## @param metrics.containerSecurityContext.runAsUser Set containers' Security Context runAsUser
1012 ## @param metrics.containerSecurityContext.runAsGroup Set containers' Security Context runAsGroup
1013 ## @param metrics.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot
1014 ## @param metrics.containerSecurityContext.privileged Set container's Security Context privileged
1015 ## @param metrics.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem
1016 ## @param metrics.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation
1017 ## @param metrics.containerSecurityContext.capabilities.drop List of capabilities to be dropped
1018 ## @param metrics.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile
1020 containerSecurityContext:
1027 readOnlyRootFilesystem: true
1028 allowPrivilegeEscalation: false
1032 type: "RuntimeDefault"
1033 ## Enable this if you're using https://github.com/coreos/prometheus-operator
1036 ## @param metrics.serviceMonitor.enabled If `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`)
1039 ## @param metrics.serviceMonitor.namespace Optional namespace which Prometheus is running in
1042 ## @param metrics.serviceMonitor.interval How frequently to scrape metrics (use by default, falling back to Prometheus' default)
1045 ## @param metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended
1046 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
1048 ## scrapeTimeout: 10s
1051 ## @param metrics.serviceMonitor.selector Prometheus instance selector labels
1052 ## ref: https://github.com/iamguarded/charts/tree/main/iamguarded/prometheus-operator#prometheus-configuration
1055 ## prometheus: my-prometheus
1058 ## @param metrics.serviceMonitor.labels ServiceMonitor extra labels
1061 ## @param metrics.serviceMonitor.annotations ServiceMonitor annotations
1064 ## @param metrics.serviceMonitor.jobLabel The name of the label on the target service to use as the job name in prometheus.
1067 ## @param metrics.serviceMonitor.relabelings RelabelConfigs to apply to samples before scraping
1068 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#relabelconfig
1071 ## @param metrics.serviceMonitor.metricRelabelings MetricRelabelConfigs to apply to samples before ingestion
1072 ## ref: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#relabelconfig
1074 metricRelabelings: []
1075 ## Custom PrometheusRule to be defined
1076 ## The value is evaluated as a template, so, for example, the value can depend on .Release or .Chart
1077 ## ref: https://github.com/coreos/prometheus-operator#customresourcedefinitions
1078 ## @param metrics.prometheusRule.enabled Set this to true to create prometheusRules for Prometheus operator
1079 ## @param metrics.prometheusRule.additionalLabels Additional labels that can be used so prometheusRules will be discovered by Prometheus
1080 ## @param metrics.prometheusRule.namespace namespace where prometheusRules resource should be created
1081 ## @param metrics.prometheusRule.rules Create specified [rules](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/), check values for an example.
1085 additionalLabels: {}
1087 ## These are just examples rules, please adapt them to your needs.
1088 ## Make sure to constraint the rules to the current postgresql service.
1089 ## - alert: RedisDown
1090 ## expr: redis_up{service="{{ template "common.names.fullname" . }}-metrics"} == 0
1095 ## summary: Redis® instance {{ "{{ $instance }}" }} down
1096 ## description: Redis® instance {{ "{{ $instance }}" }} is down.
1097 ## - alert: RedisMemoryHigh
1099 ## redis_memory_used_bytes{service="{{ template "common.names.fullname" . }}-metrics"} * 100
1101 ## redis_memory_max_bytes{service="{{ template "common.names.fullname" . }}-metrics"}
1107 ## summary: Redis® instance {{ "{{ $instance }}" }} is using too much memory
1108 ## description: Redis® instance {{ "{{ $instance }}" }} is using {{ "{{ $value }}" }}% of its available memory.
1109 ## - alert: RedisKeyEviction
1110 ## expr: increase(redis_evicted_keys_total{service="{{ template "common.names.fullname" . }}-metrics"}[5m]) > 0
1115 ## summary: Redis® instance {{ "{{ $instance }}" }} has evicted keys
1116 ## description: Redis® instance {{ "{{ $instance }}" }} has evicted {{ "{{ $value }}" }} keys in the last 5 minutes.
1119 ## @param metrics.priorityClassName Metrics exporter pod priorityClassName
1121 priorityClassName: ""
1122 ## @param metrics.service.type Kubernetes Service type (redis metrics)
1123 ## @param metrics.service.loadBalancerIP Use serviceLoadBalancerIP to request a specific static IP, otherwise leave blank
1124 ## @param metrics.service.loadBalancerClass Load Balancer class if service type is `LoadBalancer` (optional, cloud specific)
1125 ## @param metrics.service.annotations Annotations for the services to monitor.
1126 ## @param metrics.service.labels Additional labels for the metrics service
1131 ## @param metrics.service.ports.http Metrics HTTP service port
1134 ## @param metrics.service.ports.appProtocol Metrics service appProtocol
1137 ## @param metrics.service.clusterIP Service Cluster IP
1143 loadBalancerClass: ""
1146## @section Sysctl Image parameters
1149## Sysctl InitContainer
1150## Used to perform sysctl operation to modify Kernel settings (needed sometimes to avoid warnings)
1153 ## @param sysctlImage.enabled Enable an init container to modify Kernel settings
1156 ## @param sysctlImage.command sysctlImage command to execute
1159 ## @param sysctlImage.registry [default: REGISTRY_NAME] sysctlImage Init container registry
1160 ## @param sysctlImage.repository [default: REPOSITORY_NAME/os-shell] sysctlImage Init container repository
1161 ## @skip sysctlImage.tag sysctlImage Init container tag
1162 ## @param sysctlImage.digest sysctlImage Init container digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
1163 ## @param sysctlImage.pullPolicy sysctlImage Init container pull policy
1164 ## @param sysctlImage.pullSecrets Specify docker-registry secret names as an array
1167 repository: chainguard-private/os-shell-iamguarded
1170 pullPolicy: IfNotPresent
1171 ## Optionally specify an array of imagePullSecrets.
1172 ## Secrets must be manually created in the namespace.
1173 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
1176 ## - myRegistryKeySecretName
1179 ## @param sysctlImage.mountHostSys Mount the host `/sys` folder to `/host-sys`
1182 ## Containers Security Context
1183 ## @param sysctlImage.containerSecurityContext.enabled Enable Containers' Security Context
1184 ## @param sysctlImage.containerSecurityContext.seLinuxOptions [object,nullable] Set SELinux options in container
1185 ## @param sysctlImage.containerSecurityContext.runAsUser User ID for the containers.
1186 ## @param sysctlImage.containerSecurityContext.privileged Run privileged as privileged
1188 containerSecurityContext:
1193 ## Container resource requests and limits
1194 ## ref: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
1195 ## @param sysctlImage.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if sysctlImage.resources is set (sysctlImage.resources is recommended for production).
1196 ## More information: https://github.com/iamguarded/charts/blob/main/iamguarded/common/templates/_resources.tpl#L15
1198 resourcesPreset: "nano"
1199 ## @param sysctlImage.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads)