uptime-kuma

FMJ Studios - Uptime-Kuma Helm Chart

Uptime-Kuma is an open-source, is an easy-to-use self-hosted monitoring tool. It supports monitoring uptime for HTTP( s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Ping / DNS Record / Push / Steam Game Server / Docker Containers, sports a fancy reactive and fast UI and features notifications via Telegram, Discord, Gotify, Slack, Pushover, Email ( SMTP), and 90+ notification services. Additionally the application is available in multiple languages, can map status pages to specific domains and supports proxies and 2FA. It delivers all of these features within a single Docker image available on Docker Hub.

Head to the Uptime-Kuma GitHub Repository for in-depth documentation and configuration guides.

✨ TL;DR

Helm Repository Installation

helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install uptime-kuma fmjstudios/uptime-kuma --version X.Y.Z

OCI Installation

helm install oci://ghcr.io/fmjstudios/helm/uptime-kuma:X.Y.Z

Introduction

This chart bootstraps an Uptime-Kuma StatefulSet or Deployment on a Kubernetes cluster using the Helm package manager. For cluster networking a Service and Ingress manifest is also created, whereas the Ingress needs to be explicitly enabled. Lastly the chart configures a PodDisruptionBudget if enabled. RBAC manifests are enabled by default.

The chart supports the configuration of all [Uptime-Kuma environment variables](StatefulSet or) via the uptimeKuma key in Helm's values and makes use of the official Docker Hub container image, although this is configureble via the Image Parameters.

Parameters

Uptime-Kuma Image parameters

Name	Description	Value
image.registry	The Docker registry to pull the image from	docker.io
image.repository	The registry repository to pull the image from	louislam/uptimeKuma
image.tag	The image tag to pull	'1.23.11'
image.digest	The image digest to pull	""
image.pullPolicy	The Kubernetes image pull policy	IfNotPresent
image.pullSecrets	A list of secrets to use for pulling images from private registries	[]

Uptime-Kuma Name overrides

Name	Description	Value
nameOverride	String to partially override uptimeKuma.fullname	""
fullnameOverride	String to fully override uptimeKuma.fullname	""

Uptime-Kuma Configuration parameters

Name	Description	Value
uptimeKuma.host	The host address to bind Uptime-Kuma to	"::"
uptimeKuma.port	The port for Uptime-Kuma to listen on	3001
uptimeKuma.disableFrameSameOrigin	Allow Uptime-Kuma to be embedded inside HTML 'iframes' of other origins	false
uptimeKuma.websocketOriginCheck	Configures Uptime-Kuma to check whether the websocket 'ORIGIN' header matches the server's hostname	"cors-like"
uptimeKuma.allowAllChromeExecutables	Allow to specify any executables as Chromium	"0"
uptimeKuma.data.path	The relative path to store data in	data
uptimeKuma.data.pvc.size	The size given to PVCs created from the above data	5Gi
uptimeKuma.data.pvc.storageClass	The storageClass given to PVCs created from the above data	standard
uptimeKuma.data.pvc.reclaimPolicy	The resourcePolicy given to PVCs created from the above data	Retain
uptimeKuma.data.pvc.existingClaim	Provide the name to an existing PVC	""
uptimeKuma.certs.key	The path to an TLS certificate key - ignored if 'existingSecret' is set	""
uptimeKuma.certs.cert	The path to an TLS certificate cert - ignored if 'existingSecret' is set	""
uptimeKuma.certs.passphrase.value	The passphrase for the TLS certificate key	""
uptimeKuma.certs.passphrase.existingSecret.name	The name of an existing Kubernetes secret	""
uptimeKuma.certs.passphrase.existingSecret.key	The key within the existing Kubernetes secret	""
uptimeKuma.cloudflaredToken.value	The Cloudflare Tunnel token	""
uptimeKuma.cloudflaredToken.existingSecret.name	The name of an existing Kubernetes secret	""
uptimeKuma.cloudflaredToken.existingSecret.key	The key within the existing Kubernetes secret	""
uptimeKuma.node.extraCaCerts	The path to CA bundle for Node.js to use - in order to verify self-signed certificates	""
uptimeKuma.node.tlsRejectUnauthorized	Ignore all TLS verification errors	""
uptimeKuma.node.options	Specify extra CLI options to pass to Node.js	[]

ConfigMap parameters

Name	Description	Value
configMap.annotations	Annotations for the ConfigMap resource	{}
configMap.labels	Extra Labels for the ConfigMap resource	{}

Common Secret parameters

Name	Description	Value
secret.annotations	Common annotations for the SMTP, HIBP, Admin and Database secrets	{}
secret.labels	Common extra labels for the SMTP, HIBP, Admin and Database secrets	{}

Ingress parameters

Name	Description	Value
ingress.enabled	Whether to enable Ingress	false
ingress.className	The IngressClass to use for the pod's ingress	""
ingress.whitelist	A comma-separated list of IP addresses to whitelist	""
ingress.annotations	Annotations for the Ingress resource	{}
ingress.tls	A list of hostnames and secret names to use for TLS	[]
ingress.extraHosts	A list of extra hosts for the Ingress resource (with vaultwarden.domain)	[]

Service parameters

Name	Description	Value
service.type	The type of service to create	ClusterIP
service.port	The port to use on the service	80
service.nodePort	The Node port to use on the service	30080
service.extraPorts	Extra ports to add to the service	[]
service.annotations	Annotations for the service resource	{}
service.labels	Labels for the service resource	{}
service.externalTrafficPolicy	The external traffic policy for the service	Cluster
service.internalTrafficPolicy	The internal traffic policy for the service	Cluster
service.clusterIP	Define a static cluster IP for the service	""
service.loadBalancerIP	Set the Load Balancer IP	""
service.loadBalancerClass	Define Load Balancer class if service type is LoadBalancer (optional, cloud specific)	""
service.loadBalancerSourceRanges	Service Load Balancer source ranges	[]
service.externalIPs	Service External IPs	[]
service.sessionAffinity	Session Affinity for Kubernetes service, can be "None" or "ClientIP"	None
service.sessionAffinityConfig	Additional settings for the sessionAffinity	{}
service.ipFamilyPolicy	The ipFamilyPolicy	{}

RBAC parameters

Name	Description	Value
rbac.create	Whether to create RBAC resources	true
rbac.rules	Extra rules to add to the Role	[]

Service Account parameters

Name	Description	Value
serviceAccount.create	Whether a service account should be created	true
serviceAccount.automount	Whether to automount the service account token	false
serviceAccount.annotations	Annotations to add to the service account	{}
serviceAccount.name	A custom name for the service account, otherwise uptimeKuma.fullname is used	""
serviceAccount.secrets	A list of secrets mountable by this service account	[]

Liveness Probe parameters

Name	Description	Value
livenessProbe.enabled	Enable or disable the use of liveness probes	false
livenessProbe.initialDelaySeconds	Configure the initial delay seconds for the liveness probe	5
livenessProbe.timeoutSeconds	Configure the initial delay seconds for the liveness probe	1
livenessProbe.periodSeconds	Configure the seconds for each period of the liveness probe	10
livenessProbe.successThreshold	Configure the success threshold for the liveness probe	1
livenessProbe.failureThreshold	Configure the failure threshold for the liveness probe	10

Readiness Probe parameters

Name	Description	Value
readinessProbe.enabled	Enable or disable the use of readiness probes	false
readinessProbe.initialDelaySeconds	Configure the initial delay seconds for the readiness probe	5
readinessProbe.timeoutSeconds	Configure the initial delay seconds for the readiness probe	1
readinessProbe.periodSeconds	Configure the seconds for each period of the readiness probe	10
readinessProbe.successThreshold	Configure the success threshold for the readiness probe	1
readinessProbe.failureThreshold	Configure the failure threshold for the readiness probe	3

Startup Probe parameters

Name	Description	Value
startupProbe.enabled	Enable or disable the use of readiness probes	false
startupProbe.initialDelaySeconds	Configure the initial delay seconds for the startup probe	5
startupProbe.timeoutSeconds	Configure the initial delay seconds for the startup probe	1
startupProbe.periodSeconds	Configure the seconds for each period of the startup probe	10
startupProbe.successThreshold	Configure the success threshold for the startup probe	1
startupProbe.failureThreshold	Configure the failure threshold for the startup probe	10

PodDisruptionBudget parameters

Name	Description	Value
podDisruptionBudget.enabled	Enable the pod disruption budget	true
podDisruptionBudget.minAvailable	The minium amount of pods which need to be available	1

Pod settings

Name	Description	Value
resources	The resource limits/requests for the Uptime-Kuma pod	{}
volumes	Define volumes for the Paperless pod	[]
volumeMounts	Define volumeMounts for the Paperless pod	[]
initContainers	Define initContainers for the main Uptime-Kuma server	[]
nodeSelector	Node labels for pod assignment	{}
tolerations	Tolerations for pod assignment	[]
affinity	Affinity for pod assignment	{}
strategy	Specify a deployment strategy for the Uptime-Kuma pod	{}
podAnnotations	Extra annotations for the Uptime-Kuma pod	{}
podLabels	Extra labels for the Uptime-Kuma pod	{}
priorityClassName	The name of an existing PriorityClass	""

Security context settings

Name	Description	Value
podSecurityContext	Security context settings for the Uptime-Kuma pod	{}
securityContext	General security context settings for	{}