feat(team notification channels): add includeAdminUsers attribute (#672)

dbonf · web-flow · commit a6dd1ca98294 · 2025-10-28T12:58:19.000+01:00
add new attribute to team notification channels: `includeAdminUsers`,
default, false, if enabled, will also include system wide admin users
(that are implicilty belonging to any team) to team notification channel
notifications.
diff --git a/sysdig/data_source_sysdig_monitor_notification_channel_team_email.go b/sysdig/data_source_sysdig_monitor_notification_channel_team_email.go
@@ -24,6 +24,10 @@ func dataSourceSysdigMonitorNotificationChannelTeamEmail() *schema.Resource {
 				Type:     schema.TypeInt,
 				Computed: true,
 			},
+			"include_admin_users": {
+				Type:     schema.TypeBool,
+				Computed: true,
+			},
 		}),
 	}
 }
diff --git a/sysdig/data_source_sysdig_monitor_notification_channel_team_email_test.go b/sysdig/data_source_sysdig_monitor_notification_channel_team_email_test.go
@@ -14,7 +14,7 @@ import (
 )
 
 func TestAccMonitorNotificationChannelTeamEmailDataSource(t *testing.T) {
-	rText := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
+	rText := func() string { return acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum) }
 
 	resource.ParallelTest(t, resource.TestCase{
 		PreCheck: sysdigOrIBMMonitorPreCheck(t),
@@ -25,11 +25,21 @@ func TestAccMonitorNotificationChannelTeamEmailDataSource(t *testing.T) {
 		},
 		Steps: []resource.TestStep{
 			{
-				Config: monitorNotificationChannelTeamEmail(rText),
+				Config: monitorNotificationChannelTeamEmail(rText()),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email", "id", "sysdig_monitor_notification_channel_team_email.nc_team_email", "id"),
 					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email", "name", "sysdig_monitor_notification_channel_team_email.nc_team_email", "name"),
 					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email", "team_id", "sysdig_monitor_notification_channel_team_email.nc_team_email", "team_id"),
+					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email", "include_admin_users", "sysdig_monitor_notification_channel_team_email.nc_team_email", "include_admin_users"),
+				),
+			},
+			{
+				Config: resourceMonitorNotificationChannelTeamEmailWithIncludeAdminUsers(rText()),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email_2", "id", "sysdig_monitor_notification_channel_team_email.nc_team_email_2", "id"),
+					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email_2", "name", "sysdig_monitor_notification_channel_team_email.nc_team_email_2", "name"),
+					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email_2", "team_id", "sysdig_monitor_notification_channel_team_email.nc_team_email_2", "team_id"),
+					resource.TestCheckResourceAttrPair("data.sysdig_monitor_notification_channel_team_email.nc_team_email_2", "include_admin_users", "sysdig_monitor_notification_channel_team_email.nc_team_email_2", "include_admin_users"),
 				),
 			},
 		},
