homarr¶
Generic helm chart for all kind of applications
Quick Links¶
Installing the Chart¶
Values¶
Search Values
Press Ctrl+K or Cmd+K to search, or use the interactive values search.
| Key | Type | Default | Description |
|---|---|---|---|
| AlertmanagerConfig Parameters | |||
enabled | bool | false | Deploy an AlertmanagerConfig (Prometheus Operator) resource. |
selectionLabels | object | `nil` | Labels to be picked up by Alertmanager to add it to base config. |
spec | object | `nil` | AlertmanagerConfig spec. |
route | object | `nil` | Route definition for alerts matching the resource’s namespace. |
receivers | list | [] | List of receivers. |
inhibitRules | list | [] | Inhibition rules that allows to mute alerts when other alerts are already firing. |
| Autoscaling - Horizontal Pod Autoscaling Parameters | |||
enabled | bool | false | Enable Horizontal Pod Autoscaling. |
additionalLabels | object | `nil` | Additional labels for HPA. |
annotations | object | `nil` | Annotations for HPA. |
minReplicas | int | 1 | Minimum number of replicas. |
maxReplicas | int | 10 | Maximum number of replicas. |
metrics | list | `nil` | Metrics used for autoscaling. |
| Backup Parameters | |||
enabled | bool | false | Deploy a [Velero/OADP Backup](https://velero.io/docs/main/api-types/backup/) resource. |
namespace | string | `{{ .Release.Namespace }}` | Namespace for Backup. |
additionalLabels | object | `nil` | Additional labels for Backup. |
annotations | object | `nil` | Annotations for Backup. |
defaultVolumesToRestic | bool | true | Whether to use Restic to take snapshots of all pod volumes by default. |
snapshotVolumes | bool | true | Whether to take snapshots of persistent volumes as part of the backup. |
storageLocation | string | `nil` | Name of the backup storage location where the backup should be stored. |
ttl | string | "1h0m0s" | How long the Backup should be retained for. |
includedResources | list | `nil` | List of resource types to include in the backup. |
excludedResources | list | `nil` | List of resource types to exclude from the backup. |
| ConfigMap Parameters | |||
enabled | bool | false | Deploy additional ConfigMaps. |
additionalLabels | object | `nil` | Additional labels for ConfigMaps. |
annotations | object | `nil` | Annotations for ConfigMaps. |
files | object | `nil` | List of ConfigMap entries. |
| CronJob Parameters | |||
enabled | bool | false | Deploy CronJob resources. |
jobs | object | `nil` | Map of CronJob resources. |
| Deployment Parameters | |||
enabled | bool | true | Enable Deployment. |
additionalLabels | object | `nil` | Additional labels for Deployment. |
podLabels | object | `nil` | Additional pod labels which are used in Service's Label Selector. |
annotations | object | `nil` | Annotations for Deployment. |
additionalPodAnnotations | object | `nil` | Additional pod annotations. |
type | string | RollingUpdate | Type of deployment strategy. |
maxUnavailable | string | 25% | Max unavailable pods during update. |
maxSurge | string | 25% | Max surge pods during update. |
reloadOnChange | bool | true | Reload deployment if attached Secret/ConfigMap changes. |
nodeSelector | object | `nil` | Select the node where the pods should be scheduled. |
hostAliases | list | `nil` | Add host aliases to the pods. |
initContainers | object | `nil` | Add init containers to the pods. |
fluentdConfigAnnotations | object | `nil` | Configuration details for fluentdConfigurations. |
replicas | int | `nil` | Number of replicas. |
imagePullSecrets | list | [] | List of secrets to be used for pulling the images. |
envFrom | object | `nil` | Mount environment variables from ConfigMap or Secret to the pod. |
env | object | `nil` | Environment variables to be added to the pod. |
volumes | object | `nil` | Volumes to be added to the pod. |
volumeMounts | object | `nil` | Mount path for Volumes. |
priorityClassName | string | "" | Define the priority class for the pod. |
tolerations | list | `nil` | Taint tolerations for the pods. |
affinity | object | `nil` | Affinity for the pods. |
topologySpreadConstraints | list | `nil` | Topology spread constraints for the pods. |
revisionHistoryLimit | int | 2 | Number of ReplicaSet revisions to retain. |
repository | string | "nginx" | Repository. |
tag | string | "latest" | Tag. |
digest | string | "" | Image digest. If set to a non-empty value, digest takes precedence on the tag. |
pullPolicy | string | IfNotPresent | Image pull policy. |
dnsConfig | object | `nil` | DNS config for the pods. |
startupProbe | object | See below | Startup probe. |
enabled | bool | false | Enable Startup probe. |
failureThreshold | int | 30 | Number of retries before marking the pod as failed. |
periodSeconds | int | 10 | Time between retries. |
successThreshold | int | 1 | Number of successful probes before marking the pod as ready. |
timeoutSeconds | int | 1 | Time before the probe times out. |
httpGet | object | {} | HTTP Get probe. |
exec | object | {} | Exec probe. |
tcpSocket | object | {} | TCP Socket probe. |
grpc | object | {} | gRPC probe. |
readinessProbe | object | See below | Readiness probe. |
enabled | bool | false | Enable Readiness probe. |
failureThreshold | int | 30 | Number of retries before marking the pod as failed. |
periodSeconds | int | 10 | Time between retries. |
successThreshold | int | 1 | Number of successful probes before marking the pod as ready. |
timeoutSeconds | int | 1 | Time before the probe times out. |
httpGet | object | {} | HTTP Get probe. |
exec | object | {} | Exec probe. |
tcpSocket | object | {} | TCP Socket probe. |
grpc | object | {} | gRPC probe. |
livenessProbe | object | See below | Liveness probe. |
enabled | bool | false | Enable Liveness probe. |
failureThreshold | int | 30 | Number of retries before marking the pod as failed. |
periodSeconds | int | 10 | Time between retries. |
successThreshold | int | 1 | Number of successful probes before marking the pod as ready. |
timeoutSeconds | int | 1 | Time before the probe times out. |
httpGet | object | {} | HTTP Get probe. |
exec | object | {} | Exec probe. |
tcpSocket | object | {} | TCP Socket probe. |
grpc | object | {} | gRPC probe. |
resources | object | `nil` | Resource limits and requests for the pod. |
containerSecurityContext | object | `nil` | Security Context at Container Level. |
enabled | bool | false | Enable [OpenShift OAuth Proxy](https://github.com/openshift/oauth-proxy). |
port | int | 8080 | Port on which application is running inside container. |
secretName | string | "openshift-oauth-proxy-tls" | Secret name for the OAuth Proxy TLS certificate. |
image | string | openshift/oauth-proxy:latest | Image for the OAuth Proxy. |
disableTLSArg | bool | false | If disabled `--http-address=:8081` will be used instead of `--https-address=:8443`. |
securityContext | object | `nil` | Security Context for the pod. |
command | list | [] | Command for the app container. |
args | list | [] | Args for the app container. |
ports | list | `nil` | List of ports for the app container. |
hostNetwork | bool | `nil` | Host network connectivity. |
terminationGracePeriodSeconds | int | `nil` | Gracefull termination period. |
lifecycle | object | {} | Lifecycle configuration for the pod. |
additionalContainers | list | `nil` | Additional containers besides init and app containers (without templating). |
enabled | bool | false | Enable persistence. |
mountPVC | bool | false | Whether to mount the created PVC to the deployment. |
mountPath | string | "/" | If `persistence.mountPVC` is enabled, where to mount the volume in the containers. |
name | string | `{{ include "application.name" $ }}-data` | Name of the PVC. |
accessMode | string | ReadWriteOnce | Access mode for volume. |
storageClass | string | null | Storage class for volume. |
additionalLabels | object | `nil` | Additional labels for persistent volume. |
annotations | object | `nil` | Annotations for persistent volume. |
storageSize | string | 8Gi | Size of the persistent volume. |
volumeMode | string | "" | PVC Volume Mode. |
volumeName | string | "" | Name of the volume. |
| EndpointMonitor Parameters | |||
enabled | bool | false | Deploy an [IMC EndpointMonitor](https://github.com/stakater/IngressMonitorController) resource. |
additionalLabels | object | `nil` | Additional labels for EndpointMonitor. |
annotations | object | `nil` | Annotations for EndpointMonitor. |
| ExternalSecret Parameters | |||
enabled | bool | false | Deploy [ExternalSecret](https://external-secrets.io/latest/) resources. |
additionalLabels | object | `nil` | Additional labels for ExternalSecret. |
annotations | object | `nil` | Annotations for ExternalSecret. |
secretStore | object | `nil` | Default values for the SecretStore. |
name | string | tenant-vault-secret-store | Name of the SecretStore to use. |
kind | string | SecretStore | Kind of the SecretStore being refered to. |
refreshInterval | string | "1m" | RefreshInterval is the amount of time before the values are read again from the SecretStore provider. |
files | object | `nil` | List of ExternalSecret entries. |
| ForecastleApp Parameters | |||
enabled | bool | false | Deploy a [ForecastleApp](https://github.com/stakater/Forecastle) resource. |
additionalLabels | object | `nil` | Additional labels for ForecastleApp. |
icon | string | https://raw.githubusercontent.com/stakater/ForecastleIcons/master/stakater-big.png | Icon URL. |
displayName | string | "" | Application Name. |
group | string | `{{ .Release.Namespace }}` | Application Group. |
properties | object | `nil` | Custom properties. |
networkRestricted | bool | false | Is application network restricted?. |
| GrafanaDashboard Parameters | |||
enabled | bool | false | Deploy [GrafanaDashboard](https://github.com/grafana/grafana-operator) resources. |
additionalLabels | object | `nil` | Additional labels for GrafanaDashboard. |
annotations | object | `nil` | Annotations for GrafanaDashboard. |
contents | object | `nil` | List of GrafanaDashboard entries. |
| Ingress Parameters | |||
enabled | bool | false | Enable Ingress. |
ingressClassName | string | "" | Name of the ingress class. |
pathType | string | `ImplementationSpecific` | Path type. |
serviceName | string | `{{ include "application.name" $ }}` | Service name. |
servicePort | string | `http` | Service port. |
additionalLabels | object | `nil` | Additional labels for ingress. |
annotations | object | `nil` | Annotations for ingress. |
tls | list | `nil` | TLS configuration for ingress. |
| Job Parameters | |||
enabled | bool | false | Deploy Job resources. |
jobs | object | `nil` | Map of Job resources. |
| NetworkPolicy Parameters | |||
enabled | bool | false | Enable Network Policy. |
additionalLabels | object | `nil` | Additional labels for Network Policy. |
annotations | object | `nil` | Annotations for Network Policy. |
ingress | list | `nil` | Ingress rules for Network Policy. |
egress | list | `nil` | Egress rules for Network Policy. |
| Parameters | |||
namespaceOverride | string | "" | Override the namespace for all resources. |
componentOverride | string | "" | Override the component label for all resources. |
partOfOverride | string | "" | Override the partOf label for all resources. |
applicationName | string | `{{ .Chart.Name }}` | Application name. |
| PodDisruptionBudget Parameters | |||
enabled | bool | false | Enable Pod Disruption Budget. |
minAvailable | int | 1 | Minimum number of pods that must be available after eviction. |
maxUnavailable | int | `nil` | Maximum number of unavailable pods during voluntary disruptions. |
| PrometheusRule Parameters | |||
enabled | bool | false | Deploy a PrometheusRule (Prometheus Operator) resource. |
additionalLabels | object | `nil` | Additional labels for PrometheusRule. |
groups | list | [] | Groups with alerting rules. |
| RBAC Parameters | |||
enabled | bool | true | Enable RBAC. |
enabled | bool | false | Deploy Service Account. |
name | string | `{{ include "application.name" $ }}` | Service Account Name. |
additionalLabels | object | `nil` | Additional labels for Service Account. |
annotations | object | `nil` | Annotations for Service Account. |
roles | list | `nil` | Namespaced Roles. |
| Route Parameters | |||
enabled | bool | false | Deploy a Route (OpenShift) resource. |
additionalLabels | object | `nil` | Additional labels for Route. |
annotations | object | `nil` | Annotations for Route. |
host | string | `nil` | Explicit host. |
path | string | `nil` | Path. |
port | object | `nil` | Service port. |
weight | int | 100 | Service weight. |
wildcardPolicy | string | None | Wildcard policy. |
termination | string | edge | TLS termination strategy. |
insecureEdgeTerminationPolicy | string | Redirect | TLS insecure termination policy. |
alternateBackends | list | `nil` | Alternate backend with it's weight. |
| SealedSecret Parameters | |||
enabled | bool | false | Deploy [SealedSecret](https://github.com/bitnami-labs/sealed-secrets) resources. |
additionalLabels | object | `nil` | Additional labels for SealedSecret. |
annotations | object | `nil` | Annotations for SealedSecret. |
files | object | `nil` | List of SealedSecret entries. |
| Secret Parameters | |||
enabled | bool | false | Deploy additional Secret resources. |
additionalLabels | object | `nil` | Additional labels for Secret. |
annotations | object | `nil` | Annotations for Secret. |
files | object | `nil` | List of Secrets entries. |
| SecretProviderClass Parameters | |||
enabled | bool | false | Deploy a [Secrets Store CSI Driver SecretProviderClass](https://secrets-store-csi-driver.sigs.k8s.io/) resource. |
name | string | "" | Name of the SecretProviderClass. |
provider | string | "" | Name of the provider. |
vaultAddress | string | "" | Vault Address. |
roleName | tpl/string | "" | Vault Role Name. |
objects | list | `nil` | Objects definitions. |
secretObjects | list | `nil` | Objects mapping. |
| Service Parameters | |||
enabled | bool | true | Enable Service. |
additionalLabels | object | `nil` | Additional labels for service. |
annotations | object | `nil` | Annotations for service. |
ports | list | `nil` | Ports for applications service. |
type | string | ClusterIP | Type of service. |
clusterIP | string | `nil` | Fixed IP for a ClusterIP service. |
| ServiceMonitor Parameters | |||
enabled | bool | false | Deploy a ServiceMonitor (Prometheus Operator) resource. |
additionalLabels | object | `nil` | Additional labels for ServiceMonitor. |
annotations | object | `nil` | Annotations for ServiceMonitor. |
endpoints | list | `nil` | Service endpoints from which prometheus will scrape data. |
| VPA - Vertical Pod Autoscaler Parameters | |||
enabled | bool | false | Enable Vertical Pod Autoscaling. |
additionalLabels | object | `nil` | Additional labels for VPA. |
annotations | object | `nil` | Annotations for VPA. |
containerPolicies | list | [] | Container policies for individual containers. |
updatePolicy | object | `nil` | Update policy. |
| cert-manager Certificate Parameters | |||
enabled | bool | false | Deploy a [cert-manager Certificate](https://cert-manager.io) resource. |
additionalLabels | object | `nil` | Additional labels for Certificate. |
annotations | object | `nil` | Annotations for Certificate. |
secretName | tpl/string | tls-cert | Name of the secret resource that will be automatically created and managed by this Certificate resource. |
duration | string | 8760h0m0s # 1 year | The requested "duration" (i.e. lifetime) of the Certificate. |
renewBefore | string | 720h0m0s # 30d | The amount of time before the currently issued certificate's notAfter time that cert-manager will begin to attempt to renew the certificate. |
subject | tpl/object | `nil` | Full X509 name specification for certificate. |
commonName | string | admin-app | Common name as specified on the DER encoded CSR. |
keyAlgorithm | string | rsa | Private key algorithm of the corresponding private key for this certificate. |
keyEncoding | string | pkcs1 | Private key cryptography standards (PKCS) for this certificate's private key to be encoded in. |
keySize | int | 2048 | Key bit size of the corresponding private key for this certificate. |
isCA | bool | false | Mark this Certificate as valid for certificate signing. |
usages | list | `nil` | Set of x509 usages that are requested for the certificate. |
dnsNames | tpl/list | `nil` | List of DNS subjectAltNames to be set on the certificate. |
ipAddresses | list | `nil` | List of IP address subjectAltNames to be set on the certificate. |
uriSANs | list | `nil` | List of URI subjectAltNames to be set on the certificate. |
emailSANs | list | `nil` | List of email subjectAltNames to be set on the Certificate. |
enabled | bool | false | Enable Private Key for the certificate. |
rotationPolicy | string | Always | Denotes how private keys should be generated or sourced when a certificate is being issued. |
name | string | ca-issuer | Reference to the issuer for this certificate. |
kind | string | ClusterIssuer | Kind of the issuer being referred to. |
group | string | cert-manager.io | Group of the issuer resource being refered to. |
enabled | bool | false | Enables keystore configuration. |
create | bool | true | Enables PKCS12 keystore creation for the Certificate. |
key | string | test_key | Key of the entry in the Secret resource's data field to be used. |
name | string | test-creds | Name of the Secret resource being referred to. |
create | bool | false | Enables jks keystore creation for the Certificate. |
key | tpl/string | test_key | Key of the entry in the Secret resource's data field to be used. |
name | string | test-creds | Name of the Secret resource being referred to. |
Autogenerated from chart metadata using helm-docs