.github/workflows/release.yml runs on GitHub when a v* tag arrives through the mirror: it waits for Gitea's Release, checks SHA256SUMS's signature and every file against it, copies the Release to GitHub and builds the server image from those same binaries as ghcr.io/coffey-labs/cairnobs:<version> (and :latest for a final release). Gitea doesn't read .github/workflows, and every job waits on BUILD_ON=github like the other mirrored repos. The docs, the kustomize base and the join.image example now name that image; the image's labels point at the source and the docs. The "Private until launch" lines are gone.
1.5 KiB
1.5 KiB
Cairn OBS (obs-beacon)
The new Cairn OBS: a self-hosted monitor for networks, hosts and
services, with maps, metrics, alerts and reports. obs-beacon-agent runs
on each host and reports to obs-beacond, which judges the reports,
runs the alerts and serves the web interface. Licensed AGPLv3; the
third-party code inside the binaries and its licenses are in
THIRD_PARTY_NOTICES.md.
The documentation for people installing it is at https://docs.cairnobs.org/. To report a security problem, see SECURITY.md. The notes below are for working on the code.
- docs/install.md: install the packages, make a release
- docs/kubernetes.md: the server on OpenShift, OKD or Kubernetes
- docs/container.md: the server in one container, with Docker or Podman
- docs/development.md: build, test, run it locally
- docs/protocol.md: how the agent reports
- docs/formats.md: config and expected-containers files
Layout
cmd/obs-beacond the server
cmd/obs-beacon-agent the agent, and its read-only root helper
internal/collect host readings from /proc and statfs
internal/docker Docker client and the helper's read-only gate
internal/report the wire format between them
internal/server API, judgement, sessions, embedded UI
web/ the Svelte 5 interface
config/ example configs
deploy/systemd/ unit files for the hosts