Skip to content

Commit a764900

Browse files
authored
INTMDB-284: Updated docs in alert configuration resource and datasource (#645)
* update docs for alert configuration in sms/email enabled parameter * update docs for alert configuration in roles parameter * updated docs
1 parent 474f8e4 commit a764900

File tree

2 files changed

+6
-16
lines changed

2 files changed

+6
-16
lines changed

website/docs/d/alert_configuration.html.markdown

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ Notifications to send when an alert condition is detected.
210210
* `datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US.
211211
* `delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification.
212212
* `email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type.
213-
* `email_enabled` - Flag indicating if email notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types.
213+
* `email_enabled` - Flag indicating email notifications should be sent. Atlas returns this value if `type_name` is set to `ORG`, `GROUP`, or `USER`.
214214
* `flowdock_api_token` - The Flowdock personal API token. Required for the `FLOWDOCK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
215215
* `flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type
216216
* `interval_min` - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
@@ -219,7 +219,7 @@ Notifications to send when an alert condition is detected.
219219
* `ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US.
220220
* `org_name` - Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
221221
* `service_key` - PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
222-
* `sms_enabled` - Flag indicating if text message notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types.
222+
* `sms_enabled` - Flag indicating text notifications should be sent. Atlas returns this value if `type_name` is set to `ORG`, `GROUP`, or `USER`.
223223
* `team_id` - Unique identifier of a team.
224224
* `team_name` - Label for the team that receives this notification.
225225
* `type_name` - Type of alert notification.
@@ -242,16 +242,6 @@ Notifications to send when an alert condition is detected.
242242
* `victor_ops_api_key` - VictorOps API key. Required for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
243243
* `victor_ops_routing_key` - VictorOps routing key. Optional for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
244244

245-
* `Roles` - The following roles grant privileges within a project.
246-
247-
| Project roles | Organization roles |
248-
|:---------- |:----------- |
249-
| `GROUP_CHARTS_ADMIN` | `ORG_OWNER` |
250-
| `GROUP_CLUSTER_MANAGER` | `ORG_MEMBER` |
251-
| `GROUP_DATA_ACCESS_ADMIN` | `ORG_GROUP_CREATOR` |
252-
| `GROUP_DATA_ACCESS_READ_ONLY` | `ORG_BILLING_ADMIN` |
253-
| `GROUP_DATA_ACCESS_READ_WRITE` | `ORG_READ_ONLY` |
254-
| `GROUP_OWNER` | |
255-
| `GROUP_READ_ONLY` | |
245+
* `roles` - Atlas role in current Project or Organization. Atlas returns this value if you set `type_name` to `ORG` or `GROUP`.
256246

257247
See detailed information for arguments and attributes: [MongoDB API Alert Configuration](https://docs.atlas.mongodb.com/reference/api/alert-configurations-get-config/)

website/docs/r/alert_configuration.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ List of notifications to send when an alert condition is detected.
233233
* `datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US.
234234
* `delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification.
235235
* `email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type.
236-
* `email_enabled` - Flag indicating if email notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types.
236+
* `email_enabled` - Flag indicating email notifications should be sent. This flag is only valid if `type_name` is set to `ORG`, `GROUP`, or `USER`.
237237
* `flowdock_api_token` - The Flowdock personal API token. Required for the `FLOWDOCK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
238238
* `flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type
239239
* `interval_min` - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5. **NOTE** `PAGER_DUTY`, `VICTOR_OPS`, and `OPS_GENIE` notifications do not return this value. The notification interval must be configured and managed within each external service.
@@ -242,7 +242,7 @@ List of notifications to send when an alert condition is detected.
242242
* `ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US.
243243
* `org_name` - Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
244244
* `service_key` - PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
245-
* `sms_enabled` - Flag indicating if text message notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types.
245+
* `sms_enabled` - Flag indicating if text message notifications should be sent to this user's mobile phone. This flag is only valid if `type_name` is set to `ORG`, `GROUP`, or `USER`.
246246
* `team_id` - Unique identifier of a team.
247247
* `team_name` - Label for the team that receives this notification.
248248
* `type_name` - Type of alert notification.
@@ -264,7 +264,7 @@ List of notifications to send when an alert condition is detected.
264264
* `username` - Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the `USER` notifications type.
265265
* `victor_ops_api_key` - VictorOps API key. Required for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
266266
* `victor_ops_routing_key` - VictorOps routing key. Optional for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
267-
* `Roles` - Optional. The following roles grant privileges within a project.
267+
* `roles` - Optional. One or more roles that receive the configured alert. If you include this field, Atlas sends alerts only to users assigned the roles you specify in the array. If you omit this field, Atlas sends alerts to users assigned any role. This parameter is only valid if `type_name` is set to `ORG`, `GROUP`, or `USER`.
268268
Accepted values are:
269269

270270
| Project roles | Organization roles |

0 commit comments

Comments
 (0)