zdzichu / gatus-chart

Gatus helm chart

Gatus Helm Chart

Installs the automated service health dashboard Gatus

Get Repo Info

helm repo add gatus https://avakarev.github.io/gatus-chart
helm repo update

See helm repo for command documentation.

Install Chart

helm install --name [RELEASE_NAME] gatus/gatus

See configuration below. See helm install for command documentation.

Uninstall Chart

helm delete --purge [RELEASE_NAME]

This removes all the Kubernetes components associated with the chart and deletes the release. See helm uninstall for command documentation.

Upgrading an existing Release to a new major version

To 2.0.0

This version requires Helm >= 3 Gatus version is upgraded from 2 to 3. Gatus 3 deprecates memory type of storage, supports sqlite and postgres. storage is not part of persistence anymore and is part of config now. Check the example below.

Configuration

Parameter	Description	Default
deploymentStrategy	Deployment strategy	RollingUpdate
readinessProbe.enabled	Enable readiness probe	true
livenessProbe.enabled	Enable liveness probe	true
image.repository	Image repository	twinproduction/gatus
image.tag	Image tag	v3.5.0
image.pullPolicy	Image pull policy	IfNotPresent
image.pullSecrets	Image pull secrets	{}
hostNetwork.enabled	Enable host network mode	false
annotations	Deployment annotations	{}
labels	Deployment labels	{}
podAnnotations	Pod annotations	{}
podLabels	Pod labels	{}
podSecurityContext.fsGroup	Pod volume's ownership GID	65534
securityContext.runAsUser	Container processes' user id	65534
securityContext.runAsGroup	Container processes' group id	65534
service.type	Type of service	ClusterIP
service.port	Port for kubernetes service	80
service.annotations	Service annotations	{}
service.labels	Custom labels	{}
ingress.enabled	Enables Ingress	false
ingress.annotations	Ingress annotations (values are templated)	{}
ingress.labels	Custom labels	{}
ingress.path	Ingress accepted path	/
ingress.pathType	Ingress type of path	Prefix
ingress.extraPaths	Ingress extra paths to prepend to every host	[]
ingress.hosts	Ingress accepted hostnames	["chart-example.local"]
ingress.tls	Ingress TLS configuration	[]
env	Extra environment variables passed to pods	{}
secrets	Include secret's content in pod environment	false
resources	CPU/Memory resource requests/limits	{}
nodeSelector	Node labels for pod assignment	{}
persistence.enabled	Use persistent volume to store data	false
persistence.size	Size of persistent volume claim	200Mi
persistence.mounthPath	Persistent data volume's mount path	/data
persistence.subPath	Mount a sub dir of the persistent volume	nil
persistence.accessModes	Persistence access modes	[ReadWriteOnce]
persistence.finalizers	PersistentVolumeClaim finalizers	["kubernetes.io/pvc-protection"]
persistence.annotations	PersistentVolumeClaim annotations	{}
persistence.selectorLabels	PersistentVolumeClaim selector labels	{}
persistence.existingClaim	Use an existing PVC to persist data	nil
persistence.storageClassName	Type of persistent volume claim	nil
config	Gatus configuration	{}

See Customizing the Chart Before Installing.

To see all configurable options with detailed comments, visit the chart's values.yaml, or run

helm inspect values gatus/gatus

helmfile.yaml example

---
repositories:
  - name: gatus
    url: https://avakarev.github.io/gatus-chart

releases:
  - name: gatus
    namespace: gatus
    chart: gatus/gatus
    version: 2.0.2
    values:
      - persistence:
          enabled: true
      - config:
          storage:
            type: sqlite
            file: /data/data.db
          endpoints:
            - name: Example
              url: https://example.com
              conditions:
                - '[STATUS] == 200'

License

gatus-chart is licensed under MIT license. (see LICENSE)