@@ -54,3 +64,23 @@ data "sysdig_monitor_notification_channel_team_email" "nc_team_email" {
 }
 `, name, name)
 }
+
+func resourceMonitorNotificationChannelTeamEmailWithIncludeAdminUsers(name string) string {
+	return fmt.Sprintf(`
+	resource "sysdig_monitor_team" "sample_data_2" {
+		name = "monitor-sample-data-%s"
+		entrypoint {
+		type = "Explore"
+		}
+	}
+resource "sysdig_monitor_notification_channel_team_email" "nc_team_email_2" {
+	name = "%s"
+	team_id = sysdig_monitor_team.sample_data_2.id
+	include_admin_users = true
+}
+
+data "sysdig_monitor_notification_channel_team_email" "nc_team_email_2" {
+	name = sysdig_monitor_notification_channel_team_email.nc_team_email_2.name
+}
+`, name, name)
+}
diff --git a/sysdig/data_source_sysdig_secure_notification_channel_team_email.go b/sysdig/data_source_sysdig_secure_notification_channel_team_email.go
@@ -24,6 +24,10 @@ func dataSourceSysdigSecureNotificationChannelTeamEmail() *schema.Resource {
 				Type:     schema.TypeInt,
 				Computed: true,
 			},
+			"include_admin_users": {
+				Type:     schema.TypeBool,
+				Computed: true,
+			},
 		}),
 	}
 }
diff --git a/sysdig/data_source_sysdig_secure_notification_channel_team_email_test.go b/sysdig/data_source_sysdig_secure_notification_channel_team_email_test.go
@@ -14,7 +14,7 @@ import (
 )
 
 func TestAccSecureNotificationChannelTeamEmailDataSource(t *testing.T) {
-	rText := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
+	rText := func() string { return acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum) }
 
 	resource.ParallelTest(t, resource.TestCase{
 		PreCheck: preCheckAnyEnv(t, SysdigSecureApiTokenEnv, SysdigIBMSecureAPIKeyEnv),
@@ -25,11 +25,21 @@ func TestAccSecureNotificationChannelTeamEmailDataSource(t *testing.T) {
 		},
 		Steps: []resource.TestStep{
 			{
-				Config: secureNotificationChannelTeamEmail(rText),
+				Config: secureNotificationChannelTeamEmail(rText()),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email", "id", "sysdig_secure_notification_channel_team_email.nc_team_email", "id"),
 					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email", "name", "sysdig_secure_notification_channel_team_email.nc_team_email", "name"),
 					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email", "team_id", "sysdig_secure_notification_channel_team_email.nc_team_email", "team_id"),
+					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email", "include_admin_users", "sysdig_secure_notification_channel_team_email.nc_team_email", "include_admin_users"),
+				),
+			},
+			{
+				Config: resourceSecureNotificationChannelTeamEmailWithIncludeAdminUsers(rText()),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email_2", "id", "sysdig_secure_notification_channel_team_email.nc_team_email_2", "id"),
+					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email_2", "name", "sysdig_secure_notification_channel_team_email.nc_team_email_2", "name"),
+					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email_2", "team_id", "sysdig_secure_notification_channel_team_email.nc_team_email_2", "team_id"),
+					resource.TestCheckResourceAttrPair("data.sysdig_secure_notification_channel_team_email.nc_team_email_2", "include_admin_users", "sysdig_secure_notification_channel_team_email.nc_team_email_2", "include_admin_users"),
 				),
 			},
 		},
@@ -52,3 +62,21 @@ data "sysdig_secure_notification_channel_team_email" "nc_team_email" {
 }
 `, name, name)
 }
+
+func resourceSecureNotificationChannelTeamEmailWithIncludeAdminUsers(name string) string {
+	return fmt.Sprintf(`
+	resource "sysdig_secure_team" "sample_data_2" {
+		name = "secure-sample-data-%s"
+		all_zones = "true"
+	}
+resource "sysdig_secure_notification_channel_team_email" "nc_team_email_2" {
+	name = "%s"
+	team_id = sysdig_secure_team.sample_data_2.id
+	include_admin_users = true
+}
+
+data "sysdig_secure_notification_channel_team_email" "nc_team_email_2" {
+	name = sysdig_secure_notification_channel_team_email.nc_team_email_2.name
+}
+`, name, name)
+}
diff --git a/sysdig/internal/client/v2/model.go b/sysdig/internal/client/v2/model.go
@@ -130,6 +130,7 @@ type NotificationChannelOptions struct {
 	Region                   string                                     `json:"region,omitempty"`                   // Type: OpsGenie
 	AllowInsecureConnections *bool                                      `json:"allowInsecureConnections,omitempty"` // Type: prometheus alert manager, custom webhook, Webhook
 	TeamID                   int                                        `json:"teamId,omitempty"`                   // Type: team email
+	IncludeAdminUsers        *bool                                      `json:"includeAdminUsers,omitempty"`        // Type: team email
 	HTTPMethod               string                                     `json:"httpMethod,omitempty"`               // Type: custom webhook
 	MonitorTemplate          string                                     `json:"monitorTemplate,omitempty"`          // Type: custom webhook
 	InstanceID               string                                     `json:"instanceId,omitempty"`               // Type: ibm event notification
diff --git a/sysdig/resource_sysdig_monitor_notification_channel_team_email.go b/sysdig/resource_sysdig_monitor_notification_channel_team_email.go
@@ -36,6 +36,11 @@ func resourceSysdigMonitorNotificationChannelTeamEmail() *schema.Resource {
 				Type:     schema.TypeInt,
 				Required: true,
 			},
+			"include_admin_users": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  false,
+			},
 		}),
 	}
 }
