From 06852e66b6f0372b2342ee70d283c647eac0a295 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20L=C3=B3pez?= Date: Tue, 21 Dec 2021 15:39:28 -0700 Subject: [PATCH 1/3] update docs for alert configuration in sms/email enabled parameter --- website/docs/d/alert_configuration.html.markdown | 4 ++-- website/docs/r/alert_configuration.html.markdown | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/d/alert_configuration.html.markdown b/website/docs/d/alert_configuration.html.markdown index acd5e8c937..69399c97cb 100644 --- a/website/docs/d/alert_configuration.html.markdown +++ b/website/docs/d/alert_configuration.html.markdown @@ -210,7 +210,7 @@ Notifications to send when an alert condition is detected. * `datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US. * `delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification. * `email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type. -* `email_enabled` - Flag indicating if email notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types. +* `email_enabled` - Flag indicating email notifications must be sent. Atlas returns this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. * `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. * `flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type * `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. * `ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US. * `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. * `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. -* `sms_enabled` - Flag indicating if text message notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types. +* `sms_enabled` - Flag indicating text notifications must be sent. Atlas returns this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. * `team_id` - Unique identifier of a team. * `type_name` - Type of alert notification. Accepted values are: diff --git a/website/docs/r/alert_configuration.html.markdown b/website/docs/r/alert_configuration.html.markdown index 2d4dc5ca29..c39ea45815 100644 --- a/website/docs/r/alert_configuration.html.markdown +++ b/website/docs/r/alert_configuration.html.markdown @@ -233,7 +233,7 @@ List of notifications to send when an alert condition is detected. * `datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US. * `delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification. * `email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type. -* `email_enabled` - Flag indicating if email notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types. +* `email_enabled` - Flag indicating email notifications must be sent. Set this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. * `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. * `flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type * `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. * `ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US. * `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. * `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. -* `sms_enabled` - Flag indicating if text message notifications should be sent. Configurable for `ORG`, `GROUP`, and `USER` notifications types. +* `sms_enabled` - Flag indicating if text message notifications should be sent to this user's mobile phone. Set this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. * `team_id` - Unique identifier of a team. * `type_name` - Type of alert notification. Accepted values are: From db60f8e551c347261e8253ad76316d309a7e8f25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20L=C3=B3pez?= Date: Tue, 21 Dec 2021 15:45:55 -0700 Subject: [PATCH 2/3] update docs for alert configuration in roles parameter --- website/docs/d/alert_configuration.html.markdown | 12 +----------- website/docs/r/alert_configuration.html.markdown | 2 +- 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/website/docs/d/alert_configuration.html.markdown b/website/docs/d/alert_configuration.html.markdown index 69399c97cb..4e048a49fc 100644 --- a/website/docs/d/alert_configuration.html.markdown +++ b/website/docs/d/alert_configuration.html.markdown @@ -241,16 +241,6 @@ Notifications to send when an alert condition is detected. * `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. * `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. -* `Roles` - The following roles grant privileges within a project. - - | Project roles | Organization roles | - |:---------- |:----------- | - | `GROUP_CHARTS_ADMIN` | `ORG_OWNER` | - | `GROUP_CLUSTER_MANAGER` | `ORG_MEMBER` | - | `GROUP_DATA_ACCESS_ADMIN` | `ORG_GROUP_CREATOR` | - | `GROUP_DATA_ACCESS_READ_ONLY` | `ORG_BILLING_ADMIN` | - | `GROUP_DATA_ACCESS_READ_WRITE` | `ORG_READ_ONLY` | - | `GROUP_OWNER` | | - | `GROUP_READ_ONLY` | | +* `roles` - Atlas role in current Project or Organization. Atlas returns this value if you set `type_name` to `ORG` or `GROUP`. See detailed information for arguments and attributes: [MongoDB API Alert Configuration](https://docs.atlas.mongodb.com/reference/api/alert-configurations-get-config/) \ No newline at end of file diff --git a/website/docs/r/alert_configuration.html.markdown b/website/docs/r/alert_configuration.html.markdown index c39ea45815..b6327179e1 100644 --- a/website/docs/r/alert_configuration.html.markdown +++ b/website/docs/r/alert_configuration.html.markdown @@ -263,7 +263,7 @@ List of notifications to send when an alert condition is detected. * `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. * `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. * `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. -* `Roles` - Optional. The following roles grant privileges within a project. +* `roles` - Optional. 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. Set this value if you set `type_name` to `ORG` or `GROUP`. Accepted values are: | Project roles | Organization roles | From ee9c418cd0c994fdf96883cdd0e7cde8486248d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20L=C3=B3pez?= Date: Wed, 22 Dec 2021 12:17:09 -0700 Subject: [PATCH 3/3] updated docs --- website/docs/d/alert_configuration.html.markdown | 4 ++-- website/docs/r/alert_configuration.html.markdown | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/d/alert_configuration.html.markdown b/website/docs/d/alert_configuration.html.markdown index 4e048a49fc..a0cc9b53df 100644 --- a/website/docs/d/alert_configuration.html.markdown +++ b/website/docs/d/alert_configuration.html.markdown @@ -210,7 +210,7 @@ Notifications to send when an alert condition is detected. * `datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US. * `delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification. * `email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type. -* `email_enabled` - Flag indicating email notifications must be sent. Atlas returns this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. +* `email_enabled` - Flag indicating email notifications should be sent. Atlas returns this value if `type_name` is set to `ORG`, `GROUP`, or `USER`. * `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. * `flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type * `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. * `ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US. * `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. * `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. -* `sms_enabled` - Flag indicating text notifications must be sent. Atlas returns this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. +* `sms_enabled` - Flag indicating text notifications should be sent. Atlas returns this value if `type_name` is set to `ORG`, `GROUP`, or `USER`. * `team_id` - Unique identifier of a team. * `type_name` - Type of alert notification. Accepted values are: diff --git a/website/docs/r/alert_configuration.html.markdown b/website/docs/r/alert_configuration.html.markdown index b6327179e1..13494019af 100644 --- a/website/docs/r/alert_configuration.html.markdown +++ b/website/docs/r/alert_configuration.html.markdown @@ -233,7 +233,7 @@ List of notifications to send when an alert condition is detected. * `datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US. * `delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification. * `email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type. -* `email_enabled` - Flag indicating email notifications must be sent. Set this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. +* `email_enabled` - Flag indicating email notifications should be sent. This flag is only valid if `type_name` is set to `ORG`, `GROUP`, or `USER`. * `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. * `flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type * `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. * `ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US. * `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. * `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. -* `sms_enabled` - Flag indicating if text message notifications should be sent to this user's mobile phone. Set this value if you set `type_name` to `ORG`, `GROUP`, or `USER`. +* `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`. * `team_id` - Unique identifier of a team. * `type_name` - Type of alert notification. Accepted values are: @@ -263,7 +263,7 @@ List of notifications to send when an alert condition is detected. * `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. * `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. * `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. -* `roles` - Optional. 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. Set this value if you set `type_name` to `ORG` or `GROUP`. +* `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`. Accepted values are: | Project roles | Organization roles |