Git Product home page Git Product logo

uptime-kuma-helm's Introduction

Uptime Kuma Helm Chart

๐Ÿ—๏ธ Container Image Build Maintenance GitHub

This repo contains the automation to repackage uptime-kuma into a non-root OCI container image as well as a simple Helm 3 Chart to deploy on OpenShift, but also on Kubernetes.

The Helm Chart will deploy a single Pod as part of a StatefulSet, you can configure persistence and optionally deploy a OpenShift Route or regular K8s Ingress alongside.

Helm Repo

Important

As of version 1.3.0 of this repository/chart there is now a Helm Repository.

Adding the Helm repository to your Helm
helm repo add k3 https://k3rnelpan1c-dev.github.io/uptime-kuma-helm/
helm repo update
Installing the Chart from the repo
helm install test-uptime k3/uptime-kuma
# or a specific version
helm install test-uptime k3/uptime-kuma --version 1.3.0

Service Monitor

To use the ServiceMonitor you can enable it by adding serviceMonitor.enabled=true to your values.yaml

Usage

To use this you will have to startup uptime-kuma, go to Settings โ†’ API Keys โ†’ Create a key and copy the token. Then add a secret to your namespace that looks like the source file below. Make sure you fill in the username and the password. The username should be the username you use to login. The password should be the token you just generated. If you do not use Authentication in Kuma you can skip this part.

apiVersion: v1
kind: Secret
metadata:
  name: uptime-kuma-credentials
type: Opaque
data:
  username: <username>
  password: <token>

Custom Image

The custom image within this repo is built with the intent to repackage uptime-kuma in an OpenShift compatible way (i.e. to support and work properly with arbitrary UIDs), therefor the image is also a non-root image. It is used within this chat and its sources can be fund under the container folder within this repo or here:

link:./container/Containerfile[role=include]

I published a prebuilt version of this to Quay.io and reference that within the Chart, feel free to use that or build it yourself ๐Ÿ˜‰.

Alternatively, the image is also pushed to ghcr.io (GitHub Container registry) so there is a backup mirror when you run into issues with Quay.

Support

Important
Please note that this is plainly an UNOFFICIAL way to install uptime-kuma. So please do not expect to get help and or support in the official uptime-kuma issues or other forms of help sections!

This Helm Chart and the image where validated against Open Shift 4.x, yet they should work fine with regular Kubernetes.

I will try to keep this Chart and container image updated and operational, yet it may take me a moment to get to the latest uptime-kuma release (~1-2 days usually).

uptime-kuma-helm's People

Contributors

renovate[bot] avatar k3rnelpan1c-dev avatar glerb avatar vanhoutenbos avatar jefferyb avatar ricardoapl avatar dbluxo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.