docs: update docs around referencing teams in grafana_oncall_* resources (#2163)

* docs: update docs around referencing teams in `grafana_oncall_*` resources

* `go generate` output

* `terraform fmt -recursive && go generate ./...` output

Author: Joey Orlando

docs/data-sources/oncall_team.md

@@ -13,8 +13,12 @@ description: |-
 ## Example Usage
 
 ```terraform
-data "grafana_oncall_team" "example_team" {
-  name = "example_team"
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
 }
 ```
 

docs/resources/oncall_escalation_chain.md

@@ -13,9 +13,20 @@ description: |-
 ## Example Usage
 
 ```terraform
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
+
 resource "grafana_oncall_escalation_chain" "default" {
   provider = grafana.oncall
   name     = "default"
+
+  // Optional: specify the team to which the escalation chain belongs
+  team_id = data.grafana_oncall_team.my_team.id
 }
 ```
 
@@ -28,7 +39,7 @@ resource "grafana_oncall_escalation_chain" "default" {
 
 ### Optional
 
-- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
+- `team_id` (String) The ID of the OnCall team (using the `grafana_oncall_team` datasource).
 
 ### Read-Only
 

docs/resources/oncall_integration.md

@@ -14,10 +14,22 @@ description: |-
 ## Example Usage
 
 ```terraform
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
+
 resource "grafana_oncall_integration" "test-acc-integration" {
   provider = grafana.oncall
   name     = "my integration"
   type     = "grafana"
+
+  // Optional: specify the team to which the integration belongs
+  team_id = data.grafana_oncall_team.my_team.id
+
   default_route {
   }
 }
@@ -28,6 +40,10 @@ resource "grafana_oncall_integration" "integration_with_templates" {
   provider = grafana.oncall
   name     = "integration_with_templates"
   type     = "webhook"
+
+  // Optional: specify the team to which the integration belongs
+  team_id = data.grafana_oncall_team.my_team.id
+
   default_route {
   }
   templates {
@@ -56,7 +72,7 @@ resource "grafana_oncall_integration" "integration_with_templates" {
 ### Optional
 
 - `labels` (List of Map of String) A list of string-to-string mappings. Each map must include one key named "key" and one key named "value".
-- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
+- `team_id` (String) The ID of the OnCall team (using the `grafana_oncall_team` datasource).
 - `templates` (Block List, Max: 1) Jinja2 templates for Alert payload. An empty templates block will be ignored. (see [below for nested schema](#nestedblock--templates))
 
 ### Read-Only

docs/resources/oncall_on_call_shift.md

@@ -17,6 +17,14 @@ data "grafana_oncall_user" "alex" {
   username = "alex"
 }
 
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
+
 resource "grafana_oncall_on_call_shift" "example_shift" {
   name       = "Example Shift"
   type       = "recurrent_event"
@@ -30,6 +38,9 @@ resource "grafana_oncall_on_call_shift" "example_shift" {
     data.grafana_oncall_user.alex.id
   ]
   time_zone = "UTC"
+
+  // Optional: specify the team to which the on-call shift belongs
+  team_id = data.grafana_oncall_team.my_team.id
 }
 
 ////////
@@ -81,6 +92,9 @@ resource "grafana_oncall_on_call_shift" "emea_weekday_shift" {
     local.teams_map_of_user_id.emea,
   ]) : [k]]
   start_rotation_from_user_index = 0
+
+  // Optional: specify the team to which the on-call shift belongs
+  team_id = data.grafana_oncall_team.my_team.id
 }
 
 output "emea_weekday__rolling_users" {
@@ -108,7 +122,7 @@ output "emea_weekday__rolling_users" {
 - `level` (Number) The priority level. The higher the value, the higher the priority.
 - `rolling_users` (List of Set of String) The list of lists with on-call users (for rolling_users event type)
 - `start_rotation_from_user_index` (Number) The index of the list of users in rolling_users, from which on-call rotation starts.
-- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
+- `team_id` (String) The ID of the OnCall team (using the `grafana_oncall_team` datasource).
 - `time_zone` (String) The shift's timezone.  Overrides schedule's timezone.
 - `until` (String) The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
 - `users` (Set of String) The list of on-call users (for single_event and recurrent_event event type).

docs/resources/oncall_outgoing_webhook.md

@@ -13,10 +13,21 @@ description: |-
 ## Example Usage
 
 ```terraform
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
+
 resource "grafana_oncall_outgoing_webhook" "test-acc-outgoing_webhook" {
   provider = grafana.oncall
   name     = "my outgoing webhook"
   url      = "https://example.com/"
+
+  // Optional: specify the team to which the outgoing webhook belongs
+  team_id = data.grafana_oncall_team.my_team.id
 }
 ```
 
@@ -38,7 +49,7 @@ resource "grafana_oncall_outgoing_webhook" "test-acc-outgoing_webhook" {
 - `integration_filter` (List of String) Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
 - `is_webhook_enabled` (Boolean) Controls whether the outgoing webhook will trigger or is ignored. Defaults to `true`.
 - `password` (String, Sensitive) The auth data of the webhook. Used for Basic authentication
-- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
+- `team_id` (String) The ID of the OnCall team (using the `grafana_oncall_team` datasource).
 - `trigger_template` (String) A template used to dynamically determine whether the webhook should execute based on the content of the payload.
 - `trigger_type` (String) The type of event that will cause this outgoing webhook to execute. The types of triggers are: `escalation`, `alert group created`, `acknowledge`, `resolve`, `silence`, `unsilence`, `unresolve`, `unacknowledge`. Defaults to `escalation`.
 - `user` (String) Username to use when making the outgoing webhook request.

docs/resources/oncall_schedule.md

@@ -20,13 +20,24 @@ data "grafana_oncall_user_group" "example_user_group" {
   slack_handle = "example_slack_handle"
 }
 
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
 
 // ICal based schedule
 resource "grafana_oncall_schedule" "example_schedule" {
   name               = "Example Ical Schadule"
   type               = "ical"
   ical_url_primary   = "https://example.com/example_ical.ics"
   ical_url_overrides = "https://example.com/example_overrides_ical.ics"
+
+  // Optional: specify the team to which the schedule belongs
+  team_id = data.grafana_oncall_team.my_team.id
+
   slack {
     channel_id    = data.grafana_oncall_slack_channel.example_slack_channel.slack_id
     user_group_id = data.grafana_oncall_user_group.example_user_group.slack_id
@@ -38,6 +49,10 @@ resource "grafana_oncall_schedule" "example_schedule" {
   name      = "Example Calendar Schadule"
   type      = "calendar"
   time_zone = "America/New_York"
+
+  // Optional: specify the team to which the schedule belongs
+  team_id = data.grafana_oncall_team.my_team.id
+
   shifts = [
   ]
   ical_url_overrides = "https://example.com/example_overrides_ical.ics"
@@ -59,7 +74,7 @@ resource "grafana_oncall_schedule" "example_schedule" {
 - `ical_url_primary` (String) The URL of the external calendar iCal file.
 - `shifts` (Set of String) The list of ID's of on-call shifts.
 - `slack` (Block List, Max: 1) The Slack-specific settings for a schedule. (see [below for nested schema](#nestedblock--slack))
-- `team_id` (String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource.
+- `team_id` (String) The ID of the OnCall team (using the `grafana_oncall_team` datasource).
 - `time_zone` (String) The schedule's time zone.
 
 ### Read-Only

examples/data-sources/grafana_oncall_team/data-source.tf

@@ -1,3 +1,7 @@
-data "grafana_oncall_team" "example_team" {
-  name = "example_team"
-}
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}

examples/resources/grafana_oncall_escalation_chain/resource.tf

@@ -1,4 +1,15 @@
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
+
 resource "grafana_oncall_escalation_chain" "default" {
   provider = grafana.oncall
   name     = "default"
+
+  // Optional: specify the team to which the escalation chain belongs
+  team_id = data.grafana_oncall_team.my_team.id
 }

examples/resources/grafana_oncall_integration/resource.tf

@@ -1,7 +1,19 @@
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
+
 resource "grafana_oncall_integration" "test-acc-integration" {
   provider = grafana.oncall
   name     = "my integration"
   type     = "grafana"
+
+  // Optional: specify the team to which the integration belongs
+  team_id = data.grafana_oncall_team.my_team.id
+
   default_route {
   }
 }
@@ -12,6 +24,10 @@ resource "grafana_oncall_integration" "integration_with_templates" {
   provider = grafana.oncall
   name     = "integration_with_templates"
   type     = "webhook"
+
+  // Optional: specify the team to which the integration belongs
+  team_id = data.grafana_oncall_team.my_team.id
+
   default_route {
   }
   templates {

examples/resources/grafana_oncall_on_call_shift/resource.tf

@@ -2,6 +2,14 @@ data "grafana_oncall_user" "alex" {
   username = "alex"
 }
 
+data "grafana_team" "my_team" {
+  name = "my team"
+}
+
+data "grafana_oncall_team" "my_team" {
+  name = data.grafana_team.my_team.name
+}
+
 resource "grafana_oncall_on_call_shift" "example_shift" {
   name       = "Example Shift"
   type       = "recurrent_event"
@@ -15,6 +23,9 @@ resource "grafana_oncall_on_call_shift" "example_shift" {
     data.grafana_oncall_user.alex.id
   ]
   time_zone = "UTC"
+
+  // Optional: specify the team to which the on-call shift belongs
+  team_id = data.grafana_oncall_team.my_team.id
 }
 
 ////////
@@ -66,8 +77,11 @@ resource "grafana_oncall_on_call_shift" "emea_weekday_shift" {
     local.teams_map_of_user_id.emea,
   ]) : [k]]
   start_rotation_from_user_index = 0
+
+  // Optional: specify the team to which the on-call shift belongs
+  team_id = data.grafana_oncall_team.my_team.id
 }
 
 output "emea_weekday__rolling_users" {
   value = [for k in flatten(grafana_oncall_on_call_shift.emea_weekday_shift.rolling_users) : lookup(local.users_map_by_id, k).username]
-}
+}