Creating a Stack from an Existing Compartment

Using resource discovery, create a stack in Resource Manager based on an existing compartment to generate a Terraform configuration that describes the compartment's resources.

For more information about resource discovery, see Resource Discovery.

    1. Open the navigation menu and click Developer Services. Under Resource Manager, click Stacks.
    2. On the Stacks page, select a compartment.
    3. Click Create stack.
    4. On the Create stack page, under Choose the origin of the Terraform configuration, select Existing compartment.
    5. Select the compartment and region that contain the resources that you want to capture.
    6. (Optional) To filter for specific services supported for resource discovery, select Selected and then select the services you want.
      Note

      This setting can't be changed when editing the stack later.
    7. (Optional) To use custom providers, select Use custom providers and then select the bucket that contains the custom provider.
    8. (Optional) Edit the default stack name and enter a stack description. Avoid entering confidential information.
    9. Select the compartment where you want to create the stack.
    10. (Optional) Click Show advanced options and assign tags to the stack.
      • Tag namespace: To add a defined tag, select an existing namespace. To add a free-from tag, leave the value blank.
      • Tag key: To add a defined tag, select an existing tag key. To add a free-form tag, type the key name that you want.
      • Tag value: Type the tag value that you want.
      • Add tag: Click to add another tag.
    11. Click Next twice.
      No variables are listed for the Existing compartment stack origin because no Terraform configuration exists yet.
    12. In the Review panel, verify the stack configuration.
    13. Click Create.
    A work request runs on the stack. When the work request finishes, a job runs to generate a Terraform configuration file for the stack. When the job finishes, the resources in the selected compartment are captured in the generated configuration. You can recreate these resources in another compartment.
  • Use the oci resource-manager stack create-from-compartment command and required parameters to create a stack from a compartment.

    oci resource-manager stack create-from-compartment --compartment-id <compartment_OCID> --config-source-compartment-id <source_compartment_OCID> --config-source-region <region>
    Example Request

    For example (discovers supported resources from the core and database services; the source compartment is not a root compartment):

    oci resource-manager stack create-from-compartment --config-source-compartment-id ocid1.tenancy.oc1..uniqueid1 --config-source-region PHX --config-source-services-to-discover [core,database] –-compartment-id ocid1.tenancy.oc1..uniqueid2 --terraform-version 0.13.X --display-name "Stack From Compartment ABC" --description "List of Resources to Duplicate"
    Example Response
    {
      "data": {
        "config-source": {
          "config-source-type": "COMPARTMENT_CONFIG_SOURCE"
        },
        "defined-tags": {},
        "display-name": "Stack from Compartment ABC",
        "freeform-tags": {},
        "id": "ocid1.ormstack.oc1..uniqueid",
        "lifecycle-state": "CREATING",
        "time-created": "2019-04-03T18:26:56.299000+00:00",
        "variables": {
          "compartment_ocid": "ocid1.compartment.oc1..uniqueid1", 
          "region": "us-phoenix-1"
        }
      }
    }
    {
      "data": {
        "compartment-id": "ocid1.compartment.oc1..uniqueid2",
        "config-source": {
          "compartment-id": "ocid1.compartment.oc1..uniqueid1",
          "config-source-type": "COMPARTMENT_CONFIG_SOURCE",
          "region": "PHX",
          "working-directory": null
        },
        "defined-tags": {},
        "description": "List of Resources to Duplicate",
        "display-name": "Stack From Compartment ABC",
        "freeform-tags": {},
        "id": "ocid1.ormstack.oc1.phx.uniqueid",
        "lifecycle-state": "CREATING",
        "stack-drift-status": "NOT_CHECKED",
        "terraform-version": "0.12.x",
        "time-created": "2020-06-01T18:25:56.102000+00:00",
        "time-drift-last-checked": null,
        "variables": {}
      },
      "etag": "009010cb57f5162655c6a34f5ef8834f204a734df81e4baa696a7d830488ea25",
      "opc-work-request-id": "ocid1.ormworkrequest.oc1.phx.uniqueid"
    }

    For a complete list of parameters and values for CLI commands, see the Command Line Reference for Resource Manager.

  • Use the CreateStack operation to create a stack from a compartment.

    For an example of the configSource part of the request, see CreateCompartmentConfigSourceDetails.

    Example request
    POST /20180917/stacks
    Host: resourcemanager.us-phoenix-1.oraclecloud.com
    <authorization and other headers>
    {
      "compartmentId": "ocid1.compartment.oc1..<unique_ID>",
      "displayName": "My Compartment Configuration",
      "configSource": {
        "configSourceType": "COMPARTMENT_CONFIG_SOURCE",
        "compartmentId": "ocid1.compartment.oc1..<unique_ID>",
        "region": "us-phoenix-1"
      }
    }