feat(TPG>=6)!: upgrade to TPGv6 (#84)

terraform-google-modules · Sep 12, 2024 · 7eb2b92 · 7eb2b92
1 parent aa3c9df
commit 7eb2b92
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -67,6 +67,7 @@ Functional examples are included in the
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | `list(string)` | `[]` | no |
+| deletion\_protection | Prevent Terraform from destroying or recreating the folder. | `bool` | `true` | no |
 | folder\_admin\_roles | List of roles that will be applied to a folder if roles are not explictly specified in per\_folder\_admins | `list(string)` | <pre>[<br>  "roles/owner",<br>  "roles/resourcemanager.folderViewer",<br>  "roles/resourcemanager.projectCreator",<br>  "roles/compute.networkAdmin"<br>]</pre> | no |
 | names | Folder names. | `list(string)` | `[]` | no |
 | parent | The resource name of the parent Folder or Organization. Must be of the form folders/folder\_id or organizations/org\_id | `string` | n/a | yes |

diff --git a/docs/upgrading_to_folders_v5.0.md b/docs/upgrading_to_folders_v5.0.md
@@ -0,0 +1,32 @@
+# Upgrading to v5.0
+
+The v5.0 release of the *Folders* module is a backwards incompatible release.
+
+### Google Cloud Platform Provider upgrade
+The *Folders* module now requires version 6.0 or higher of the Google Cloud Platform Providers.
+
+```diff
+terraform {
+  required_providers {
+    google = {
+      source  = "hashicorp/google"
+-      version = "~> 5.0"
++      version = "~> 6.0"
+    }
+  }
+}
+```
+
+### Deletion Protection
+The *Folders* Module now includes the `deletion_protection` option which defaults to `true`.  To delete your folders using Terraform, you should specify it explicitly to `false`:
+
+```diff
+  module "gke" {
+-   source  = "terraform-google-modules/folders/google"
+-   version = "~> 4.0"
++   source  = "terraform-google-modules/folders/google"
++   version = "~> 5.0"
+...
++   deletion_protection = false
+}
+```
diff --git a/examples/simple_example/main.tf b/examples/simple_example/main.tf
@@ -22,6 +22,8 @@ module "folders" {
   set_roles         = true
   all_folder_admins = var.all_folder_admins
 
+  deletion_protection = false
+
   names = [
     "dev",
     "staging",

diff --git a/main.tf b/main.tf
@@ -33,8 +33,9 @@ locals {
 resource "google_folder" "folders" {
   for_each = toset(var.names)
 
-  display_name = "${local.prefix}${each.value}"
-  parent       = var.parent
+  display_name        = "${local.prefix}${each.value}"
+  parent              = var.parent
+  deletion_protection = var.deletion_protection
 }
 
 # give project creation access to service accounts

diff --git a/test/setup/versions.tf b/test/setup/versions.tf
@@ -15,15 +15,15 @@
  */
 
 terraform {
-  required_version = ">= 0.13"
+  required_version = ">= 1.3.0"
   required_providers {
     google = {
       source  = "hashicorp/google"
-      version = ">= 3.38, < 6"
+      version = ">= 3.38, < 7"
     }
     google-beta = {
       source  = "hashicorp/google-beta"
-      version = ">= 3.38, < 6"
+      version = ">= 3.38, < 7"
     }
     random = {
       source = "hashicorp/random"

diff --git a/variables.tf b/variables.tf
@@ -64,3 +64,8 @@ variable "folder_admin_roles" {
   ]
 }
 
+variable "deletion_protection" {
+  type        = bool
+  description = "Prevent Terraform from destroying or recreating the folder."
+  default     = true
+}
diff --git a/versions.tf b/versions.tf
@@ -20,7 +20,7 @@ terraform {
   required_providers {
     google = {
       source  = "hashicorp/google"
-      version = ">= 3.45, < 6"
+      version = ">= 6.0.0, < 7"
     }
 
     random = {