What You’ll Accomplish
Runbooks let you create reusable templates for common operations. Instead of typing the same queries or commands repeatedly, you can:- Create parameterized templates stored in Git
- Share approved procedures across your team
- Enforce input validation and safe defaults
- Maintain an audit trail of every execution
How It Works
Example Workflow
- DBA creates a runbook for looking up customer data
- Template stored in
runbooks/customer-lookup.runbook.sql - Support team selects the runbook, enters customer ID
- Query executes with proper validation and audit logging
Integration with Other Features
| Feature | How It Works with Runbooks |
|---|---|
| Access Requests | Runbook execution can require approval |
| Guardrails | Rules apply to runbook-generated queries |
| Live Data Masking | Results are masked automatically |
| Session Recording | All executions are recorded |
| Parallel Mode | Run runbooks across multiple resource roles |
Best Practices
Validate Inputs
Always use
pattern for user inputs to prevent injectionAdd Descriptions
Every parameter should have a clear description
Set Defaults
Provide sensible defaults where appropriate
Version Control
Store runbooks in Git for history and review
Ready to set it up? The Runbooks configuration guide covers connecting a Git repository, creating Runbooks rules, the template engine and functions, hooks, examples, and troubleshooting.
Next Steps
Configuration Guide
Detailed Git setup and template syntax
Parallel Mode
Run runbooks across multiple resource roles
Access Requests
Require approval for runbook execution
Session Recording
Audit runbook executions