docs
cairnobs.org Demo Source
Esc

Reference · 4 of 6

topology.yaml

Corrections and names for the maps, in a file: a site's name, hosts' roles, and services you declare with what they need and what they're made of. Nothing in it is needed for the maps to draw.

1 min read

The maps draw themselves from what the agents see. This file corrects and names what's found, for people who keep their setup in git. Point obs-beacond.yaml at it with topology:; it's read again when it changes. The same corrections can be made on the maps themselves.

network:
  site: "Datacenter · Rack A"     # the site holding most of these hosts
  hosts:
    - {name: web1, roles: "web · shop"}
    - {name: db1, roles: "PostgreSQL primary"}
  remote:                          # hosts outside the site
    - {name: desk1, roles: "the office"}

services:
  - id: shop
    name: Shop
    tier: apps                     # edge, public, apps or data
    needs: [postgres, redis]       # service ids or host names
    checks: [site]                 # check ids
    containers: ["*/shop-*"]       # host/pattern; * for any host
  - id: postgres
    name: PostgreSQL
    tier: data
    units: ["db*/postgresql"]      # a unit without a type is a .service
  - id: edge
    name: Cloudflare
    tier: edge
    cloudflare: true               # takes the Cloudflare conditions as its own

network

Key
site The name of the site holding most of the hosts listed
hosts Hosts in it, each with name and roles: a few words for its card
remote Hosts outside the site, with name and roles

Every host named must be a Cairn OBS host.

services

Key
id, name
tier edge, public, apps or data
needs Service ids or host names. These are declared dependencies, which group alerts
checks Check ids that are part of it
containers, units host/pattern or */pattern. Each service claims what its patterns match
cloudflare true: Cloudflare's trouble is this service's

A service's state is the worst of its parts, and its history is kept for the Reports page. A declared service nothing matches is still drawn.