chore: fetch vpc details from the workspace (#626)

Author: Aashiq-J

patterns/vsi-extension/README.md

@@ -5,3 +5,23 @@ This logic creates a VSI to an existing landing zone VPC.
 This code creates and configures the following infrastructure:
 - Adds an SSH key to IBM Cloud or uses an existing one.
 - Adds a VSI in each subnet of the landing zone VPC.
+
+There are two ways through which a user can pass the VPC details for deploying the VSI, both the approaches are mutually exclusive.
+
+## Using `vpc_id`
+
+The VPC ID of the landing zone VPC can be assigned to the variable vpc_id in order to create a VSI within that specific VPC.
+
+## Using `prerequisite_workspace_id` and `existing_vpc_name`
+
+The user can specify the workspace ID associated with the deployment of the landing zone VPC when creating a new VSI.
+
+Follow these steps to get the schematics workspace ID.
+
+1. Click the Navigation menu icon, and then click Schematics > Workspaces.
+1. Select the Workspace that is associated with landing zone VPC.
+1. Click the Settings.
+1. In the Details section, you can find the Workspace ID.
+
+Pass the Workspace ID to the `prerequisite_workspace_id` variable and pass the name of the VPC to the `existing_vpc_name` to choosse the name of the VPC to which the user wants to deploy the VSI.
+Please provide the Workspace ID for the prerequisite workspace and the name of the existing VPC to the `prerequisite_workspace_id` and `existing_vpc_name` variables respectively, to identify the VPC where you want to deploy the VSI.

patterns/vsi-extension/main.tf

@@ -1,17 +1,40 @@
 ##############################################################################
-# Locals
+# Schematics Data
 ##############################################################################
 
 locals {
-  ssh_key_id = var.ssh_public_key != null ? ibm_is_ssh_key.ssh_key[0].id : data.ibm_is_ssh_key.ssh_key[0].id
+  # tflint-ignore: terraform_unused_declarations
+  validate_vpc_vars = var.prerequisite_workspace_id == null && var.vpc_id == null ? tobool("var.prerequisite_workspace_id and var.vpc_id cannot be both set to null.") : true
+  # tflint-ignore: terraform_unused_declarations
+  validate_vpc_names = var.prerequisite_workspace_id != null && var.existing_vpc_name == null ? tobool("A value must be passed for var.existing_vpc_name to choose a VPC from the list of VPCs from the schematics workspace.") : true
+
+  location         = var.prerequisite_workspace_id != null ? regex("^[a-z/-]+", var.prerequisite_workspace_id) : null
+  fullstack_output = length(data.ibm_schematics_output.schematics_output) > 0 ? jsondecode(data.ibm_schematics_output.schematics_output[0].output_json) : null
+  vpc_id = var.prerequisite_workspace_id != null ? [
+    for vpc in local.fullstack_output[0].vpc_data.value :
+    vpc.vpc_data.id if vpc.vpc_data.name == var.existing_vpc_name
+  ][0] : var.vpc_id
+}
+
+data "ibm_schematics_workspace" "schematics_workspace" {
+  count        = var.prerequisite_workspace_id != null ? 1 : 0
+  workspace_id = var.prerequisite_workspace_id
+  location     = local.location
+}
+
+data "ibm_schematics_output" "schematics_output" {
+  count        = var.prerequisite_workspace_id != null ? 1 : 0
+  workspace_id = var.prerequisite_workspace_id
+  location     = local.location
+  template_id  = data.ibm_schematics_workspace.schematics_workspace[0].runtime_data[0].id
 }
 
 ##############################################################################
-# Resource Group
+# Locals
 ##############################################################################
 
-data "ibm_resource_group" "existing_resource_group" {
-  name = var.resource_group
+locals {
+  ssh_key_id = var.ssh_public_key != null ? ibm_is_ssh_key.ssh_key[0].id : data.ibm_is_ssh_key.ssh_key[0].id
 }
 
 ##############################################################################
@@ -21,7 +44,7 @@ resource "ibm_is_ssh_key" "ssh_key" {
   count          = local.ssh_keys != null ? 1 : 0
   name           = local.ssh_keys.name
   public_key     = replace(local.ssh_keys.public_key, "/==.*$/", "==")
-  resource_group = data.ibm_resource_group.existing_resource_group.id
+  resource_group = data.ibm_is_vpc.vpc_by_id.resource_group
   tags           = var.resource_tags
 }
 
@@ -31,10 +54,9 @@ data "ibm_is_ssh_key" "ssh_key" {
 }
 
 data "ibm_is_vpc" "vpc_by_id" {
-  identifier = var.vpc_id
+  identifier = local.vpc_id
 }
 
-
 data "ibm_is_image" "image" {
   name = var.image_name
 }
@@ -49,10 +71,10 @@ locals {
 module "vsi" {
   source                        = "terraform-ibm-modules/landing-zone-vsi/ibm"
   version                       = "2.8.2"
-  resource_group_id             = data.ibm_resource_group.existing_resource_group.id
+  resource_group_id             = data.ibm_is_vpc.vpc_by_id.resource_group
   create_security_group         = true
   prefix                        = "${var.prefix}-vsi"
-  vpc_id                        = var.vpc_id
+  vpc_id                        = local.vpc_id
   subnets                       = var.subnet_names != null ? local.subnets : data.ibm_is_vpc.vpc_by_id.subnets
   tags                          = var.resource_tags
   access_tags                   = var.access_tags

patterns/vsi-extension/variables.tf

@@ -4,11 +4,6 @@ variable "ibmcloud_api_key" {
   sensitive   = true
 }
 
-variable "resource_group" {
-  type        = string
-  description = "The resource group name of the landing zone VPC."
-}
-
 variable "region" {
   description = "The region of the landing zone VPC."
   type        = string
@@ -23,6 +18,7 @@ variable "prefix" {
 variable "vpc_id" {
   description = "The ID of the VPC where the VSI will be created."
   type        = string
+  default     = null
 }
 
 variable "existing_ssh_key_name" {
@@ -186,3 +182,15 @@ variable "load_balancers" {
   )
   default = []
 }
+
+variable "prerequisite_workspace_id" {
+  type        = string
+  description = "IBM Cloud Schematics workspace ID of the prerequisite IBM VPC landing zone. If you do not have an existing deployment yet, create a new architecture using the same catalog tile."
+  default     = null
+}
+
+variable "existing_vpc_name" {
+  type        = string
+  description = "Name of the VPC to be used for deploying the VSI from the list of VPCs retrived from the IBM Cloud Schematics workspace."
+  default     = null
+}

patterns/vsi-extension/version.tf

@@ -6,9 +6,10 @@ terraform {
   required_version = ">= 1.3, < 1.6"
   # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
   required_providers {
+    # Pin to 1.58.1 due to https://github.com/IBM-Cloud/terraform-provider-ibm/issues/4907
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.59.0"
+      version = "1.58.1"
     }
     # tflint-ignore: terraform_unused_required_providers
     external = {

renovate.json

@@ -7,7 +7,8 @@
       "matchPaths": [
         "patterns/vsi-quickstart",
         "patterns/vsi",
-        "patterns/roks"
+        "patterns/roks",
+        "patterns/vsi-extension"
       ],
       "semanticCommitType": "fix"
     },
@@ -21,7 +22,8 @@
       "semanticCommitType": "fix",
       "group": true,
       "groupName": "required_provider",
-      "commitMessageExtra": "to latest for the landing zone DAs"
+      "commitMessageExtra": "to latest for the landing zone DAs",
+      "ignorePaths": ["patterns/vsi-extension/"]
     }
   ]
 }

tests/pr_test.go

@@ -574,7 +574,6 @@ func TestRunVsiExtention(t *testing.T) {
 			TerraformVars: map[string]interface{}{
 				"prefix":                     prefix,
 				"region":                     region,
-				"resource_group":             fmt.Sprintf("%s-management-rg", prefix),
 				"existing_kms_instance_guid": terraform.Output(t, existingTerraformOptions, "key_management_guid"),
 				"boot_volume_encryption_key": keyID,
 				"vpc_id":                     managementVpcID,