Skip to content

Commit

Permalink
update runbook attachment documentation, prepare for 0.3.5 (#135)
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 5, 2023
1 parent f3529f7 commit 7401e33
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
## 0.3.5 (Unreleased)
## 0.3.6 (Unreleased)

## 0.3.5

* Use timestamps for data source IDs
* Better document how to have runbooks automatically attach

## 0.3.4

Expand Down
8 changes: 8 additions & 0 deletions docs/guides/runbooks_conditional_logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ attachment attributes endpoint.
https://api.firehydrant.io/v1/fh-attributes/data_bags/system-runbook-attachment-attributes
```

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.

In the example payload below you can see that we have a list of attributes that can be selected and we can see
the `opcode` or operators that can be used for these attributes. Given these operators, we can infer that we can
either have a condition where the Slack channel does or does not exist.
Expand Down
10 changes: 0 additions & 10 deletions docs/guides/runbooks_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,6 @@ a Jira ticket. These actions are defined as steps in runbooks and each type of s
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

* [Confluence Cloud](./runbooks_steps_confluence_cloud.md)
Expand Down

0 comments on commit 7401e33

Please sign in to comment.