source path pointing to hashicorp regsitry

terraform-ibm-modules · Nov 26, 2020 · 0c417e0 · 0c417e0
1 parent 49effba
commit 0c417e0
Show file tree

Hide file tree

Showing 24 changed files with 183 additions and 172 deletions.
diff --git a/README.md b/README.md
@@ -16,44 +16,52 @@ is [1.1.1][v1.1.1].
 Full examples are in the [examples](./examples/) folder, but basic usage is as follows for creation of COS instance:
 
 ```hcl
+provider "ibm" {
+}
+
 data "ibm_resource_group" "cos_group" {
-  name = "test"
+  name = var.resource_group
 }
 
 module "cos" {
-  source = "../../modules/cos_instance"
-
-  name              = "testcos"
-  resource_group_id = data.ibm_resource_group.cos_group.id
-  plan              = "testplan"
-  location          = "testregion"
+  
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_instance"
+  
+  service_name       = var.service_name
+  resource_group_id  = data.ibm_resource_group.cos_group.id
+  plan               = var.plan
+  region             = var.region
 }
 
 ```
 
 Creation of cloud object storage bucket:
 
 ```hcl
+provider "ibm" {
+}
+
 data "ibm_resource_group" "cos_group" {
-  name = "test"
+  name = var.resource_group
 }
 
 module "cos" {
-  source = "../../modules/cos_instance"
-
-  name              = "testcos"
-  resource_group_id = data.ibm_resource_group.cos_group.id
-  plan              = "testplan"
-  location          = "testregion"
+  
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_instance"
+  
+  service_name       = var.service_name
+  resource_group_id  = data.ibm_resource_group.cos_group.id
+  plan               = var.plan
+  region             = var.region
 }
 
 module "cos_bucket" {
-  source = "../../modules/cos_bucket"
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_bucket"
 
-  bucket_name          = "testbucket"
-  resource_instance_id = module.cos.cos_instance_id  
-  cross_region_location      = "testlocation"
-  storage_class        = "teststorage"
+  bucket_name         = var.bucket_name
+  cos_instance_id     = module.cos.cos_instance_id  
+  location            = var.location
+  storage_class       = var.storage_class
 
 }
 ```

diff --git a/examples/cos_bucket/README.md → examples/bucket/README.md b/examples/cos_bucket/README.md → examples/bucket/README.md
@@ -4,26 +4,30 @@ This module is used to create a cloud object storage bucket
 
 ## Example Usage
 ```
+provider "ibm" {
+}
+
 data "ibm_resource_group" "cos_group" {
   name = var.resource_group
 }
 
 module "cos" {
-  source = "../../modules/cos_instance"
-
-  name              = var.name
-  resource_group_id = data.ibm_resource_group.cos_group.id
-  plan              = var.plan
-  location          = var.region
+  
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_instance"
+  
+  service_name       = var.service_name
+  resource_group_id  = data.ibm_resource_group.cos_group.id
+  plan               = var.plan
+  region             = var.region
 }
 
 module "cos_bucket" {
-  source = "../../modules/cos_bucket"
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_bucket"
 
-  bucket_name          = var.bucket_name
-  resource_instance_id = module.cos.cos_instance_id  
-  cross_region_location      = var.location
-  storage_class        = var.storage_class
+  bucket_name         = var.bucket_name
+  cos_instance_id     = module.cos.cos_instance_id  
+  location            = var.location
+  storage_class       = var.storage_class
 
 }
 ```
