Reference · 3 of 6
expected.yaml
What should run where: containers that must run or are stopped on purpose, services that must stay active, what's adopted in each cluster, and IBM i subsystems.
This is the file behind Adopt what's running on Configure › Hosts and
adopting on Configure › Clusters. Keep it in the web interface, or point
obs-beacond.yaml at a file with expected:, and the web interface shows it
read-only. Export YAML on Configure › Hosts writes the file from what's
there.
hosts:
web1:
running: # container names; * matches any run of characters
- shop-*
- nginx
stopped: # stopped on purpose: shown, never alerted on
- match: shop-migrate
note: Runs by hand before a release.
units: [nginx, cron] # services that must be active; nginx means nginx.service
win-fs01:
units: [LanmanServer, W32Time] # Windows services, by service name
ci_jobs: # CI job containers: counted, never listed
- GITEA-ACTIONS-TASK-*
clusters: # what's adopted in each cluster
prod:
namespaces: # a whole namespace: page, warn or off
shop: page
batch: warn
workloads: # namespace/kind/name; a VM's kind is vm
- name: shop/deployment/web # alert defaults to page
- name: shop/statefulset/db
alert: warn
- name: vms/vm/build-runner
stopped: true # a VM stopped on purpose
mgmt1:prod1: # an IBM i partition, by its source
subsystems: [QINTER, QBATCH, ORDLIB/ORDERS]
hosts
| Key | |
|---|---|
running |
Containers that must run. A pattern that matches nothing at all is critical: "Missing" |
stopped |
Containers stopped on purpose, each a match and a note. Shown, never alerted on; warns if one is running |
units |
systemd units, or Windows services, that must be active. One that isn't, or isn't installed, is critical |
On a host with any expectations, a running container that matches nothing warns "Not expected". How each case shows: How a container is judged.
ci_jobs
Patterns for short-lived CI job containers, which come and go: counted on the host, never listed or judged.
clusters
Keyed by the cluster's name, or for an IBM i partition by its source name
(<agent>:<name>).
| Key | |
|---|---|
namespaces |
A whole namespace: page, warn or off |
workloads |
One controller or VM by namespace/kind/name, with alert (page by default, warn or off) and, for a VM, stopped: true |
subsystems |
IBM i: subsystems that must be active. library/name when two libraries hold one of that name |
An adopted controller or VM that isn't in the cluster is reported missing. What wins when this and an annotation disagree: What pages.