-
Notifications
You must be signed in to change notification settings - Fork 13
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.
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
update terraform integration documentation #381
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: | ||
|
||
* [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 API Webhook Integration](https://docs.rollbar.com/reference/put_api-1-notifications-webhook) | ||
* [Rollbar API Email Integration](https://docs.rollbar.com/reference/put_api-1-notifications-email) | ||
* [Rollbar API PagerDuty Integration](https://docs.rollbar.com/reference/put_api-1-notifications-pagerduty) | ||
|
||
Example Usage | ||
------------- | ||
|
@@ -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.some-website.com" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. some-website.com is a real URL. Can you change it to example.com? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
||
} | ||
} | ||
|
||
# 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 | ||
|
@@ -48,6 +81,22 @@ 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 | ||
------------------- | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done