@@ -42,3 +46,4 @@ module "cos_bucket" {
 | region          | Target location or environment to create the resource instance.  | string | n/a     | yes      |
 | resource\_group | Name of the resource group                                       | string | n/a     | yes      |
 
+## NOTE: If we want to make use of a particular version of module, then set the argument "version" to respective module version.
diff --git a/examples/bucket/main.tf b/examples/bucket/main.tf
@@ -0,0 +1,31 @@
+#####################################################
+# COS Bucket
+# Copyright 2020 IBM
+#####################################################
+
+provider "ibm" {
+}
+
+data "ibm_resource_group" "cos_group" {
+  name = var.resource_group
+}
+
+module "cos" {
+
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_instance"
+
+  service_name       = var.service_name
+  resource_group_id  = data.ibm_resource_group.cos_group.id
+  plan               = var.plan
+  region             = var.region
+}
+
+module "cos_bucket" {
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_bucket"
+
+  bucket_name         = var.bucket_name
+  cos_instance_id     = module.cos.cos_instance_id  
+  location            = var.location
+  storage_class       = var.storage_class
+
+}
diff --git a/examples/cos_bucket/variables.tf → examples/bucket/variables.tf b/examples/cos_bucket/variables.tf → examples/bucket/variables.tf
diff --git a/examples/cos_bucket/versions.tf → examples/bucket/versions.tf b/examples/cos_bucket/versions.tf → examples/bucket/versions.tf
diff --git a/examples/cos_bucket/.terraform/modules/modules.json b/examples/cos_bucket/.terraform/modules/modules.json
diff --git a/examples/cos_bucket/.terraform/plugins/darwin_amd64/lock.json b/examples/cos_bucket/.terraform/plugins/darwin_amd64/lock.json
diff --git a/examples/cos_bucket/main.tf b/examples/cos_bucket/main.tf
diff --git a/examples/cos_instance/.terraform/modules/modules.json b/examples/cos_instance/.terraform/modules/modules.json
diff --git a/examples/cos_instance/.terraform/plugins/darwin_amd64/lock.json b/examples/cos_instance/.terraform/plugins/darwin_amd64/lock.json
diff --git a/examples/cos_instance/README.md → examples/storage-instance/README.md b/examples/cos_instance/README.md → examples/storage-instance/README.md
@@ -4,21 +4,28 @@ This module is used to create a cloud object storage instance.
 
 ## Example Usage
 ```
+provider "ibm" {
+}
+
 data "ibm_resource_group" "cos_group" {
   name = var.resource_group
 }
 
 module "cos" {
-  source = "../../modules/cos_instance"
-
-  name              = var.name
-  resource_group_id = data.ibm_resource_group.cos_group.id
-  plan              = var.plan
-  location          = var.location
+  
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_instance"
+  
+  service_name       = var.service_name
+  resource_group_id  = data.ibm_resource_group.cos_group.id
+  plan               = var.plan
+  region             = var.region
 }
 
 ```
 
+## NOTE: If we want to make use of a particular version of module, then set the argument "version" to respective module version.
+
+
 ## Inputs
 
 | Name            | Description                                                      | Type   | Default | Required |

diff --git a/examples/cos_instance/main.tf → examples/storage-instance/main.tf b/examples/cos_instance/main.tf → examples/storage-instance/main.tf
@@ -11,10 +11,11 @@ data "ibm_resource_group" "cos_group" {
 }
 
 module "cos" {
-  source = "../../modules/cos_instance"
-
-  service_name              = var.service_name
-  resource_group_id = data.ibm_resource_group.cos_group.id
-  plan              = var.plan
-  region          = var.region
+
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_instance"
+
+  service_name       = var.service_name
+  resource_group_id  = data.ibm_resource_group.cos_group.id
+  plan               = var.plan
+  region             = var.region
 }
diff --git a/examples/cos_instance/variables.tf → examples/storage-instance/variables.tf b/examples/cos_instance/variables.tf → examples/storage-instance/variables.tf
diff --git a/examples/cos_instance/versions.tf → examples/storage-instance/versions.tf b/examples/cos_instance/versions.tf → examples/storage-instance/versions.tf
diff --git a/modules/bucket/README.md b/modules/bucket/README.md
@@ -0,0 +1,49 @@
+# Module cos_bucket 
+
+This module is used to create a cloud object storage bucket
+
+## Example Usage
+```
+provider "ibm" {
+}
+
+data "ibm_resource_group" "cos_group" {
+  name = var.resource_group
+}
+
+module "cos" {
+  
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_instance"
+  
+  service_name       = var.service_name
+  resource_group_id  = data.ibm_resource_group.cos_group.id
+  plan               = var.plan
+  region             = var.region
+}
+
+module "cos_bucket" {
+  source  = "terraform-ibm-modules/cos/ibm//modules/cos_bucket"
+
+  bucket_name         = var.bucket_name
+  cos_instance_id     = module.cos.cos_instance_id  
+  location            = var.location
+  storage_class       = var.storage_class
+
+}
+```
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+
+| Name            | Description                                                      | Type   | Default | Required |
+|-----------------|------------------------------------------------------------------|:-------|---------|----------|
+| bucket\_name    | Name of the bucket                                               | string | n/a     | yes      |
+| storage\_class  | Storage class to use for the bucket                              | string | n/a     | yes      |
+| location        | The location of a regional bucket                                | string | n/a     | no       |
+| name            | A descriptive name used to identify the resource instance        | string | n/a     | yes      |
+| plan            | The name of the plan type supported by service.                  | string | n/a     | yes      |
+| region          | Target location or environment to create the resource instance.  | string | n/a     | yes      |
+| resource\_group | Name of the resource group                                       | string | n/a     | yes      |
+
+## NOTE: If we want to make use of a particular version of module, then set the argument "version" to respective module version.
diff --git a/modules/cos_bucket/main.tf → modules/bucket/main.tf b/modules/cos_bucket/main.tf → modules/bucket/main.tf
@@ -4,8 +4,8 @@
 #####################################################
 
 resource "ibm_cos_bucket" "testBucket" {
-  bucket_name          = var.bucket_name
-  resource_instance_id = var.cos_instance_id  
-  cross_region_location      = var.location
-  storage_class        = var.storage_class
+  bucket_name             = var.bucket_name
+  resource_instance_id    = var.cos_instance_id  
+  cross_region_location   = var.location
+  storage_class           = var.storage_class
 }
diff --git a/modules/cos_bucket/output.tf → modules/bucket/output.tf b/modules/cos_bucket/output.tf → modules/bucket/output.tf
diff --git a/modules/cos_bucket/variables.tf → modules/bucket/variables.tf b/modules/cos_bucket/variables.tf → modules/bucket/variables.tf
diff --git a/modules/cos_bucket/README.md b/modules/cos_bucket/README.md