Corrected table format and changed provider from Google to IBM

terraform-ibm-modules · Oct 14, 2020 · 49effba · 49effba
1 parent a1e40eb
commit 49effba
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # IBM COS Bucket Terraform Module
 
-This is a collection of modules that make it easier to provision a cloud object stoarge on Google Cloud Platform:
+This is a collection of modules that make it easier to provision a cloud object stoarge on IBM Cloud Platform:
 * [COS Instance](modules/cos_instance)
 * [COS Bucket](modules/cos_bucket)
 
@@ -76,4 +76,4 @@ Be sure you have the correct Terraform version (0.12), you can choose the binary
 
 Be sure you have the compiled plugins on $HOME/.terraform.d/plugins/
 
-- [terraform-provider-ibm](https://github.com/IBM-Cloud/terraform-provider-ibm) 
+- [terraform-provider-ibm](https://github.com/IBM-Cloud/terraform-provider-ibm) 
diff --git a/examples/cos_bucket/README.md b/examples/cos_bucket/README.md
@@ -31,13 +31,14 @@ module "cos_bucket" {
 <!-- 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 |
+
+| 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      |
 
diff --git a/examples/cos_instance/README.md b/examples/cos_instance/README.md
@@ -21,9 +21,9 @@ module "cos" {
 
 ## Inputs
 
-| Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| 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 |
-| location | Target location or environment to create the resource instance.  | string | n/a | yes |
-| resource\_group | Name of the resource group | string | n/a | yes |
+| Name            | Description                                                      | Type   | Default | Required |
+|-----------------|------------------------------------------------------------------|:-------|:------- |:---------|
+| 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      |
+| location        | Target location or environment to create the resource instance.  | string | n/a     | yes      |
+| resource\_group | Name of the resource group                                       | string | n/a     | yes      |
diff --git a/modules/cos_bucket/README.md b/modules/cos_bucket/README.md
@@ -31,20 +31,20 @@ module "cos_bucket" {
 <!-- 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 |
+| 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      |
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
+| Name             | Description    |
+|------------------|----------------|
 | cos\_\bucket\_id | COS Bucket ID. |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/modules/cos_bucket/output.tf b/modules/cos_bucket/output.tf
@@ -5,5 +5,5 @@
 
 output "cos_bucket_id" {
   description = "The ID of the cos instance"
-  value       = ibm_cos_bucket.testBucket.id  //doubt
-}
+  value       = ibm_cos_bucket.testBucket.id 
+}
diff --git a/modules/cos_instance/README.md b/modules/cos_instance/README.md
@@ -22,17 +22,17 @@ module "cos" {
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
-| Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| 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 |
-| location | Target location or environment to create the resource instance.  | string | n/a | yes |
-| resource\_group | Name of the resource group | string | n/a | yes |
+| Name            | Description                                                     | Type   | Default | Required |
+|-----------------|-----------------------------------------------------------------|:-------|:--------|:---------|
+| 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      |
+| location        | Target location or environment to create the resource instance. | string | n/a     | yes      |
+| resource\_group | Name of the resource group                                      | string | n/a     | yes      |
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
+| Name              | Description      |
+|-------------------|------------------|
 | cos\_instance\_id | COS Instance ID. |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->