liquidinvestigations/monitoring repository overview

⁠Liquid Investigations

This Repository is part of Liquid Investigations.

• Source Code for monitoring⁠
• Project Home Page⁠
• Security⁠
• Contribution Guide⁠
• Code of Conduct⁠

⁠Bunch of monitoring software

This repository uses k3s⁠ to deploy a bunch of monitoring backends and dashboards configured to work with Consul and Nomad, all this in a single isolated (althrough privileged) Docker container.

⁠Software installed

All these are stable helm charts:

• Sentry
• Prometheus, configured for Nomad
• Telegraf, configured for Consul
• Grafana

⁠Usage

First, set up your environment variabes:

cp examples/config.env .
vim config.env

Then, run the single monolith container, taking care to mount /data to a volume and to map your ports:

docker run
  --env-file config.env \
  --detach \
  --restart always \
  --name monitoring \
  --privileged \
  --tmpfs /run \
  --tmpfs /var/run \
  --publish 6443:6443 \
  --publish 6480:6480 \
  --volume /tmp/monitoring/data:/data \
  liquidinvestigations/monitoring

You can get all sorts of stats and secrets back from the deployment by running scripts in the container:

docker exec ./m.py healthcheck             # Checks that k3s and all helms are up
docker exec ./m.py kubectl get all         # Runs kubectl
docker exec ./m.py kubectl helm ls --all   # Runs helm
docker exec ./m.py sentry getdsn project1  # TODO - create sentry project
docker exec ./m.py getsecret sentry-admin  # TODO - get single specific secret from k3s
docker exec -it ./m.py bash

⁠Configuration

Configuration is passed through environment variables.

Configs about your already-running Nomad and Consul servers:

• NOMAD_URL
• CONSUL_URL
• ADDR

Configs about how to deploy the services:

• K3S_HTTPS_PORT, defaults 6443
• K3S_HTTP_PORT, defaults 6480
• SENTRY_HTTP_PORT, defaults 6643
• TELEGRAF_HTTP_PORT, defaults 6463
• GRAFANA_HTTP_PORT, defaults 6663
• PROMETHEUS_PORT, defaults 6446