Guides

These guides walk through the most common things you do as an operator: configuring your first health check, connecting a satellite, wiring up notifications, setting up SSO, managing teams, opening and resolving incidents, scheduling maintenance, installing plugins, getting started with GitOps, and silencing alerts during a known disruption.

If you are looking for the mental model behind these workflows, read the Concepts section first.

Set up your first health check From a blank install: create a system, attach an HTTP check, see the first result land.

Connect a satellite Mint a token, boot the satellite container, and pin checks to a remote vantage point.

Wire up Slack notifications Install the Slack plugin, register a webhook, and subscribe a system to it.

Configure SAML SSO Connect Checkstack to Okta or any SAML 2.0 IdP and map directory groups to roles.

Configure LDAP Connect Checkstack to LDAP or Active Directory and map memberOf groups to roles.

Create your first team Group users, grant the team access to specific resources, and verify scoping.

Open and resolve an incident Manually walk an incident from investigating through resolved, with status updates.

Schedule a maintenance window Pre-arm a planned disruption with suppression, post updates, and resolve cleanly.

Install a plugin Install a plugin from npm, GitHub release, or a tarball upload via the Plugin Manager.

GitOps quickstart Connect a Git repo, push a YAML descriptor, and watch the reconciler create the entity.

Silence alerts during an incident Three ways to silence: incident suppression, maintenance windows, per-subscription mute.