Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update terraform integration documentation #381

Merged
merged 3 commits into from
Nov 6, 2023
Merged

update terraform integration documentation #381

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af647bb
update terraform integration documentation
pawelsz-rb Nov 4, 2023
3b04525
cleanup
pawelsz-rb Nov 4, 2023
bc0e7ba
addressing PR comments
pawelsz-rb Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions docs/resources/integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
`rollbar_integration` Resource
=========================

Rollbar projects can be configured with different notification integrations (aka "channels") and rules for when to send notifications to those integration platforms. This resource manages the configuration for the integrations(limited to the Slack channel at the moment) for the project configured for the Rollbar provider.
Rollbar projects can be configured with different notification integrations (aka "channels") and rules for when to send notifications to those integration platforms. This resource manages the configuration for the integrations(limited to the Slack, Webhook, Email and PagerDuty channels at the moment) for the project configured for the Rollbar provider.

This resource can manage configuration for the Slack channel. See the following api documentation for more details about the arguments with respect to the Slack channel:
This resource can manage configuration for the Slack, Webhook, Email and PagerDuty channels. See the following api documentation for more details about the arguments with respect to these channels:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link the respective documentation pages too?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


* [Rollbar API Slack Integration](https://docs.rollbar.com/reference/notification-channels)
* [Rollbar API Slack Integration](https://docs.rollbar.com/reference/put_api-1-notifications-slack), [Rollbar Slack Integration Documentation](https://docs.rollbar.com/docs/slack)
* [Rollbar API Webhook Integration](https://docs.rollbar.com/reference/put_api-1-notifications-webhook), [Rollbar Webhook Integration Documentation](https://docs.rollbar.com/docs/webhook)
* [Rollbar API PagerDuty Integration](https://docs.rollbar.com/reference/put_api-1-notifications-pagerduty), [Rollbar PagerDuty Integration Documentation](https://docs.rollbar.com/docs/pagerduty)
* [Rollbar API Email Integration](https://docs.rollbar.com/reference/put_api-1-notifications-email)

Example Usage
-------------
Expand Down Expand Up @@ -34,6 +37,36 @@ resource "rollbar_integration" "slack_integration" {
show_message_buttons = true
}
}

# Configure the Webhook integration for the project
#

resource "rollbar_integration" "webhook_integration" {
webhook {
enabled = true
url = "https://www.example.com"
}
}

# Configure the Email integration for the project
#

resource "rollbar_integration" "email_integration" {
email {
enabled = true
scrub_params = true
}
}

# Configure the PagerDuty integration for the project
#

resource "rollbar_integration" "pagerduty_integration" {
pagerduty {
enabled = false
service_key = "123456789"
}
}
```

Argument Reference
Expand All @@ -48,6 +81,21 @@ Slack:
* `channel` - (Required) The default Slack channel name to send the messages. Requires a `#` as a prefix
* `show_message_buttons` - Boolean that enables the Slack actionable buttons

Webhook:

* `enabled` - (Required) Boolean that enables the Webhook notifications globally
* `url` - (Required) URL for the webhook.

Email:

* `enabled` - (Required) Boolean that enables the Email notifications globally
* `scrub_params` - Optional Boolean that enables scrubbing param values (when set to true)

PagerDuty:

* `enabled` - (Required) Boolean that enables the PagerDuty notifications globally
* `service_key` - (Required) PagerDuty service key linked to PagerDuty account

Attribute Reference
-------------------

Expand Down
Loading