Updates handling of provider config (#47)

* Removes provider config from module to be provided externally
* fix local.cluster_version so it doesn't crash on destroy

Co-authored-by: Noel Colon <[email protected]>
Signed-off-by: Sean Sundberg <[email protected]>

Author: Sean Sundberg

.github/workflows/verify.yaml

@@ -13,7 +13,7 @@ jobs:
   verify:
     if: ${{ !contains( github.event.pull_request.labels.*.name, 'skip ci' ) }}
     runs-on: ubuntu-latest
-    container: quay.io/ibmgaragecloud/cli-tools:v14
+    container: quay.io/ibmgaragecloud/cli-tools:v0.15
 
     strategy:
       matrix:

README.md

@@ -3,6 +3,8 @@
 Provisions an IBM Cloud OpenShift VPC cluster using a provided VPC instance and COS
 instance.
 
+**Note:** This module follows the Terraform conventions regarding how provider configuration is defined within the Terraform template and passed into the module - https://www.terraform.io/docs/language/modules/develop/providers.html. The default provider configuration flows through to the module. If different configuration is required for a module, it can be explicitly passed in the `providers` block of the module - https://www.terraform.io/docs/language/modules/develop/providers.html#passing-providers-explicitly.
+
 ## Software dependencies
 
 The module depends on the following software components:
@@ -28,8 +30,22 @@ This module makes use of the output from other modules:
 ## Example usage
 
 ```hcl-terraform
+terraform {
+  required_providers {
+    ibm = {
+      source = "ibm-cloud/ibm"
+    }
+  }
+  required_version = ">= 0.13"
+}
+
+provider "ibm" {
+  ibmcloud_api_key = var.ibmcloud_api_key
+  region = var.region
+}
+
 module "cluster" {
-  source = "github.com/cloud-native-toolkit/terraform-ibm-ocp-vpc.git?ref=v1.2.5"
+  source = "github.com/cloud-native-toolkit/terraform-ibm-ocp-vpc.git"
 
   resource_group_name = var.resource_group_name
   region              = var.region

main.tf

@@ -41,7 +41,7 @@ locals {
   # value should be ocp4, ocp3, or kubernetes
   cluster_type_code     = local.config_values[local.cluster_type_cleaned].type_code
   cluster_type_tag      = local.cluster_type == "kubernetes" ? "iks" : "ocp"
-  cluster_version       = local.cluster_type == "openshift" ? local.openshift_versions[local.config_values[local.cluster_type_cleaned].version] : ""
+  cluster_version       = local.cluster_type == "openshift" ? "${var.ocp_version}_openshift" : ""
   vpc_subnet_count      = var.vpc_subnet_count
   vpc_id                = !var.exists ? data.ibm_is_vpc.vpc[0].id : ""
   vpc_subnets           = !var.exists ? var.vpc_subnets : []
@@ -133,6 +133,12 @@ data ibm_container_cluster_versions cluster_versions {
   resource_group_id = data.ibm_resource_group.resource_group.id
 }
 
+resource null_resource print_cluster_versions {
+  provisioner "local-exec" {
+    command = "echo 'Cluster versions: ${jsonencode(data.ibm_container_cluster_versions.cluster_versions.valid_openshift_versions)}'"
+  }
+}
+
 data ibm_is_vpc vpc {
   count = !var.exists ? 1 : 0
   depends_on = [null_resource.print_resources]

module.yaml

@@ -9,6 +9,9 @@ tags:
 versions:
 - platforms:
     - ocp4
+  providers:
+    - name: ibm
+      source: "ibm-cloud/ibm"
   dependencies:
     - id: resource-group
       refs:
@@ -72,6 +75,7 @@ versions:
       scope: module
     - name: worker_count
       scope: global
+      important: true
     - name: ocp_version
       scope: global
     - name: exists

provider.tf

@@ -0,0 +1,4 @@
+provider "ibm" {
+  region           = var.region
+  ibmcloud_api_key = var.ibmcloud_api_key
+}

test/stages/provider.tf

@@ -1,2 +1,9 @@
 terraform {
+  required_version = ">= 0.13.0"
+
+  required_providers {
+    ibm = {
+      source = "ibm-cloud/ibm"
+    }
+  }
 }

test/stages/stage0.tf

@@ -3,7 +3,6 @@ module "gateways" {
 
   resource_group_id = module.resource_group.id
   region            = var.region
-  ibmcloud_api_key  = var.ibmcloud_api_key
   vpc_name          = module.vpc.name
   subnet_count      = var.vpc_subnet_count
 }

test/stages/stage1-gateways.tf

@@ -2,6 +2,5 @@ module "resource_group" {
   source = "github.com/cloud-native-toolkit/terraform-ibm-resource-group.git"
 
   resource_group_name = var.resource_group_name
-  ibmcloud_api_key    = var.ibmcloud_api_key
   provision           = false
 }

test/stages/stage1-resource-group.tf

@@ -3,7 +3,6 @@ module "subnets" {
 
   resource_group_id = module.resource_group.id
   region            = var.region
-  ibmcloud_api_key  = var.ibmcloud_api_key
   vpc_name          = module.vpc.name
   gateways          = module.gateways.gateways
   _count            = 2