Executing Runbooks
Execute runbooks to follow documented procedures step by step.
Prerequisites
- Access to the project
- A published runbook to execute
Starting a Runbook
1. Navigate to Runbooks
Go to Runbooks in your project sidebar.
2. Find the Runbook
Locate the runbook you need from the list.
3. Click Execute
Click Execute to start the wizard interface.
Using the Wizard Interface
The wizard displays one step at a time with:
- Step number and title at the top
- Instructions in the main area
- Navigation buttons at the bottom
- Progress indicator showing current position
Navigating Steps
Next: Move to the next step after completing the current one.
Previous: Go back to review a previous step.
Skip: Skip optional steps (if the step allows it).
Following Decision Steps
When you reach a decision step:
- Read the decision question and instructions
- Evaluate the condition based on your situation
- Navigate to the appropriate step based on the outcome
Example decision step:
Step 5: Is the service running?
Check the status output from Step 4.
If YES - Continue to Step 6
If NO - Go to Step 10 (Restart Procedure) Tracking Progress
The wizard tracks:
- Which step you’re currently on
- Total number of steps
- Your progress through the runbook
Execution History
Each execution is recorded with:
- Start and completion time
- Who executed the runbook
- Which steps were completed
View execution history from the runbook’s detail page.
Tips for Success
Read each step fully Don’t rush. Read the complete instructions before taking action.
Verify actions Confirm each step completed successfully before moving on.
Use Previous when needed If you’re unsure, go back to review earlier steps.
Ask for help If a step is unclear, check with teammates before proceeding.
Common Issues
Can’t proceed to next step Ensure you’ve completed the current step’s required actions.
Wrong path taken Use Previous to navigate back and take the correct branch.
Step instructions unclear Review the full instructions and check for examples.
Result
Completing a runbook execution records the execution in the runbook’s history for tracking and auditing.
Related
- Runbooks Overview - Understanding runbooks
- Creating Runbooks - How to build runbooks
- Decision Steps - Conditional branching