Skip to content

Commit

Permalink
document how to use attachment_rule for automatic attachment (#134)
Browse files Browse the repository at this point in the history
Co-authored-by: Jeff Zellner <jz@FH-M759DWVH4J.local>
  • Loading branch information
Jeff Zellner and Jeff Zellner committed Sep 1, 2023
1 parent 4f2344b commit f3529f7
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions docs/guides/runbooks_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,19 @@ subcategory: "Runbooks"
FireHydrant runbooks allow you to configure and automate your incident response process by defining a workflow
to be followed when an incident occurs. Runbooks actually initiate actions that are fundamental steps to
resolving an incident. Such actions might be creating a Slack channel, starting a Zoom meeting, or opening
a Jira ticket. These actions are defined as steps in runbooks and each type of step requires different
configuration. FireHydrant has a number of integrations, each with different possible steps you can add
to your runbook.
a Jira ticket. These actions are defined as steps in runbooks and each type of step requires different
configuration. FireHydrant has a number of integrations, each with different possible steps you can add
to your runbook.

## Attachment Rule

To have a runbook automatically attach, set `attachment_rule` to an empty JSON chunk.

```
attachment_rule = jsonencode({})
```

Explicitly null values will assume the provider default, which is manual attachment.

## Step Configuration by Integration

Expand All @@ -29,4 +39,4 @@ to your runbook.
* [Statuspage](./runbooks_steps_statuspage.md)
* [VictorOps](./runbooks_steps_victorops.md)
* [Webex](./runbooks_steps_webex.md)
* [Zoom](./runbooks_steps_zoom.md)
* [Zoom](./runbooks_steps_zoom.md)

0 comments on commit f3529f7

Please sign in to comment.