Merge pull request #140 from josephpage/docs-more-examples

docs: add example(s) to notifier resource and region data-source
Scalingo · Mar 3, 2023 · 2ce5980 · 2ce5980
2 parents cd99f4c + a3ea587
commit 2ce5980
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 4 deletions.
diff --git a/docs/data-sources/region.md b/docs/data-sources/region.md
@@ -10,7 +10,17 @@ description: |-
 
 Scalingo Region metadata
 
+## Example Usage
 
+```terraform
+data "scalingo_region" "osc-fr1" {
+  name = "osc-fr1"
+}
+
+output "scalingo_dashboard" {
+  value = scalingo_region.osc-fr1.dashboard
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/notifier.md b/docs/resources/notifier.md
@@ -25,11 +25,34 @@ data_source "scalingo_notification_platform" "slack" {
 # application
 resource "scalingo_notifier" "all_events" {
   app             = scalingo_app.test_app.id
+  name            = "Slack Audit Notifier"
   platform_id     = data_source.scalingo_notification_platform.slack.id
-  webhook_id      = "https://hooks.slack.com/services/..."
+  
+  active          = true
+  send_all_events = true
+  webhook_url     = "https://hooks.slack.com/services/..."
+}
+
+# Create a notifier to get emails for all alerts and only selected critical
+# events on the application
+data_source "scalingo_notification_platform" "email" {
+  name = "email"
+}
 
+resource "scalingo_notifier" "all_events" {
+  app             = scalingo_app.test_app.id
   name            = "Email Audit Notifier"
-  send_all_events = true
+  platform_id     = data_source.scalingo_notification_platform.email.id
+  
+  send_all_alerts = true
+  selected_events = [
+    "addon_deleted",
+    "addon_suspended",
+    "app_crashed_repeated",
+    "domain_removed",
+    "notifier_removed",
+    "variable_removed",
+  ]
   emails          = ["[email protected]"]
 }
 ```

diff --git a/examples/data-sources/scalingo_region/data-source.tf b/examples/data-sources/scalingo_region/data-source.tf
@@ -0,0 +1,7 @@
+data "scalingo_region" "osc-fr1" {
+  name = "osc-fr1"
+}
+
+output "scalingo_dashboard" {
+  value = scalingo_region.osc-fr1.dashboard
+}
diff --git a/examples/resources/scalingo_notifier/resource.tf b/examples/resources/scalingo_notifier/resource.tf
@@ -10,10 +10,33 @@ data_source "scalingo_notification_platform" "slack" {
 # application
 resource "scalingo_notifier" "all_events" {
   app             = scalingo_app.test_app.id
+  name            = "Slack Audit Notifier"
   platform_id     = data_source.scalingo_notification_platform.slack.id
-  webhook_id      = "https://hooks.slack.com/services/..."
+
+  active          = true
+  send_all_events = true
+  webhook_url     = "https://hooks.slack.com/services/..."
+}
+
+# Create a notifier to get emails for all alerts and only selected critical
+# events on the application
+data_source "scalingo_notification_platform" "email" {
+  name = "email"
+}
 
+resource "scalingo_notifier" "all_events" {
+  app             = scalingo_app.test_app.id
   name            = "Email Audit Notifier"
-  send_all_events = true
+  platform_id     = data_source.scalingo_notification_platform.email.id
+
+  send_all_alerts = true
+  selected_events = [
+    "addon_deleted",
+    "addon_suspended",
+    "app_crashed_repeated",
+    "domain_removed",
+    "notifier_removed",
+    "variable_removed",
+  ]
   emails          = ["[email protected]"]
 }