@@ -141,6 +146,8 @@ func monitorNotificationChannelTeamEmailFromResourceData(d *schema.ResourceData,
 
 	nc.Type = notificationChannelTypeTeamEmail
 	nc.Options.TeamID = d.Get("team_id").(int)
+	includeAdminUsers := d.Get("include_admin_users").(bool)
+	nc.Options.IncludeAdminUsers = &includeAdminUsers
 	return nc, err
 }
 
@@ -151,6 +158,9 @@ func monitorNotificationChannelTeamEmailToResourceData(nc *v2.NotificationChanne
 	}
 
 	_ = d.Set("team_id", nc.Options.TeamID)
+	if nc.Options.IncludeAdminUsers != nil {
+		_ = d.Set("include_admin_users", *nc.Options.IncludeAdminUsers)
+	}
 
 	return err
 }
diff --git a/sysdig/resource_sysdig_monitor_notification_channel_team_email_test.go b/sysdig/resource_sysdig_monitor_notification_channel_team_email_test.go
@@ -42,6 +42,15 @@ func TestAccMonitorNotificationChannelTeamEmail(t *testing.T) {
 				ImportStateVerify:       true,
 				ImportStateVerifyIgnore: []string{"send_test_notification"},
 			},
+			{
+				Config: monitorNotificationChannelTeamEmailWithIncludeAdminUsers(rText()),
+			},
+			{
+				ResourceName:            "sysdig_monitor_notification_channel_team_email.sample_team_email3",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"send_test_notification"},
+			},
 		},
 	})
 }
