Operator Runbooks
Runbooks are step-by-step procedures for operational tasks that are too detailed for the main reference docs. They are written for operators who need to carry out a specific action correctly the first time, often under pressure.
Each runbook follows the same structure:
- Pre-conditions: what must be true before you start
- Procedure: the exact steps, in order
- Verification: how to confirm the procedure succeeded
- Rollback: how to undo the change if something goes wrong (where applicable)
If you are not sure which runbook applies to your situation, start with Troubleshooting for boot failures and common errors, or run sudo hostcraftd doctor to get a summary of your server's health.
Available runbooks
Section titled “Available runbooks”| Runbook | When to use |
|---|---|
| IP Warmup | Ramping send volume on a fresh IP to build sender reputation |
| Cluster Certificate Rotation | Rotating the mTLS certificate for a cluster agent node |
| Cluster Node Decommission | Removing an agent node cleanly from the cluster |
| cPanel Cutover | Migrating a customer account from cPanel to HostCraft |
| Troubleshooting | Diagnosing and fixing common daemon, certificate, and service failures |
How these differ from the main docs
Section titled “How these differ from the main docs”The main documentation explains what each feature does and how it works. Runbooks assume you already understand the feature and need to perform a specific operational task without missing a step. When the main docs and a runbook conflict, the runbook takes precedence because it reflects the most recent operational experience.
Reporting gaps
Section titled “Reporting gaps”If you follow a runbook and something does not match what you see, email [email protected] with the page name. Runbooks that drift from reality cause incidents.