feat: Added new feature for hierarchical compartments (#42)

SudharsaneSivamany · sudharsane sivamany · web-flow · commit a160d5f1a0e4 · 2025-05-30T20:57:32.000+10:00
* Added new feature for #41 issue Signed-off-by: sudharsane sivamany <sudharsane.sivamany@oracle.com> * Updating the year for copyright Signed-off-by: sudharsane sivamany <sudharsane.sivamany@oracle.com> * Updating the year for copyright Signed-off-by: sudharsane sivamany <sudharsane.sivamany@oracle.com> * Updating the year for copyright Signed-off-by: sudharsane sivamany <sudharsane.sivamany@oracle.com> * Updating the year for copyright Signed-off-by: sudharsane sivamany <sudharsane.sivamany@oracle.com> --------- Signed-off-by: sudharsane sivamany <sudharsane.sivamany@oracle.com> Co-authored-by: sudharsane sivamany <sudharsane.sivamany@oracle.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,14 @@ Given a version number MAJOR.MINOR.PATCH:
 - MINOR version when adding functionality in a backwards compatible manner,
 - PATCH version when making backwards compatible bug fixes.
 
+## [2.0.2] - 2025-05-27
+
+### Added
+
+#### New features
+
+- iam-hierarchical-compartment
+
 ## [2.0.1] - 2021-02-09
 
 ### Fixed
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+Copyright (c) 2018, 2025, Oracle and/or its affiliates.
 
 This software is dual-licensed to you under the Universal Permissive License (UPL) or Apache License 2.0. See below for license terms. You may choose either license.
 ____________________________
diff --git a/examples/hierarchical_compartment_config.yaml b/examples/hierarchical_compartment_config.yaml
@@ -0,0 +1,45 @@
+# Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
+compartments:
+- compartment_name: compartment_level_1_a
+  description: "level 1 a"
+  freeform_tags: 
+    "Env": "Dev" 
+    "Billing": "Devbilling"
+  enable_delete: true
+  compartments:
+  - compartment_name: compartment_level_2_a
+    description: "level 2 a"
+    enable_delete: true
+    compartments:
+    - compartment_name: compartment_level_3_1_a
+      description: "level 3.1 a"
+      enable_delete: true
+      compartments: []
+    - compartment_name: compartment_level_3_2_a
+      description: "level 3.2 a"
+      enable_delete: true
+      compartments:
+      - compartment_name: compartment_level_4_a
+        description: "level 4 a"   
+        enable_delete: true 
+        compartments:
+        - compartment_name: compartment_level_5_a
+          description: "level 5 a"
+          enable_delete: true
+          compartments:
+          - compartment_name: compartment_level_6_a
+            description: "level 6 a"
+            enable_delete: true    
+- compartment_name: compartment_level_1_b
+  description: "level 1 b"
+  enable_delete: true
+  compartments:
+  - compartment_name: compartment_level_2_b
+    compartments: []
+    description: "level 2b"
+    enable_delete: true
+    freeform_tags: 
+      "Env": "Test" 
+      "Billing": "Testbilling"
diff --git a/examples/hierarchical_compartments.tf b/examples/hierarchical_compartments.tf
@@ -0,0 +1,16 @@
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
+/*
+* This example shows how to create a hierarchical compartments.
+*
+* The hierarchical_compartment_config.yaml contains the detailed structure of 
+* compartments that needs to be provisioned.
+*/
+
+module "Hierarchical_compartment" {
+  source              = "oracle-terraform-modules/iam/oci//modules/iam-hierarchical-compartment"
+  # version               = "2.0.2"
+  root_compartment_id = var.tenancy_ocid # define the parent compartment. Creation at tenancy root if omitted
+  compartments        = yamldecode(file("${path.module}/hierarchical_compartment_config.yaml"))["compartments"]
+}
diff --git a/examples/main.tf b/examples/main.tf
@@ -1,4 +1,5 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
 
 variable "tenancy_ocid" {}
 variable "compartment_ocid" {}
@@ -51,7 +52,7 @@ module "iam_compartment" {
 }
 
 module "iam_subcompartment1" {
-  source                  = "oracle-terraform-modules/iam/oci//modules/iam-compartment"
+  source = "oracle-terraform-modules/iam/oci//modules/iam-compartment"
   # Pinning each module to a specific version is highly advisable. Please adjust and uncomment the line below
   # version               = "x.x.x"
   tenancy_ocid            = var.tenancy_ocid
@@ -63,7 +64,7 @@ module "iam_subcompartment1" {
 }
 
 module "iam_subcompartment2" {
-  source                  = "oracle-terraform-modules/iam/oci//modules/iam-compartment"
+  source = "oracle-terraform-modules/iam/oci//modules/iam-compartment"
   # Pinning each module to a specific version is highly advisable. Please adjust and uncomment the line below
   # version               = "x.x.x"
   tenancy_ocid            = var.tenancy_ocid
@@ -75,7 +76,7 @@ module "iam_subcompartment2" {
 }
 
 module "iam_users" {
-  source       = "oracle-terraform-modules/iam/oci//modules/iam-user"
+  source = "oracle-terraform-modules/iam/oci//modules/iam-user"
   # Pinning each module to a specific version is highly advisable. Please adjust and uncomment the line below
   # version       = "x.x.x"
   tenancy_ocid = var.tenancy_ocid
@@ -115,7 +116,7 @@ module "iam_group" {
 }
 
 module "iam_dynamic_group" {
-  source                    = "oracle-terraform-modules/iam/oci//modules/iam-dyanmic-group"
+  source = "oracle-terraform-modules/iam/oci//modules/iam-dyanmic-group"
   # Pinning each module to a specific version is highly advisable. Please adjust and uncomment the line below
   # version               = "x.x.x"
   tenancy_ocid              = var.tenancy_ocid
diff --git a/examples/outputs.tf b/examples/outputs.tf
@@ -1,4 +1,5 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
 
 output "iam_compartment" {
   description = "compartment name, description, ocid, and parent ocid"
@@ -43,3 +44,8 @@ output "iam_dynamic_group_name" {
   description = "dynamic group name and associated ocid"
   value       = module.iam_dynamic_group.name_ocid
 }
+
+output "compartment_ids_under_root" {
+  description = "Compartment id list under root"
+  value       = module.Hierarchical_compartment.compartment_ids
+}
diff --git a/examples/terraform.tfvars.sample b/examples/terraform.tfvars.sample
@@ -1,3 +1,6 @@
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 # OCI Authentication details
 tenancy_ocid     = "<tenancy OCID>"
 compartment_ocid = "<compartment OCID>"
diff --git a/modules/iam-compartment/main.tf b/modules/iam-compartment/main.tf
@@ -1,4 +1,6 @@
-// Copyright (c) 2018, 2023 Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 
 ########################
 # Compartment
diff --git a/modules/iam-compartment/outputs.tf b/modules/iam-compartment/outputs.tf
@@ -1,4 +1,6 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 
 output "compartment_id" {
   description = "Compartment ocid"
diff --git a/modules/iam-compartment/variables.tf b/modules/iam-compartment/variables.tf
@@ -1,4 +1,6 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 
 variable "tenancy_ocid" {
   type = string
diff --git a/modules/iam-compartment/versions.tf b/modules/iam-compartment/versions.tf
@@ -1,3 +1,6 @@
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 terraform {
   required_providers {
     oci = {
diff --git a/modules/iam-dynamic-group/main.tf b/modules/iam-dynamic-group/main.tf
@@ -1,4 +1,6 @@
-// Copyright (c) 2018, 2023 Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 
 ########################
 # Dynamic Group
diff --git a/modules/iam-dynamic-group/outputs.tf b/modules/iam-dynamic-group/outputs.tf
@@ -1,4 +1,6 @@
-// Copyright (c) 2018, 2023 Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 
 output "dynamic_group_id" {
   description = "Dynamic Group ocid"
diff --git a/modules/iam-dynamic-group/variables.tf b/modules/iam-dynamic-group/variables.tf
@@ -1,4 +1,6 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 
 variable "tenancy_ocid" {
   type = string
diff --git a/modules/iam-dynamic-group/versions.tf b/modules/iam-dynamic-group/versions.tf
@@ -1,3 +1,6 @@
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 terraform {
   required_providers {
     oci = {
diff --git a/modules/iam-group/main.tf b/modules/iam-group/main.tf
@@ -1,4 +1,5 @@
-// Copyright (c) 2018, 2023 Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
 
 ########################
 # Group
diff --git a/modules/iam-group/outputs.tf b/modules/iam-group/outputs.tf
@@ -1,4 +1,5 @@
-// Copyright (c) 2018, 2023 Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
 
 output "group_id" {
   description = "Group ocid"
diff --git a/modules/iam-group/variables.tf b/modules/iam-group/variables.tf
@@ -1,4 +1,5 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
 
 variable "tenancy_ocid" {
   type = string
diff --git a/modules/iam-group/versions.tf b/modules/iam-group/versions.tf
@@ -1,3 +1,6 @@
+// Copyright (c) 2018, 2025, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl
+
 terraform {
   required_providers {
     oci = {
diff --git a/modules/iam-hierarchical-compartment/README.md b/modules/iam-hierarchical-compartment/README.md
@@ -0,0 +1,107 @@
+
+# modules/iam-hierarchical-compartment
+
+This [Terraform module](https://www.terraform.io/docs/modules/index.html) allows an [Oracle Cloud Infrastructure  compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm) to be created hierarchically upto 6-level deep from the root compartment.
+
+## Example
+
+```hcl
+module "Hierarchical_compartment" {
+  source                  = "oracle-terraform-modules/iam/oci//modules/iam-hierarchical-compartment"
+  # Pinning each module to a specific version is highly advisable. Please adjust and uncomment the line below
+  # version               = "x.x.x"
+  root_compartment_id     = var.tenancy_ocid # define the parent compartment. Creation at tenancy root if omitted
+  compartments            = yamldecode(file("${path.module}/hierarchical_compartment_config.yaml"))["compartments"] # place the yaml file in the same module path
+}
+```
+
+```yaml
+compartments:
+- compartment_name: compartment_level_1_a
+  description: "level 1 a"
+  freeform_tags: 
+    "Env": "Dev" 
+    "Billing": "Devbilling"
+  defined_tags:
+    "Operations.CostCenter": "42"
+  enable_delete: true
+  compartments:
+  - compartment_name: compartment_level_2_a
+    description: "level 2 a"
+    enable_delete: true
+    compartments:
+    - compartment_name: compartment_level_3_1_a
+      description: "level 3.1 a"
+      enable_delete: true
+      compartments: []
+    - compartment_name: compartment_level_3_2_a
+      description: "level 3.2 a"
+      enable_delete: true
+      compartments:
+      - compartment_name: compartment_level_4_a
+        description: "level 4 a"   
+        enable_delete: true 
+        compartments:
+        - compartment_name: compartment_level_5_a
+          description: "level 5 a"
+          enable_delete: true
+          compartments:
+          - compartment_name: compartment_level_6_a
+            description: "level 6 a"
+            enable_delete: true    
+- compartment_name: compartment_level_1_b
+  description: "level 1 b"
+  enable_delete: true
+  compartments:
+  - compartment_name: compartment_level_2_b
+    compartments: []
+    description: "level 2b"
+    enable_delete: true
+    freeform_tags: 
+      "Env": "Test" 
+      "Billing": "Testbilling"
+
+```
+
+Check out the [examples](https://github.com/oracle-terraform-modules/terraform-oci-iam/tree/master/examples) for fully-working sample code.
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
+| <a name="requirement_oci"></a> [oci](#requirement\_oci) | >=4.67.3 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_oci"></a> [oci](#provider\_oci) | >=4.67.3 |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [oci_identity_compartment.compartment_level_1](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_compartment) | resource |
+| [oci_identity_compartment.compartment_level_2](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_compartment) | resource |
+| [oci_identity_compartment.compartment_level_3](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_compartment) | resource |
+| [oci_identity_compartment.compartment_level_4](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_compartment) | resource |
+| [oci_identity_compartment.compartment_level_5](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_compartment) | resource |
+| [oci_identity_compartment.compartment_level_6](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_compartment) | resource |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_compartments"></a> [compartments](#input\_compartments) | Hierarchical Compartments | `any` | n/a | yes |
+| <a name="input_root_compartment_id"></a> [root\_compartment\_id](#input\_root\_compartment\_id) | Target compartment id which is considered as root | `string` | n/a | yes |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_compartment_ids"></a> [compartment\_ids](#output\_compartment\_ids) | Compartment ID's |
diff --git a/modules/iam-hierarchical-compartment/main.tf b/modules/iam-hierarchical-compartment/main.tf
diff --git a/modules/iam-hierarchical-compartment/outputs.tf b/modules/iam-hierarchical-compartment/outputs.tf
diff --git a/modules/iam-hierarchical-compartment/variables.tf b/modules/iam-hierarchical-compartment/variables.tf
diff --git a/modules/iam-hierarchical-compartment/versions.tf b/modules/iam-hierarchical-compartment/versions.tf
diff --git a/modules/iam-user/main.tf b/modules/iam-user/main.tf
diff --git a/modules/iam-user/outputs.tf b/modules/iam-user/outputs.tf
diff --git a/modules/iam-user/variables.tf b/modules/iam-user/variables.tf
diff --git a/modules/iam-user/versions.tf b/modules/iam-user/versions.tf

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2018, 2021, Oracle and/or its affiliates.`
	`1`	`+Copyright (c) 2018, 2025, Oracle and/or its affiliates.`
`2`	`2`
`3`	`3`	`This software is dual-licensed to you under the Universal Permissive License (UPL) or Apache License 2.0. See below for license terms. You may choose either license.`
`4`	`4`	`____________________________`