@@ -51,7 +60,7 @@ func monitorNotificationChannelTeamEmailWithName(name string) string {
 resource "sysdig_monitor_team" "sample1" {
 	name = "monitor-sample-%s"
 	entrypoint {
-	type = "Explore"
+		type = "Explore"
 	}
 }
 resource "sysdig_monitor_notification_channel_team_email" "sample_team_email1" {
@@ -68,7 +77,7 @@ func monitorNotificationChannelTeamEmailSharedWithCurrentTeam(name string) strin
 resource "sysdig_monitor_team" "sample2" {
 	name = "monitor-sample-%s"
 	entrypoint {
-	type = "Explore"
+		type = "Explore"
 	}
 }
 resource "sysdig_monitor_notification_channel_team_email" "sample_team_email2" {
@@ -80,3 +89,21 @@ resource "sysdig_monitor_notification_channel_team_email" "sample_team_email2" {
 	share_with_current_team = true
 }`, name, name)
 }
+
+func monitorNotificationChannelTeamEmailWithIncludeAdminUsers(name string) string {
+	return fmt.Sprintf(`
+resource "sysdig_monitor_team" "sample3" {
+	name = "monitor-sample-%s"
+	entrypoint {
+		type = "Explore"
+	}
+}
+resource "sysdig_monitor_notification_channel_team_email" "sample_team_email3" {
+	name = "Example Channel %s - team email"
+	enabled = true
+	team_id = sysdig_monitor_team.sample3.id
+	include_admin_users = true
+	notify_when_ok = true
+	notify_when_resolved = true
+}`, name, name)
+}
diff --git a/sysdig/resource_sysdig_secure_notification_channel_team_email.go b/sysdig/resource_sysdig_secure_notification_channel_team_email.go
@@ -36,6 +36,11 @@ func resourceSysdigSecureNotificationChannelTeamEmail() *schema.Resource {
 				Type:     schema.TypeInt,
 				Required: true,
 			},
+			"include_admin_users": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  false,
+			},
 		}),
 	}
 }
@@ -141,6 +146,8 @@ func secureNotificationChannelTeamEmailFromResourceData(d *schema.ResourceData,
 
 	nc.Type = notificationChannelTypeTeamEmail
 	nc.Options.TeamID = d.Get("team_id").(int)
+	includeAdminUsers := d.Get("include_admin_users").(bool)
+	nc.Options.IncludeAdminUsers = &includeAdminUsers
 	return nc, err
 }
 
@@ -151,6 +158,9 @@ func secureNotificationChannelTeamEmailToResourceData(nc *v2.NotificationChannel
 	}
 
 	_ = d.Set("team_id", nc.Options.TeamID)
+	if nc.Options.IncludeAdminUsers != nil {
+		_ = d.Set("include_admin_users", *nc.Options.IncludeAdminUsers)
+	}
 
 	return err
 }
diff --git a/sysdig/resource_sysdig_secure_notification_channel_team_email_test.go b/sysdig/resource_sysdig_secure_notification_channel_team_email_test.go
@@ -42,6 +42,15 @@ func TestAccSecureNotificationChannelTeamEmail(t *testing.T) {
 				ImportStateVerify:       true,
 				ImportStateVerifyIgnore: []string{"send_test_notification"},
 			},
+			{
+				Config: secureNotificationChannelTeamEmailWithIncludeAdminUsers(rText()),
+			},
+			{
+				ResourceName:            "sysdig_secure_notification_channel_team_email.sample_team_email3",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"send_test_notification"},
+			},
 		},
 	})
 }
@@ -76,3 +85,19 @@ resource "sysdig_secure_notification_channel_team_email" "sample_team_email2" {
 	share_with_current_team = true
 }`, name, name)
 }
+
+func secureNotificationChannelTeamEmailWithIncludeAdminUsers(name string) string {
+	return fmt.Sprintf(`
+resource "sysdig_secure_team" "sample3" {
+	name = "secure-sample-%s"
+	all_zones = "true"
+}
+resource "sysdig_secure_notification_channel_team_email" "sample_team_email3" {
+	name = "Example Channel %s - team email"
+	enabled = true
+	team_id = sysdig_secure_team.sample3.id
+	include_admin_users = true
+	notify_when_ok = true
+	notify_when_resolved = true
+}`, name, name)
+}
diff --git a/website/docs/d/monitor_notification_channel_team_email.md b/website/docs/d/monitor_notification_channel_team_email.md
@@ -31,6 +31,7 @@ In addition to all arguments above, the following attributes are exported:
 * `id` - The Notification Channel ID.
 * `name` - The Notification Channel Name.
 * `team_id` - id of the team.
+* `include_admin_users` - Whether the Notification Channel includes admin users in notifications.
 * `enabled` - Whether the Notification Channel is active or not.
 * `notify_when_ok` - Whether the Notification Channel sends a notification when the condition is no longer triggered.
 * `notify_when_resolved` - Whether the Notification Channel sends a notification if it's manually acknowledged by a
diff --git a/website/docs/d/secure_notification_channel_team_email.md b/website/docs/d/secure_notification_channel_team_email.md
@@ -31,6 +31,7 @@ In addition to all arguments above, the following attributes are exported:
 * `id` - The Notification Channel ID.
 * `name` - The Notification Channel Name.
 * `team_id` - id of the team.
+* `include_admin_users` - Whether the Notification Channel includes admin users in notifications.
 * `enabled` - Whether the Notification Channel is active or not.
 * `notify_when_ok` - Whether the Notification Channel sends a notification when the condition is no longer triggered.
 * `notify_when_resolved` - Whether the Notification Channel sends a notification if it's manually acknowledged by a
diff --git a/website/docs/r/monitor_notification_channel_team_email.md b/website/docs/r/monitor_notification_channel_team_email.md
@@ -15,9 +15,10 @@ Creates a Sysdig Monitor Notification Channel of type Team Email.
 ## Example Usage
 
 ```terraform
-resource "sysdig_monitor_notification_channel_team_email" "sample-gchat" {
+resource "sysdig_monitor_notification_channel_team_email" "sample-team-email" {
   name                    = "Example Channel - team email"
   team_id                 = 1
+  include_admin_users     = false
   enabled                 = true
   notify_when_ok          = false
   notify_when_resolved    = false
@@ -31,6 +32,8 @@ resource "sysdig_monitor_notification_channel_team_email" "sample-gchat" {
 
 * `team_id` - (Required) id of the team.
 
+* `include_admin_users` - (Optional) If set to `true`, it will include admin users in notifications. Default is false.
+
 * `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
 
 * `notify_when_ok` - (Optional) Send a new notification when the alert condition is
diff --git a/website/docs/r/secure_notification_channel_team_email.md b/website/docs/r/secure_notification_channel_team_email.md
@@ -15,9 +15,10 @@ Creates a Sysdig Secure Notification Channel of type Team Email.
 ## Example Usage
 
 ```terraform
-resource "sysdig_secure_notification_channel_team_email" "sample-gchat" {
+resource "sysdig_secure_notification_channel_team_email" "sample-team-email" {
   name                    = "Example Channel - team email"
   team_id                 = 1
+  include_admin_users     = false
   enabled                 = true
   notify_when_ok          = false
   notify_when_resolved    = false
@@ -31,6 +32,8 @@ resource "sysdig_secure_notification_channel_team_email" "sample-gchat" {
 
 * `team_id` - (Required) id of the team.
 
+* `include_admin_users` - (Optional) If set to `true`, it will include admin users in notifications. Default is false.
+
 * `enabled` - (Optional) If false, the channel will not emit notifications. Default is true.
 
 * `notify_when_ok` - (Optional) Send a new notification when the alert condition is

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,10 @@ func dataSourceSysdigMonitorNotificationChannelTeamEmail() *schema.Resource {`
`24`	`24`	`Type: schema.TypeInt,`
`25`	`25`	`Computed: true,`
`26`	`26`	`},`
	`27`	`+ "include_admin_users": {`
	`28`	`+ Type: schema.TypeBool,`
	`29`	`+ Computed: true,`
	`30`	`+ },`
`27`	`31`	`}),`
`28`	`32`	`}`
`29`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,11 @@ func resourceSysdigMonitorNotificationChannelTeamEmail() *schema.Resource {`
`36`	`36`	`Type: schema.TypeInt,`
`37`	`37`	`Required: true,`
`38`	`38`	`},`
	`39`	`+ "include_admin_users": {`
	`40`	`+ Type: schema.TypeBool,`
	`41`	`+ Optional: true,`
	`42`	`+ Default: false,`
	`43`	`+ },`
`39`	`44`	`}),`
`40`	`45`	`}`
`41`	`46`	`}`
`@@ -141,6 +146,8 @@ func monitorNotificationChannelTeamEmailFromResourceData(d *schema.ResourceData,`
`141`	`146`
`142`	`147`	`nc.Type = notificationChannelTypeTeamEmail`
`143`	`148`	`nc.Options.TeamID = d.Get("team_id").(int)`
	`149`	`+ includeAdminUsers := d.Get("include_admin_users").(bool)`
	`150`	`+ nc.Options.IncludeAdminUsers = &includeAdminUsers`
`144`	`151`	`return nc, err`
`145`	`152`	`}`
`146`	`153`
`@@ -151,6 +158,9 @@ func monitorNotificationChannelTeamEmailToResourceData(nc *v2.NotificationChanne`
`151`	`158`	`}`
`152`	`159`
`153`	`160`	`_ = d.Set("team_id", nc.Options.TeamID)`
	`161`	`+ if nc.Options.IncludeAdminUsers != nil {`
	`162`	`+ _ = d.Set("include_admin_users", *nc.Options.IncludeAdminUsers)`
	`163`	`+ }`
`154`	`164`
`155`	`165`	`return err`
`156`	`166`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,11 @@ func resourceSysdigSecureNotificationChannelTeamEmail() *schema.Resource {`
`36`	`36`	`Type: schema.TypeInt,`
`37`	`37`	`Required: true,`
`38`	`38`	`},`
	`39`	`+ "include_admin_users": {`
	`40`	`+ Type: schema.TypeBool,`
	`41`	`+ Optional: true,`
	`42`	`+ Default: false,`
	`43`	`+ },`
`39`	`44`	`}),`
`40`	`45`	`}`
`41`	`46`	`}`
`@@ -141,6 +146,8 @@ func secureNotificationChannelTeamEmailFromResourceData(d *schema.ResourceData,`
`141`	`146`
`142`	`147`	`nc.Type = notificationChannelTypeTeamEmail`
`143`	`148`	`nc.Options.TeamID = d.Get("team_id").(int)`
	`149`	`+ includeAdminUsers := d.Get("include_admin_users").(bool)`
	`150`	`+ nc.Options.IncludeAdminUsers = &includeAdminUsers`
`144`	`151`	`return nc, err`
`145`	`152`	`}`
`146`	`153`
`@@ -151,6 +158,9 @@ func secureNotificationChannelTeamEmailToResourceData(nc *v2.NotificationChannel`
`151`	`158`	`}`
`152`	`159`
`153`	`160`	`_ = d.Set("team_id", nc.Options.TeamID)`
	`161`	`+ if nc.Options.IncludeAdminUsers != nil {`
	`162`	`+ _ = d.Set("include_admin_users", *nc.Options.IncludeAdminUsers)`
	`163`	`+ }`
`154`	`164`
`155`	`165`	`return err`
`156`	`166`	`}`