Creating workspaces and importing your Terraform

• In Specify Template section:

  • GitHub, GitLab, or Bitbucket repository URL - <provide your Terraform Git repository URL.

  • Personal access token - <leave it blank>. You can click the Open reference picker to select a your Secret Manager key reference. For more information, see creating a Secret Manager instance.

  • Terraform Version - terraform_v1.4. You need to select Terraform version 1.4 or greater version. For example, if your Terraform templates are created by using Terraform v1.4, select the Terraform version parameter as terraform_v1.4. You can select Terraform_v1.5 to use Terraform version 1.5, terraform_v1.4 to use Terraform version 1.4. When you specify terraform_v1.5 means that users can have Terraform v1.5.0, v1.5.1, or v1.5.7, so on. Schematics supports Terraform_v1.x and also plans to make releases available after 30 to 45 days of HashiCorp Configuration Language (HCL) release.

    Schematics supports the current release of Terraform v1.4, through Terraform_v1.6. The Terraform must use the version constraint, such as > or >= or ~> for the required_version of Terraform, to automatically pick the current version.

    terraform {
    required_version = "~> 1.1"
    }
    

  • Click Next.

• In Workspace details section. Enter a name for your workspace name. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.
  • Workspace name as schematics-agent-service.
  • Tags as my-tags. Optional: Enter tags for your workspace. You can use the tags later to find your workspace faster.
  • Resource group as default or other resource group for this workspace.
  • Location as North America or other region for this workspace. Decide where you want to create your workspace? The location determines where your Schematics jobs run?, and where your workspace data is stored? You can choose between a location, such as North America, or a metro city, such as Frankfurt or London. If you select a location, Schematics determines the location based on availability. If you select a metro city, your workspace is created in this location. For more information about where your data is stored, see Where is your information stored? The location that you choose is independent from the region or regions where you want to provision your IBM Cloud resources. The console does not support all available locations. To create the workspace in a different location, use the CLI or API instead.
  • Optional, enter a descriptive name for your workspace.
  • Click Next.
• Click Create. Your workspace is created with a Draft state and the workspace Settings page opens.

Create a JSON file on your local workstation and add your workspace configuration. For more configuration options when creating the workspace, see the ibmcloud schematics workspace new command.

To create a workspace with Agent, refer to ibmcloud schematics workspace new with Agent command.

{
"name": "<workspace_name>",
"type": [
    "<terraform_version>"
],
"location": "<location>",
"description": "<workspace_description>",
"tags": [],
"template_repo": {
    "url": "<github_source_repo_url>"
    "branch": "master"
},
"template_data": [
    {
    "folder": ".",
    "type": "<terraform_version>",
    "variablestore": [
      {
        "name": "<variable_name1>",
        "value": "<variable_value1>",
        "type": "string",
        "secure": true
      },
      {
        "name": "<variable_name2>",
        "value": "<variable_value2>",
        "type": "bool",
        "secure": false
      }
    ]
    }
]
}

Create the workspace.

ibmcloud schematics workspace new --file workspace.json

Verify that your workspace is created. Make sure that your workspace is in an Inactive state.

ibmcloud schematics workspace list

Refer to, Managing IBM Cloud resources with Schematics to update or delete IBM Cloud resources with Terraform.

Follow the steps to retrieve your IAM access token and authenticate with IBM Cloud Schematics by using the API.

Create the workspace by using Terraform.

curl --request POST --url https://schematics.cloud.ibm.com/v1/workspaces -H "Authorization: <iam_access_token>" -d '{"name": "<workspace_name>","type": ["<terraform_version>"],"location": "<location>","description": "<description>","template_repo": {"url": "<github_source_repo_url>"},"template_data": [{"folder": ".","type": "<terraform_version>","variablestore": [{"value": "<variable_value>","name": "<variable_name>","type": "<variable_type>","secure": true}]}]}'

Verify that the workspace is created successfully.

curl -X GET https://schematics.cloud.ibm.com/v1/workspaces -H "Authorization: <iam_access_token>"

See Managing IBM Cloud resources with Schematics to update, or delete the IBM Cloud resources.

Follow the steps in Setting up Terraform for Schematics to create your workspace with Terraform.

See Managing IBM Cloud resources with Schematics to update, or delete the IBM Cloud resources.