New: add group_settings support INPRO-372

README.md

@@ -4,7 +4,7 @@ IAC Implementation for User- and Group Management in Google Workspace (formerly
 ## How to use this module
 
 This repo has the following folder structure:
-* [modules](modules/): This folder contains a set of modules for maintaining Users and Groups in Google Workspace. The modules are basically standalone, however a proper data source is needed.
+* [modules](modules/): This folder contains a set of modules for maintaining Users and Groups in Google Workspace.
 * [examples](examples/): This folder shows examples on how to use this module with different data sources as well as an example for a data source and authentication with the Google API.
 
 ### Google Cloud Service account

examples/example-with-google-buckets/main.tf

@@ -33,6 +33,11 @@ data "google_storage_bucket_object_content" "groups" {
   bucket = "example-data"
 }
 
+data "google_storage_bucket_object_content" "group_settings" {
+  name   = "group_settings.yaml"
+  bucket = "example-data"
+}
+
 data "google_storage_bucket_object_content" "users" {
   name   = "users.yaml"
   bucket = "example-data"
@@ -55,6 +60,7 @@ module "user-group-management" {
     gsuite = gsuite
   }
   groups         = yamldecode(data.google_storage_bucket_object_content.groups.content)
+  group_settings = yamldecode(data.google_storage_bucket_object_content.group_settings.content)
   users          = yamldecode(data.google_storage_bucket_object_content.users.content)
   users_external = yamldecode(data.google_storage_bucket_object_content.users_external.content)
 }

examples/example-with-local-files/main.tf

@@ -26,6 +26,7 @@ terraform {
 
 locals {
   groups         = yamldecode(file("${path.module}/groups.yaml"))
+  group_settings = yamldecode(file("${path.module}/group-settings.yaml"))
   users          = yamldecode(file("${path.module}/users.yaml"))
   users_external = yamldecode(file("${path.module}/users_external.yaml"))
 }
@@ -42,6 +43,7 @@ module "user-group-management" {
     gsuite = gsuite
   }
   groups         = local.groups
+  group_settings = local.group_settings
   users          = local.users
   users_external = local.users_external
 }

examples/example-yaml-files/group_settings.yaml

@@ -0,0 +1,34 @@
+# ---------------------------------------------------------------------------------------------------------------------
+# GOOGLE GROUP SETTINGS
+# ---------------------------------------------------------------------------------------------------------------------
+#
+# For details on allowed parameters check https://registry.terraform.io/providers/DeviaVir/gsuite/latest/docs/resources/group_settings
+
+anyone-mail-allowed:
+  allow_external_members: "true"
+  allow_web_posting: "false"
+  archive_only: "false"
+  include_in_global_address_list: "true"
+  spam_moderation_level: "ALLOW"
+  who_can_contact_owner: "ALL_MANAGERS_CAN_CONTACT"
+  who_can_discover_group: "ALL_IN_DOMAIN_CAN_DISCOVER"
+  who_can_join: "INVITED_CAN_JOIN"
+  who_can_leave_group: "NONE_CAN_LEAVE"
+  who_can_post_message: "ANYONE_CAN_POST"
+  who_can_view_group: "ALL_MEMBERS_CAN_VIEW"
+  who_can_view_membership: "ALL_IN_DOMAIN_CAN_VIEW"
+
+# default
+default:
+  allow_external_members: null
+  allow_web_posting: null
+  archive_only: null
+  include_in_global_address_list: null
+  spam_moderation_level: null
+  who_can_contact_owner: null
+  who_can_discover_group: null
+  who_can_join: null
+  who_can_leave_group: null
+  who_can_post_message: null
+  who_can_view_group: null
+  who_can_view_membership: null

examples/example-yaml-files/groups.yaml

@@ -5,6 +5,7 @@
 one-group:
   email: '[email protected]'
   name: 'Example group'
+  settings: 'anyone-mail-allowed'
   aliases:
     - '[email protected]'
   groups: []
@@ -16,6 +17,7 @@ one-group:
 another-group:
   email: '[email protected]'
   name: 'Another Example group'
+  settings: 'default'
   aliases: []
   groups:
     - 'one-group'

examples/example-yaml-files/users_external.yaml

@@ -1,3 +1,7 @@
+# ---------------------------------------------------------------------------------------------------------------------
+# EXTERNAL USER WITH GROUP MEMBERSHIPS
+# ---------------------------------------------------------------------------------------------------------------------
+
 [email protected]:
   roles:
     - 'one-group'

main.tf

@@ -16,6 +16,16 @@ module "groups" {
   group = each.value
 }
 
+module "group_settings" {
+  for_each = var.groups
+  source   = "./modules/group_settings"
+  providers = {
+    gsuite = gsuite
+  }
+  group_settings = var.group_settings
+  group          = each.value
+}
+
 module "groups_in_group" {
   for_each   = var.groups
   depends_on = [module.groups]

modules/group_settings/main.tf

@@ -0,0 +1,29 @@
+terraform {
+  required_providers {
+    gsuite = {
+      source  = "DeviaVir/gsuite"
+      version = "0.1.58"
+    }
+  }
+}
+
+# ---------------------------------------------------------------------------------------------------------------------
+# Ressource documentation: https://registry.terraform.io/providers/DeviaVir/gsuite/latest/docs/resources/group_settings
+# ---------------------------------------------------------------------------------------------------------------------
+
+resource "gsuite_group_settings" "group_settings" {
+  email = var.group.email
+
+  allow_external_members         = var.group_settings[var.group.settings].allow_external_members
+  allow_web_posting              = var.group_settings[var.group.settings].allow_web_posting
+  archive_only                   = var.group_settings[var.group.settings].archive_only
+  include_in_global_address_list = var.group_settings[var.group.settings].include_in_global_address_list
+  spam_moderation_level          = var.group_settings[var.group.settings].spam_moderation_level
+  who_can_contact_owner          = var.group_settings[var.group.settings].who_can_contact_owner
+  who_can_discover_group         = var.group_settings[var.group.settings].who_can_discover_group
+  who_can_join                   = var.group_settings[var.group.settings].who_can_join
+  who_can_leave_group            = var.group_settings[var.group.settings].who_can_leave_group
+  who_can_post_message           = var.group_settings[var.group.settings].who_can_post_message
+  who_can_view_group             = var.group_settings[var.group.settings].who_can_view_group
+  who_can_view_membership        = var.group_settings[var.group.settings].who_can_view_membership
+}

modules/group_settings/variables.tf

@@ -0,0 +1,9 @@
+variable "group_settings" {
+  type        = any
+  description = "contains all defined group setting templates for Google Groups"
+}
+
+variable "group" {
+  type        = any
+  description = "contains an object representing a Google Group"
+}

modules/users_external_to_groups/README.md

@@ -0,0 +1,2 @@
+# Module for adding external users to groups
+This module is optional. For details on how to use it check [examples](examples/).

variables.tf

@@ -3,6 +3,11 @@ variable "groups" {
   description = "contains objects representing all defined Google Groups"
 }
 
+variable "group_settings" {
+  type        = map(any)
+  description = "contains all defined group setting templates for Google Groups"
+}
+
 variable "users" {
   type        = map(any)
   description = "contains objects representing all defined Google Users"