Umami Helm Chart
Deploy Umami, a privacy-first web analytics platform, on Kubernetes using the official
ghcr.io/umami-software/umami image and HelmForge production patterns.
The chart supports a fast development install with bundled PostgreSQL and a production path with external PostgreSQL, managed secrets, ingress or Gateway API, NetworkPolicy, PodDisruptionBudget, S3-compatible database backups, and explicit Umami runtime options.
Features
- Privacy-first analytics with no cookies by default.
- Official Umami image and configurable image pull policy.
- Bundled
helmforge/postgresqlsubchart for quick starts. - External PostgreSQL support for managed or operator-owned databases.
- Structured Umami settings for telemetry, updates, bot checks, SSL forwarding, base paths, tracker names, CORS, and frame allowlists.
- Optional
external-secrets.io/v1resources for APP_SECRET, database password, and S3 backup credentials. - Ingress and Kubernetes Gateway API
HTTPRouteexposure options. - Dual-stack service controls through
ipFamilyPolicyandipFamilies. - Optional NetworkPolicy with ingress and egress controls.
- Optional PodDisruptionBudget for multi-replica deployments.
- S3-compatible PostgreSQL backup CronJob.
- Focused Helm unit tests and CI values for default, external DB, backup, ingress, Gateway API, dual-stack, External Secrets, NetworkPolicy, and production examples.
Install
helm repo add helmforge https://repo.helmforge.dev
helm repo update
helm install umami helmforge/umami --namespace umami --create-namespace
OCI registry:
helm install umami oci://ghcr.io/helmforgedev/helm/umami --namespace umami --create-namespace
Access a default install:
kubectl port-forward -n umami svc/umami-umami 3000:80
Open http://localhost:3000 and sign in with Umami's initial credentials:
- Username:
admin - Password:
umami
Change the password immediately after first login.
Development Defaults
The default values are intentionally simple:
postgresql.enabled=true- one Umami replica
- generated APP_SECRET and database password
- ClusterIP service
- no public ingress
- no NetworkPolicy
- no PDB
- telemetry and update checks disabled
This is useful for local clusters, demos, and CI smoke tests. It is not a production-ready posture by itself.
Production Path
For production, prefer:
- external or operator-managed PostgreSQL
- a stable APP_SECRET stored in Kubernetes Secret or External Secrets Operator
- TLS termination through Gateway API or ingress
FORCE_SSL=truewhen the proxy terminates HTTPSCLIENT_IP_HEADERaligned with your ingress controller or gateway- multiple replicas with PDB
- explicit resource requests and memory limits
- NetworkPolicy ingress and egress controls
- backup CronJob or a database-native backup solution
Start from:
helm install umami helmforge/umami \
--namespace umami \
--create-namespace \
-f charts/umami/examples/production.yaml
External PostgreSQL
Disable the bundled database and point Umami at a managed PostgreSQL endpoint:
postgresql:
enabled: false
database:
external:
host: postgres-primary.database.svc.cluster.local
port: 5432
name: umami
username: umami
existingSecret: umami-db
existingSecretPasswordKey: database-password
parameters: pgbouncer=true
init:
enabled: true
adminUsername: postgres
adminExistingSecret: postgres-admin
Create the secret:
kubectl create secret generic umami-db \
--from-literal=database-password='replace-me'
database.external.parameters appends a query string to the generated URL without exposing credentials in values.
For example, pgbouncer=true supports Prisma deployments that require PgBouncer compatibility mode. Do not include the
leading ?.
When the structured fields are insufficient, store a complete URL in the same Secret and set
database.external.existingSecretUrlKey:
kubectl create secret generic umami-db \
--from-literal=database-url='postgresql://umami:[email protected]:6432/umami?pgbouncer=true' \
--from-literal=password='replace-me'
database:
external:
host: pgbouncer.database.svc
port: 6432
existingSecret: umami-db
existingSecretUrlKey: database-url
The structured host, port, database, and username fields remain the source for the readiness check, optional database
preparation, and backup jobs; keep them aligned with the complete URL. Set backup.database.username when backups use a
separate database user. When backups are enabled, the Secret must also contain the key selected by
database.external.existingSecretPasswordKey, or configure a separate backup.database.existingSecret and
backup.database.existingSecretPasswordKey. A complete URL and parameters cannot be configured together.
Umami creates the pgcrypto extension during its first migration. Many managed databases require an owner or
administrative account to create extensions. When the application user cannot do that, enable
database.external.init.enabled and provide an admin Secret. The init container runs before Umami starts and only
executes the SQL configured in database.external.init.sql.
External Secrets
Use External Secrets Operator when credentials are stored in Vault, AWS Secrets Manager, GCP Secret Manager, Azure Key Vault, or another supported backend.
postgresql:
enabled: false
externalSecrets:
enabled: true
secretStoreRef:
name: platform-secrets
kind: ClusterSecretStore
app:
enabled: true
targetName: umami-app
appSecretRemoteRef:
key: prod/umami/app
property: appSecret
database:
enabled: true
targetName: umami-db
passwordRemoteRef:
key: prod/umami/database
property: password
The chart renders external-secrets.io/v1 resources and consumes the generated Kubernetes Secrets.
Gateway API
Gateway API is available through gatewayAPI.enabled=true:
gatewayAPI:
enabled: true
parentRefs:
- name: public-gateway
namespace: gateway-system
hostnames:
- analytics.example.com
Use ingress instead when your cluster standardizes on networking.k8s.io/v1 Ingress.
Service Dual Stack
service:
ipFamilyPolicy: PreferDualStack
ipFamilies:
- IPv4
- IPv6
Dual-stack requires a cluster and CNI configured for IPv4/IPv6.
NetworkPolicy
NetworkPolicy is opt-in:
networkPolicy:
enabled: true
ingress:
allowSameNamespace: true
egress:
enabled: true
allowDNS: true
allowSameNamespaceDatabase: true
allowHTTPS: true
Some local CNIs enforce traffic through pod CIDRs differently when testing through Services. In those clusters, add an explicit ingress peer:
networkPolicy:
ingress:
allowSameNamespace: false
extraFrom:
- ipBlock:
cidr: 10.42.0.0/16
Umami Runtime Settings
Common structured settings:
| Value | Umami env var | Default | Purpose |
|---|---|---|---|
umami.disableTelemetry |
DISABLE_TELEMETRY |
true |
Disable Umami telemetry. |
umami.disableUpdates |
DISABLE_UPDATES |
true |
Disable update checks. |
umami.disableBotCheck |
DISABLE_BOT_CHECK |
false |
Disable built-in bot filtering when needed. |
umami.forceSSL |
FORCE_SSL |
false |
Trust proxy HTTPS and generate secure URLs. |
umami.clientIpHeader |
CLIENT_IP_HEADER |
"" |
Header used to detect client IP behind a proxy. |
umami.collectApiEndpoint |
COLLECT_API_ENDPOINT |
"" |
Custom collect endpoint. |
umami.trackerScriptName |
TRACKER_SCRIPT_NAME |
"" |
Custom tracker script file name. |
umami.allowedFrameUrls |
ALLOWED_FRAME_URLS |
"" |
Allow specific frame embed URLs. |
umami.corsMaxAge |
CORS_MAX_AGE |
"" |
CORS preflight cache duration. |
Use extraEnv for Umami settings not yet modeled by the chart.
Sub-path hosting requires a custom Umami image built with the upstream BASE_PATH build-time variable.
The chart does not set BASE_PATH as a runtime environment variable for the stock image.
Backup
The chart can create a PostgreSQL dump CronJob and upload it to S3-compatible storage:
backup:
enabled: true
schedule: "0 2 * * *"
s3:
endpoint: https://s3.example.com
bucket: umami-backups
existingSecret: umami-backup
The referenced secret must contain the keys configured by backup.s3.existingSecretAccessKeyKey and
backup.s3.existingSecretSecretKeyKey.
On EKS, prefer Pod Identity or IRSA with the dedicated backup ServiceAccount. Both modes use this base configuration:
backup:
enabled: true
s3:
endpoint: https://s3.us-east-1.amazonaws.com
bucket: umami-backups
region: us-east-1
credentialsFromPodIdentity: true
For EKS Pod Identity, install the
EKS Pod Identity Agent once per cluster
unless EKS Auto Mode already provides it. Then associate the IAM role with the exact namespace and backup
ServiceAccount. The default ServiceAccount name is <release>-umami-backup; Pod Identity does not use a ServiceAccount
annotation. Before creating the association, configure the IAM role trust policy to allow the
pods.eks.amazonaws.com service principal to call sts:AssumeRole and sts:TagSession; see the
AWS Pod Identity association guide.
aws eks create-addon \
--cluster-name <cluster-name> \
--addon-name eks-pod-identity-agent
aws eks create-pod-identity-association \
--cluster-name <cluster-name> \
--namespace <release-namespace> \
--service-account <release>-umami-backup \
--role-arn <iam-role-arn>
For IRSA, the cluster must have an IAM OIDC provider for its issuer URL, and the IAM role trust policy must allow
sts:AssumeRoleWithWebIdentity from that provider for the exact backup namespace and ServiceAccount. Follow the AWS
guides to create the OIDC provider
and configure the role trust, then
add the role annotation:
backup:
serviceAccount:
annotations:
eks.amazonaws.com/role-arn: arn:aws:iam::123456789012:role/umami-backup
Workload identity mode renders no static S3 credential Secret or credential environment variables. The identity needs
s3:PutObject for the configured prefix and, when enabled, s3:CreateBucket; leave
backup.s3.createBucketIfNotExists=false for object-only least privilege. IRSA additionally needs
sts:AssumeRoleWithWebIdentity. Allow DNS and HTTPS egress to S3 and STS. If the CNI filters link-local traffic, allow
the EKS Pod Identity or IRSA metadata endpoint for the cluster's IPv4 or IPv6 mode. Token automount is controlled by
backup.serviceAccount.automountServiceAccountToken and remains disabled by default.
For production, test restore procedures outside Helm. Backups without restore validation are only partial protection.
Values & Configuration Reference
All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.
| --- | --- | --- |
| commonAnnotations | {} | Annotations applied to every chart-owned Kubernetes resource. |
| replicaCount | 1 | Number of Umami pods. |
| image.repository | ghcr.io/umami-software/umami | Umami image repository. |
| image.tag | 3.4.0 | Umami image tag. |
| service.type | ClusterIP | Kubernetes service type. |
| service.ipFamilyPolicy | "" | Optional service IP family policy. |
| service.ipFamilies | [] | Optional service IP families. |
| ingress.enabled | false | Enable Ingress. |
| gatewayAPI.enabled | false | Enable Gateway API HTTPRoute. |
| postgresql.enabled | true | Deploy bundled HelmForge PostgreSQL. |
| database.external.host | "" | External PostgreSQL host when bundled PostgreSQL is disabled. |
| database.external.parameters | "" | Query string appended to the generated DATABASE_URL, without ?. |
| database.external.existingSecretUrlKey | "" | Key in the existing Secret containing a complete DATABASE_URL. |
| database.external.init.enabled | false | Run optional external database preparation SQL before Umami starts. |
| backup.s3.credentialsFromPodIdentity | false | Use EKS Pod Identity or IRSA instead of static S3 credentials. |
| backup.serviceAccount.* | dedicated | Configure the dedicated workload identity ServiceAccount. |
| backup.securityContext | no escalation, drop ALL | Security context for the PostgreSQL and S3 uploader backup containers. |
| externalSecrets.enabled | false | Render ExternalSecret resources. |
| networkPolicy.enabled | false | Render NetworkPolicy. |
| pdb.enabled | false | Render PodDisruptionBudget. |
| backup.enabled | false | Enable S3-compatible backup CronJob. |
| serviceAccount.automountServiceAccountToken | false | Control service account token mounting. |
| podSecurityContext | uid 1001, runAsNonRoot, RuntimeDefault seccomp | Pod security context. |
| securityContext | no escalation, drop ALL | Security context for Umami and the chart init containers; extraInitContainers are rendered as provided. |
| initContainers.waitForDatabase.enabled | true | Wait for the database socket before starting Umami. |
| initContainers.waitForDatabase.image | docker.io/library/busybox:1.37 | Image used by the database readiness check. |
| initContainers.waitForDatabase.pullPolicy | IfNotPresent | Pull policy for the database readiness image. |
| extraInitContainers | [] | Additional init containers for preparing shared volumes before Umami starts. |
| extraVolumes / extraVolumeMounts | [] | Additional pod volumes and Umami container mounts, such as GeoIP databases or custom assets. |
Examples
examples/production.yaml- production-oriented values with external PostgreSQL, Gateway API, NetworkPolicy, and PDB.examples/external-postgresql.yaml- managed database setup.examples/external-secrets.yaml- External Secrets Operator integration.examples/gateway-api.yaml- Gateway API HTTPRoute exposure.
Security
- Pods run as the image user
nextjs(uid 1001) withrunAsNonRoot, no privilege escalation, every capability dropped,RuntimeDefaultseccomp, and no ServiceAccount token. - The first migration creates
adminwith the upstream passwordumami. Change it right after the first login and keep the instance private until then. - Secrets accept existing Secrets or External Secrets Operator resources.
Upgrade Notes
Umami 3.x includes database migrations for newer analytics features such as Boards, Shares, Session Replay, and Web Vitals. Back up PostgreSQL before upgrading live deployments, especially when migrating from Umami 2.x. Umami 3.4.0 adds annotations, API keys and opt-in MCP support, includes schema migrations for annotations and API keys, and strengthens authenticated sessions. Umami 3.3.1 added a username-normalization migration and fixed two-factor authentication configuration, tracking session drift, event filtering and pagination, funnel metrics, and zero/false value responses.
More Information
Security Scan: umami
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 89.393936% |
Security posture acceptable.
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
Default installs generate the application and database secrets and do not expose Umami publicly.
flowchart LR user[kubectl port-forward] --> svc[Service ClusterIP<br/>release-umami:80] svc --> deploy[Umami Deployment<br/>1 replica] deploy -->|DATABASE_URL| pg[(PostgreSQL<br/>HelmForge chart)]
Umami Values Schema Reference
Official schema parameters, default values, and types extracted directly from the chart repository.
Global(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| global | object | - | Global settings shared by the chart. |
Name Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nameOverride | string | "" | Override the chart name used in resource names |
Fullname Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| fullnameOverride | string | "" | Override the full release name used in resource names |
Common Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| commonLabels | object | - | Labels added to every resource created by this chart |
Common Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| commonAnnotations | object | {} | Annotations applied to every chart-owned Kubernetes resource |
Replica Count(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| replicaCount | integer | 1 | Number of Umami application replicas |
Image(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image.repository | string | ghcr.io/umami-software/umami | Umami container image |
| image.tag | string | 3.4.0 | Image tag |
| image.pullPolicy | string | IfNotPresent | Image pull policy Allowed: AlwaysIfNotPresentNever |
Image Pull Secrets(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| imagePullSecrets | array | - | Image pull secrets for private registries |
Umami(16)
| Parameter | Type | Default | Description |
|---|---|---|---|
| umami.port | integer | 3000 | Application port |
| umami.appSecret | string | "" | Secret used for hashing (auto-generated if empty) |
| umami.existingSecret | string | "" | Existing secret containing the APP_SECRET key |
| umami.existingSecretKey | string | app-secret | Key in the existing secret |
| umami.disableTelemetry | boolean | true | Disable telemetry |
| umami.disableUpdates | boolean | true | Disable upstream update checks |
| umami.disableBotCheck | boolean | false | Disable bot detection |
| umami.cloudMode | boolean | false | Disable users, teams, and websites settings pages |
| umami.forceSSL | boolean | false | Enable Umami FORCE_SSL |
| umami.clientIpHeader | string | "" | HTTP header used to determine client IP behind reverse proxies |
| umami.collectApiEndpoint | string | "" | Custom collection endpoint |
| umami.corsMaxAge | stringinteger | "" | CORS preflight max age in seconds |
| umami.allowedFrameUrls | string | "" | Space-delimited URLs allowed to frame Umami |
| umami.debug | string | "" | Debug namespaces |
| umami.trackerScriptName | string | "" | Custom tracker script name (for ad-blocker bypass) |
| umami.extraEnv | array | - | Extra environment variables for the container |
Database(15)
| Parameter | Type | Default | Description |
|---|---|---|---|
| database.external.host | string | "" | Database host |
| database.external.port | stringinteger | 5432 | Database port |
| database.external.name | string | umami | Database name |
| database.external.username | string | umami | Database username |
| database.external.password | string | "" | Database password |
| database.external.existingSecret | string | "" | Existing secret containing the database password |
| database.external.existingSecretPasswordKey | string | password | Key in the existing secret containing the password |
| database.external.existingSecretUrlKey | string | "" | Key in the existing secret containing a complete DATABASE_URL |
| database.external.parameters | string | "" | Optional query string appended to the generated DATABASE_URL, without the leading question mark |
| database.external.init.enabled | boolean | false | Prepare an external PostgreSQL database before Umami starts |
| database.external.init.image | string | docker.io/library/postgres:18.6-alpine | PostgreSQL client image used by the init container |
| database.external.init.adminUsername | string | postgres | Administrative database user used by the init container |
| database.external.init.adminExistingSecret | string | "" | Existing secret containing the administrative database password |
| database.external.init.adminExistingSecretPasswordKey | string | postgres-password | Key in the admin secret containing the administrative database password |
| database.external.init.sql | string | CREATE EXTENSION IF NOT EXISTS pgcrypto; | SQL executed before Umami starts |
Service Account(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount.create | boolean | false | Create a ServiceAccount |
| serviceAccount.name | string | "" | ServiceAccount name |
| serviceAccount.annotations | object | - | Annotations for the ServiceAccount |
| serviceAccount.automountServiceAccountToken | boolean | false | Mount Kubernetes API credentials into pods |
Service & Networking(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.type | string | ClusterIP | Service type Allowed: ClusterIPNodePortLoadBalancer |
| service.port | integer | 80 | HTTP service port |
| service.annotations | object | - | Annotations for the Service |
| service.ipFamilyPolicy | string | "" | Service IP family policy |
| service.ipFamilies | array | - | Ordered Service IP families |
Ingress(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| ingress.enabled | boolean | false | Enable ingress for Umami |
| ingress.ingressClassName | string | traefik | Ingress class name (for example: traefik, nginx) |
| ingress.annotations | object | - | Annotations for the ingress |
| ingress.hosts | array | - | Ingress hosts |
| ingress.tls | array | - | Ingress TLS configuration |
Gateway API(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| gatewayAPI.enabled | boolean | false | Chart configuration parameter |
| gatewayAPI.parentRefs | array | - | Chart configuration parameter |
| gatewayAPI.hostnames | array | - | Chart configuration parameter |
| gatewayAPI.annotations | object | - | Chart configuration parameter |
| gatewayAPI.matches | array | - | Chart configuration parameter |
| gatewayAPI.filters | array | - | Chart configuration parameter |
External Secrets(8)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalSecrets.enabled | boolean | false | Chart configuration parameter |
| externalSecrets.apiVersion | string | external-secrets.io/v1 | Chart configuration parameter |
| externalSecrets.refreshInterval | string | 1h | Chart configuration parameter |
| externalSecrets.secretStoreRef | object | - | Chart configuration parameter |
| externalSecrets.target | object | - | Chart configuration parameter |
| externalSecrets.app | object | - | Chart configuration parameter |
| externalSecrets.database | object | - | Chart configuration parameter |
| externalSecrets.backup | object | - | Chart configuration parameter |
Health Probes(18)
| Parameter | Type | Default | Description |
|---|---|---|---|
| probes.startup.enabled | boolean | true | Chart configuration parameter |
| probes.startup.path | string | /api/heartbeat | Chart configuration parameter |
| probes.startup.initialDelaySeconds | integer | 30 | Chart configuration parameter |
| probes.startup.periodSeconds | integer | - | Chart configuration parameter |
| probes.startup.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.startup.failureThreshold | integer | - | Chart configuration parameter |
| probes.liveness.enabled | boolean | true | Chart configuration parameter |
| probes.liveness.path | string | /api/heartbeat | Chart configuration parameter |
| probes.liveness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.liveness.periodSeconds | integer | - | Chart configuration parameter |
| probes.liveness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.liveness.failureThreshold | integer | - | Chart configuration parameter |
| probes.readiness.enabled | boolean | true | Chart configuration parameter |
| probes.readiness.path | string | /api/heartbeat | Chart configuration parameter |
| probes.readiness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.readiness.periodSeconds | integer | - | Chart configuration parameter |
| probes.readiness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.readiness.failureThreshold | integer | - | Chart configuration parameter |
Resources(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources | object | - | CPU and memory requests/limits for the main container |
Pod Security(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext.runAsNonRoot | boolean | true | Chart configuration parameter |
| podSecurityContext.runAsUser | integer | 1001 | Chart configuration parameter |
| podSecurityContext.runAsGroup | integer | 65533 | Chart configuration parameter |
| podSecurityContext.fsGroup | integer | 65533 | Chart configuration parameter |
| podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter Allowed: RuntimeDefaultUnconfinedLocalhost |
| podSecurityContext.seccompProfile.localhostProfile | string | - | Chart configuration parameter |
Container Security(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext.allowPrivilegeEscalation | boolean | false | Chart configuration parameter |
| securityContext.capabilities.drop | array | - | Chart configuration parameter |
Network Policy(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy.enabled | boolean | false | Chart configuration parameter |
| networkPolicy.ingress | object | - | Chart configuration parameter |
| networkPolicy.egress | object | - | Chart configuration parameter |
Pdb(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| pdb.enabled | boolean | false | Chart configuration parameter |
| pdb.minAvailable | integerstring | 1 | Chart configuration parameter |
| pdb.maxUnavailable | integerstring | "" | Chart configuration parameter |
Node Selector(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nodeSelector | object | - | Node selector for pod scheduling |
Tolerations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| tolerations | array | - | Tolerations for pod scheduling |
Affinity(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| affinity | object | - | Affinity rules for pod scheduling |
Topology Spread Constraints(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| topologySpreadConstraints | array | - | Topology spread constraints |
Priority Class Name(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| priorityClassName | string | "" | Priority class name |
Termination Grace Period Seconds(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| terminationGracePeriodSeconds | integer | 30 | Grace period for shutdown (seconds) |
Pod Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podLabels | object | - | Additional labels for the pod |
Pod Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podAnnotations | object | - | Additional annotations for the pod |
Init Containers(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| initContainers.waitForDatabase.enabled | boolean | true | Wait for the database socket before starting Umami |
| initContainers.waitForDatabase.image | string | docker.io/library/busybox:1.37 | Container image used to check database connectivity |
| initContainers.waitForDatabase.pullPolicy | string | IfNotPresent | Image pull policy for the database wait container Allowed: AlwaysIfNotPresentNever |
Extra Volumes(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumes | array | - | Additional volumes for the pod |
Extra Volume Mounts(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumeMounts | array | - | Additional volume mounts for the container |
Extra Init Containers(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraInitContainers | array | - | Additional init containers for preparing shared volumes before Umami starts |
Extra Manifests(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraManifests | array | - | Extra Kubernetes manifests to deploy alongside the chart |
Backup(36)
| Parameter | Type | Default | Description |
|---|---|---|---|
| backup.enabled | boolean | false | Enable scheduled backups to S3-compatible storage |
| backup.schedule | string | 0 3 * * * | Cron schedule for backups |
| backup.suspend | boolean | false | Suspend the CronJob without deleting it |
| backup.concurrencyPolicy | string | Forbid | Concurrency policy for the CronJob Allowed: ForbidReplaceAllow |
| backup.archivePrefix | string | umami | Prefix for backup archive filenames |
| backup.images.postgresql | string | docker.io/library/postgres:18.6-alpine | Image used for PostgreSQL backup (must have pg_dump) |
| backup.images.uploader | string | docker.io/helmforge/mc:1.0.0 | Image used for S3 upload (MinIO client) |
| backup.resources | object | - | CPU and memory requests/limits for backup containers |
| backup.securityContext.allowPrivilegeEscalation | boolean | false | Chart configuration parameter |
| backup.securityContext.capabilities.drop | array | - | Chart configuration parameter |
| backup.serviceAccount.create | boolean | true | Chart configuration parameter |
| backup.serviceAccount.name | string | "" | Chart configuration parameter |
| backup.serviceAccount.annotations | object | {} | Chart configuration parameter |
| backup.serviceAccount.automountServiceAccountToken | boolean | false | Chart configuration parameter |
| backup.s3.endpoint | string | "" | S3-compatible endpoint URL |
| backup.s3.bucket | string | "" | Target bucket name |
| backup.s3.prefix | string | umami | Key prefix within the bucket |
| backup.s3.createBucketIfNotExists | boolean | false | Auto-create the bucket if it does not exist |
| backup.s3.existingSecret | string | "" | Use an existing secret for S3 credentials |
| backup.s3.existingSecretAccessKeyKey | string | access-key | Key in the existing secret for the access key |
| backup.s3.existingSecretSecretKeyKey | string | secret-key | Key in the existing secret for the secret key |
| backup.s3.accessKey | string | "" | Inline S3 access key (ignored when existingSecret is set) |
| backup.s3.secretKey | string | "" | Inline S3 secret key (ignored when existingSecret is set) |
| backup.s3.region | string | "" | AWS region used by workload identity |
| backup.s3.credentialsFromPodIdentity | boolean | false | Use EKS Pod Identity or IRSA instead of static S3 credentials |
| backup.database.host | string | "" | Chart configuration parameter |
| backup.database.port | string | "" | Chart configuration parameter |
| backup.database.name | string | "" | Chart configuration parameter |
| backup.database.username | string | "" | Chart configuration parameter |
| backup.database.password | string | "" | Chart configuration parameter |
| backup.database.existingSecret | string | "" | Chart configuration parameter |
| backup.database.existingSecretPasswordKey | string | password | Chart configuration parameter |
| backup.database.postgresDumpArgs | string | "" | Chart configuration parameter |
| backup.successfulJobsHistoryLimit | integer | 3 | Number of successful job records to keep |
| backup.failedJobsHistoryLimit | integer | 3 | Number of failed job records to keep |
| backup.backoffLimit | integer | 1 | Maximum retries per backup job |
Postgresql(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| postgresql.enabled | boolean | true | Deploy PostgreSQL as a subchart |
| postgresql.architecture | string | standalone | PostgreSQL architecture |
| postgresql.auth.database | string | umami | Chart configuration parameter |
| postgresql.auth.username | string | umami | Chart configuration parameter |
| postgresql.auth.password | string | "" | PostgreSQL password (auto-generated if empty) |
| postgresql.initdb.scripts | object | - | SQL or shell scripts run during first initialization |
No schema parameters match your search
Try searching for a different keyword or reset the filter.