Skip to content

Latest commit

 

History

History
116 lines (90 loc) · 6.73 KB

README.md

File metadata and controls

116 lines (90 loc) · 6.73 KB

Gatus Helm Chart

CI Status Artifact HUB License: MIT

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.

Upgrade Chart

helm upgrade [RELEASE_NAME] gatus --install

See helm upgrade for command documentation.

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 v2.7.0
image.pullPolicy Image pull policy IfNotPresent
image.pullSecrets Image pull secrets {}
hostNetwork.enabled Enable host network mode false
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.hosts Ingress accepted hostnames ["chart-example.local"]
ingress.tls Ingress TLS configuration []
env Extra environment variables passed to pods {}
resources CPU/Memory resource requests/limits {}
nodeSelector Node labels for pod assignment {}
persistence.enabled Use persistent volume to store data false
persistence.accessModes Persistence access modes [ReadWriteOnce]
persistence.size Size of persistent volume claim 50Mi
persistence.mounthPath Persistent data volume's mount path /data
persistence.storage.file File path to persist the data in /data/persistent-storage.file
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: 1.1.4
    values:
      - config:
          services:
            - name: Example
              url: https://example.com
              conditions:
                - '[STATUS] == 200'

License

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