57 lines
4.6 KiB
Markdown
57 lines
4.6 KiB
Markdown
# Default Helm-Values
|
|
|
|
TrueCharts is primarily build to supply TrueNAS SCALE Apps.
|
|
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
|
|
|
|
Most of our Apps also consume our "common" Helm Chart.
|
|
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
|
|
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
|
|
|
|
## Values
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| controller.replicas | int | `1` | Number of desired pods |
|
|
| controller.revisionHistoryLimit | int | `3` | ReplicaSet revision history limit |
|
|
| controller.rollingUpdate.partition | string | `nil` | Set statefulset RollingUpdate partition |
|
|
| controller.rollingUpdate.surge | string | `nil` | Set deployment RollingUpdate max surge |
|
|
| controller.rollingUpdate.unavailable | int | `1` | Set deployment RollingUpdate max unavailable |
|
|
| controller.strategy | string | `"RollingUpdate"` | Set the controller upgrade strategy For Deployments, valid values are Recreate (default) and RollingUpdate. For StatefulSets, valid values are OnDelete and RollingUpdate (default). DaemonSets ignore this. |
|
|
| controller.type | string | `"statefulset"` | Set the controller type. Valid options are deployment, daemonset or statefulset |
|
|
| envTpl.REDIS_PORT | string | `"{{ .Values.service.main.ports.main.targetPort }}"` | |
|
|
| envValueFrom.REDIS_PASSWORD.secretKeyRef.key | string | `"redis-password"` | |
|
|
| envValueFrom.REDIS_PASSWORD.secretKeyRef.name | string | `"{{ ( tpl .Values.existingSecret $ ) | default ( include \"common.names.fullname\" . ) }}"` | |
|
|
| env[0].name | string | `"REDIS_REPLICATION_MODE"` | |
|
|
| env[0].value | string | `"master"` | |
|
|
| env[1].name | string | `"ALLOW_EMPTY_PASSWORD"` | |
|
|
| env[1].value | string | `"yes"` | |
|
|
| existingSecret | string | `""` | |
|
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
|
| image.repository | string | `"ghcr.io/truecharts/redis"` | |
|
|
| image.tag | string | `"v6.2.6@sha256:ff9e9a91c1a1d12b5d39660b66ef235535528883004af1d8dfd4047c2d9943a3"` | |
|
|
| persistence.redis-health | object | See below | redis-health configmap mount |
|
|
| persistence.redis-health.mountPath | string | `"/health"` | Where to mount the volume in the main container. Defaults to `/<name_of_the_volume>`, setting to '-' creates the volume but disables the volumeMount. |
|
|
| persistence.redis-health.readOnly | bool | `false` | Specify if the volume should be mounted read-only. |
|
|
| persistence.redis-health.volumeSpec | object | `{"configMap":{"defaultMode":493,"name":"redis-health"}}` | Define the custom Volume spec here [[ref]](https://kubernetes.io/docs/concepts/storage/volumes/) |
|
|
| podSecurityContext.runAsGroup | int | `0` | |
|
|
| probes | object | See below | [[ref]](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
|
|
| probes.liveness | object | See below | Liveness probe configuration |
|
|
| probes.liveness.custom | bool | `true` | Set this to `true` if you wish to specify your own livenessProbe |
|
|
| probes.liveness.enabled | bool | `true` | Enable the liveness probe |
|
|
| probes.liveness.spec | object | See below | The spec field contains the values for the default livenessProbe. If you selected `custom: true`, this field holds the definition of the livenessProbe. |
|
|
| probes.readiness | object | See below | Redainess probe configuration |
|
|
| probes.readiness.custom | bool | `true` | Set this to `true` if you wish to specify your own readinessProbe |
|
|
| probes.readiness.enabled | bool | `true` | Enable the readiness probe |
|
|
| probes.readiness.spec | object | See below | The spec field contains the values for the default readinessProbe. If you selected `custom: true`, this field holds the definition of the readinessProbe. |
|
|
| probes.startup | object | See below | Startup probe configuration |
|
|
| probes.startup.enabled | bool | `true` | Enable the startup probe |
|
|
| probes.startup.spec | object | See below | The spec field contains the values for the default livenessProbe. If you selected `custom: true`, this field holds the definition of the livenessProbe. |
|
|
| redisPassword | string | `"testpass"` | |
|
|
| securityContext.readOnlyRootFilesystem | bool | `false` | |
|
|
| service.main.ports.main.port | int | `6379` | |
|
|
| service.main.ports.main.targetPort | int | `6379` | |
|
|
| volumeClaimTemplates.data.enabled | bool | `true` | |
|
|
| volumeClaimTemplates.data.mountPath | string | `"/bitnami/redis"` | |
|
|
|
|
All Rights Reserved - The TrueCharts Project
|