Nomploy Nomad Packs

← All packs

checkmk v0.1.0

Observability

Checkmk Raw — a comprehensive IT infrastructure monitoring system for servers, network devices, containers and applications, with auto-discovery, dashboards and alerting. Deployed as a single host-networked Nomad service.

nomad-pack run checkmk --registry nomploy
…or one line (add registry + run)
curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- checkmk

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

1 task http 5000 1 volume image checkmk/check-mk-raw:2.4.0-latest pinned :2.4.0-latest image bumped today
Variables 10
values.hcl

Save as values.hcl, edit, then run:

nomad-pack run checkmk -f values.hcl --registry nomploy
# The name of the Nomad job.
job_name = "checkmk"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Checkmk Raw container image. Pin a tag in production.
image = "checkmk/check-mk-raw:2.4.0-latest"

# Host port for the Checkmk web UI.
port = 5000

# Password for the cmkadmin user, set on first start. CHANGE THIS.
admin_password = "checkmk_change_me"

# Timezone for the container (e.g. Europe/Bratislava).
timezone = "UTC"

# Named volume for Checkmk sites, config and monitoring data (/omd/sites).
data_volume = "checkmk_sites"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 1000
    memory = 2048
  }
NameTypeDefaultDescription
job_name string
"checkmk"
The name of the Nomad job.
namespace string
"default"
The Nomad namespace to deploy into.
datacenters list
["*"]
The datacenters to deploy to.
image string
"checkmk/check-mk-raw:2.4.0-latest"
The Checkmk Raw container image. Pin a tag in production.
port number
5000
Host port for the Checkmk web UI.
admin_password set me string
"checkmk_change_me"
Password for the cmkadmin user, set on first start. CHANGE THIS.
timezone string
"UTC"
Timezone for the container (e.g. Europe/Bratislava).
data_volume string
"checkmk_sites"
Named volume for Checkmk sites, config and monitoring data (/omd/sites).
constraints list
[]
Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources object
{
    cpu    = 1000
    memory = 2048
  }
The task resources.
Back up this pack

This pack stores data in one Docker named volume: checkmk_sites

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/checkmk_sites/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/checkmk_sites/_data backup:<bucket>/checkmk_sites

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

checkmk

Checkmk is a comprehensive IT infrastructure monitoring system. The Raw (open-source) edition monitors servers, network devices, cloud, containers and applications with powerful auto-discovery, thousands of built-in check plugins, flexible dashboards, event handling and alerting via email/SMS/webhooks — a strong alternative to Nagios/Zabbix.

This pack runs Checkmk Raw as a single host-networked Nomad service. On first start it creates a monitoring site named cmk.

Deploy

nomad-pack run checkmk --registry=nomploy \
  --var admin_password=$(openssl rand -hex 12) --var timezone=Europe/Bratislava

Open http://<node-ip>:5000/cmk/ and log in as cmkadmin.

Configuration

Variable Default Description
image checkmk/check-mk-raw:2.4.0-latest Container image (pin a tag in production).
port 5000 Host port for the web UI.
admin_password checkmk_change_me cmkadmin password — change this.
timezone UTC Container timezone.
data_volume checkmk_sites Volume for sites and data (/omd/sites).
resources 1000 MHz / 2048 MB CPU and memory for the task.

The cmk site, configuration and monitoring history persist in data_volume. The admin password is applied on the first start only.