Joins this host with a token from Configure › Hosts, and writes agent.yaml. -config and -state-dir say where
obs-beacon-agent helper
The root helper (Linux). -listen (default /run/obs-beacon/helper.sock), -group (obs-beacon), -docker (/var/run/docker.sock), -config (the agent.yaml it reads cert_reload from)
obs-beacon-agent scan
The backup scan. -config (/etc/obs-beacon/backups.yaml), -host (default the agent's name), -out (/var/lib/obs-beacon-scan/backups.json)
obs-beacon-agent cluster
The cluster agent, run in a cluster by its manifest. -cert-scan=false stops the handshakes with Ingress and Route hosts; -cert-renew allows Renew now (Certificates)
obs-beacon-agent.exe service install [-config …]
Windows: installs or upgrades the service
obs-beacon-agent.exe service uninstall
Windows: removes the service, keeping ProgramData
systemd units
Unit
Package
Runs
obs-beacond.service
obs-beacon-server
The server, as obs-beacon
obs-beacon-agent.service
obs-beacon-agent
The agent, as obs-beacon
obs-beacon-agent-helper.service
obs-beacon-agent
The root helper
obs-beacon-scan.service, .timer
obs-beacon-agent
The backup scan, every 15 minutes
Logs are in the journal: journalctl -u obs-beacond. On Windows, the
Application event log, source obs-beacon-agent.
Endpoints for probes and scripts
Path
Port
GET /healthz
web and agent
ok <version> while the process runs: the liveness probe
GET /readyz
web and agent
ready <version> once this copy has caught up; 503 while starting or stopping. What a load balancer should check
GET /install.sh, /install.ps1
web
The host install scripts. No secrets in them
GET /cluster.yaml
web
The cluster agent's manifest; with a join token in Authorization: Bearer, its Secret too