From a1e40eb7faefd4869e5a8177cedfe4d8dc835944 Mon Sep 17 00:00:00 2001 From: umarali-nagoor Date: Wed, 19 Aug 2020 19:41:13 +0530 Subject: [PATCH] COS BUCKET: Module structure --- CHANGELOG.md | 10 + CONTRIBUTING.md | 24 +++ LICENSE | 198 ++++++++++++++++++ README.md | 80 ++++++- .../.terraform/modules/modules.json | 1 + .../.terraform/plugins/darwin_amd64/lock.json | 3 + examples/cos_bucket/README.md | 43 ++++ examples/cos_bucket/main.tf | 30 +++ examples/cos_bucket/variables.tf | 51 +++++ examples/cos_bucket/versions.tf | 8 + .../.terraform/modules/modules.json | 1 + .../.terraform/plugins/darwin_amd64/lock.json | 3 + examples/cos_instance/README.md | 29 +++ examples/cos_instance/main.tf | 20 ++ examples/cos_instance/variables.tf | 29 +++ examples/cos_instance/versions.tf | 8 + modules/cos_bucket/README.md | 50 +++++ modules/cos_bucket/main.tf | 11 + modules/cos_bucket/output.tf | 9 + modules/cos_bucket/variables.tf | 24 +++ modules/cos_instance/README.md | 38 ++++ modules/cos_instance/main.tf | 13 ++ modules/cos_instance/output.tf | 9 + modules/cos_instance/variables.tf | 37 ++++ 24 files changed, 728 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 examples/cos_bucket/.terraform/modules/modules.json create mode 100755 examples/cos_bucket/.terraform/plugins/darwin_amd64/lock.json create mode 100644 examples/cos_bucket/README.md create mode 100644 examples/cos_bucket/main.tf create mode 100644 examples/cos_bucket/variables.tf create mode 100644 examples/cos_bucket/versions.tf create mode 100644 examples/cos_instance/.terraform/modules/modules.json create mode 100755 examples/cos_instance/.terraform/plugins/darwin_amd64/lock.json create mode 100644 examples/cos_instance/README.md create mode 100644 examples/cos_instance/main.tf create mode 100644 examples/cos_instance/variables.tf create mode 100644 examples/cos_instance/versions.tf create mode 100644 modules/cos_bucket/README.md create mode 100644 modules/cos_bucket/main.tf create mode 100644 modules/cos_bucket/output.tf create mode 100644 modules/cos_bucket/variables.tf create mode 100644 modules/cos_instance/README.md create mode 100644 modules/cos_instance/main.tf create mode 100644 modules/cos_instance/output.tf create mode 100644 modules/cos_instance/variables.tf diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..789736e3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +Extending the adopted spec, each change should have a link to its +corresponding pull request appended. + +## [1.0.0] - 2020-08-20 + +This is the initial release of the module, with support for cos bucket creation. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d43e0547 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +This document provides guidelines for contributing to the module. + +## File structure + +The project has the following folders and files: + +├── README.md +├── modules/ +│ ├── nestedA/ +│ │ ├── README.md +│ │ ├── variables.tf +│ │ ├── main.tf +│ │ ├── outputs.tf +│ ├── nestedB/ +│ ├── .../ +├── examples/ +│ ├── exampleA/ +│ │ ├── main.tf +│ ├── exampleB/ +│ ├── .../ + +Please make sure you are changes are inline with directory structure mentined as above. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..8f4eed4b --- /dev/null +++ b/LICENSE @@ -0,0 +1,198 @@ + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md index f25e3019..d333c0b3 100644 --- a/README.md +++ b/README.md @@ -1 +1,79 @@ -# terraform-ibm-cos \ No newline at end of file +# 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: +* [COS Instance](modules/cos_instance) +* [COS Bucket](modules/cos_bucket) + +## Compatibility + +This module is meant for use with Terraform 0.12. If you haven't +[upgraded][terraform-0.12-upgrade] and need a Terraform 0.11.x-compatible +version of this module, the last released version intended for Terraform 0.11.x +is [1.1.1][v1.1.1]. + +## Usage + +Full examples are in the [examples](./examples/) folder, but basic usage is as follows for creation of COS instance: + +```hcl +data "ibm_resource_group" "cos_group" { + name = "test" +} + +module "cos" { + source = "../../modules/cos_instance" + + name = "testcos" + resource_group_id = data.ibm_resource_group.cos_group.id + plan = "testplan" + location = "testregion" +} + +``` + +Creation of cloud object storage bucket: + +```hcl +data "ibm_resource_group" "cos_group" { + name = "test" +} + +module "cos" { + source = "../../modules/cos_instance" + + name = "testcos" + resource_group_id = data.ibm_resource_group.cos_group.id + plan = "testplan" + location = "testregion" +} + +module "cos_bucket" { + source = "../../modules/cos_bucket" + + bucket_name = "testbucket" + resource_instance_id = module.cos.cos_instance_id + cross_region_location = "testlocation" + storage_class = "teststorage" + +} +``` + +## Requirements + +### Terraform plugins + +- [Terraform](https://www.terraform.io/downloads.html) 0.12 +- [terraform-provider-ibm](https://github.com/IBM-Cloud/terraform-provider-ibm) + +## Install + +### Terraform + +Be sure you have the correct Terraform version (0.12), you can choose the binary here: +- https://releases.hashicorp.com/terraform/ + +### Terraform plugins + +Be sure you have the compiled plugins on $HOME/.terraform.d/plugins/ + +- [terraform-provider-ibm](https://github.com/IBM-Cloud/terraform-provider-ibm) \ No newline at end of file diff --git a/examples/cos_bucket/.terraform/modules/modules.json b/examples/cos_bucket/.terraform/modules/modules.json new file mode 100644 index 00000000..3bcbd7b6 --- /dev/null +++ b/examples/cos_bucket/.terraform/modules/modules.json @@ -0,0 +1 @@ +{"Modules":[{"Key":"cos_bucket","Source":"../../modules/cos_bucket","Dir":"../../modules/cos_bucket"},{"Key":"","Source":"","Dir":"."},{"Key":"cos","Source":"../../modules/cos_instance","Dir":"../../modules/cos_instance"}]} \ No newline at end of file diff --git a/examples/cos_bucket/.terraform/plugins/darwin_amd64/lock.json b/examples/cos_bucket/.terraform/plugins/darwin_amd64/lock.json new file mode 100755 index 00000000..e07e37a1 --- /dev/null +++ b/examples/cos_bucket/.terraform/plugins/darwin_amd64/lock.json @@ -0,0 +1,3 @@ +{ + "ibm": "fd20d2dfc5c2bce963c58f8db1c108c5e395095628d1f6d4303dc4b1d3db2c4f" +} \ No newline at end of file diff --git a/examples/cos_bucket/README.md b/examples/cos_bucket/README.md new file mode 100644 index 00000000..0401adc4 --- /dev/null +++ b/examples/cos_bucket/README.md @@ -0,0 +1,43 @@ +# Module cos_bucket + +This module is used to create a cloud object storage bucket + +## Example Usage +``` +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 +} + +module "cos_bucket" { + source = "../../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 + +} +``` + + +## 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 | + diff --git a/examples/cos_bucket/main.tf b/examples/cos_bucket/main.tf new file mode 100644 index 00000000..c83fb761 --- /dev/null +++ b/examples/cos_bucket/main.tf @@ -0,0 +1,30 @@ +##################################################### +# COS Bucket +# Copyright 2020 IBM +##################################################### + +provider "ibm" { +} + +data "ibm_resource_group" "cos_group" { + name = var.resource_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 +} + +module "cos_bucket" { + source = "../../modules/cos_bucket" + + bucket_name = var.bucket_name + cos_instance_id = module.cos.cos_instance_id + location = var.location + storage_class = var.storage_class + +} \ No newline at end of file diff --git a/examples/cos_bucket/variables.tf b/examples/cos_bucket/variables.tf new file mode 100644 index 00000000..375b374c --- /dev/null +++ b/examples/cos_bucket/variables.tf @@ -0,0 +1,51 @@ +##################################################### +# COS Bucket +# Copyright 2020 IBM +##################################################### + +variable "ibmcloud_api_key" { + description = "IBM Cloud API KEY" + type = string +} + +// Bucket congigurations + +variable "bucket_name" { + description = "Enter Bucket name" + type = string +} + +variable "location" { + description = "Bucket cross region location for provision" + type = string +} + +variable "storage_class" { + description = " Bucket storage class." + type = string +} + +// cos-instance + +variable "resource_group" { + description = "Enter Name of the resource group" + type = string +} + +variable "service_name" { + description = "Enter service name " + type = string +} + +variable "plan" { + description = "Enter plan type" + type = string +} + +variable "region" { + description = "Enter Region for provisioning" + type = string +} + + + diff --git a/examples/cos_bucket/versions.tf b/examples/cos_bucket/versions.tf new file mode 100644 index 00000000..8c4fc9f9 --- /dev/null +++ b/examples/cos_bucket/versions.tf @@ -0,0 +1,8 @@ +##################################################### +# COS Bucket +# Copyright 2020 IBM +##################################################### + +terraform { + required_version = ">= 0.12" +} \ No newline at end of file diff --git a/examples/cos_instance/.terraform/modules/modules.json b/examples/cos_instance/.terraform/modules/modules.json new file mode 100644 index 00000000..3982d098 --- /dev/null +++ b/examples/cos_instance/.terraform/modules/modules.json @@ -0,0 +1 @@ +{"Modules":[{"Key":"","Source":"","Dir":"."},{"Key":"cos","Source":"../../modules/cos_instance","Dir":"../../modules/cos_instance"}]} \ No newline at end of file diff --git a/examples/cos_instance/.terraform/plugins/darwin_amd64/lock.json b/examples/cos_instance/.terraform/plugins/darwin_amd64/lock.json new file mode 100755 index 00000000..e07e37a1 --- /dev/null +++ b/examples/cos_instance/.terraform/plugins/darwin_amd64/lock.json @@ -0,0 +1,3 @@ +{ + "ibm": "fd20d2dfc5c2bce963c58f8db1c108c5e395095628d1f6d4303dc4b1d3db2c4f" +} \ No newline at end of file diff --git a/examples/cos_instance/README.md b/examples/cos_instance/README.md new file mode 100644 index 00000000..1272a2ef --- /dev/null +++ b/examples/cos_instance/README.md @@ -0,0 +1,29 @@ +# Module cos_instance + +This module is used to create a cloud object storage instance. + +## Example Usage +``` +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 +} + +``` + +## 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 | diff --git a/examples/cos_instance/main.tf b/examples/cos_instance/main.tf new file mode 100644 index 00000000..4649cc5f --- /dev/null +++ b/examples/cos_instance/main.tf @@ -0,0 +1,20 @@ +##################################################### +# COS Instance +# Copyright 2020 IBM +##################################################### + +provider "ibm" { +} + +data "ibm_resource_group" "cos_group" { + name = var.resource_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 +} \ No newline at end of file diff --git a/examples/cos_instance/variables.tf b/examples/cos_instance/variables.tf new file mode 100644 index 00000000..8a2bcad9 --- /dev/null +++ b/examples/cos_instance/variables.tf @@ -0,0 +1,29 @@ +##################################################### +# COS Instance +# Copyright 2020 IBM +##################################################### + +variable "resource_group" { + description = "Enter Name of the resource group" + type = string +} + +variable "service_name" { + description = "Enter Name of the cos instance" + type = string +} + +variable "plan" { + description = "Enter plan type" + type = string +} + +variable "region" { + description = " Enter Region for provisioning" + type = string +} + +variable "ibmcloud_api_key" { + description = " Enter IBM Cloud API KEY" + type = string +} \ No newline at end of file diff --git a/examples/cos_instance/versions.tf b/examples/cos_instance/versions.tf new file mode 100644 index 00000000..af51da0f --- /dev/null +++ b/examples/cos_instance/versions.tf @@ -0,0 +1,8 @@ +##################################################### +# COS Instance +# Copyright 2020 IBM +##################################################### + +terraform { + required_version = ">= 0.12" +} \ No newline at end of file diff --git a/modules/cos_bucket/README.md b/modules/cos_bucket/README.md new file mode 100644 index 00000000..979f3869 --- /dev/null +++ b/modules/cos_bucket/README.md @@ -0,0 +1,50 @@ +# Module cos_bucket + +This module is used to create a cloud object storage bucket + +## Example Usage +``` +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 +} + +module "cos_bucket" { + source = "../../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 + +} +``` + + +## 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 | + +## Outputs + +| Name | Description | +|------|-------------| +| cos\_\bucket\_id | COS Bucket ID. | + + diff --git a/modules/cos_bucket/main.tf b/modules/cos_bucket/main.tf new file mode 100644 index 00000000..b28d5f83 --- /dev/null +++ b/modules/cos_bucket/main.tf @@ -0,0 +1,11 @@ +##################################################### +# COS Bucket +# Copyright 2020 IBM +##################################################### + +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 +} \ No newline at end of file diff --git a/modules/cos_bucket/output.tf b/modules/cos_bucket/output.tf new file mode 100644 index 00000000..c63e6f66 --- /dev/null +++ b/modules/cos_bucket/output.tf @@ -0,0 +1,9 @@ +##################################################### +# COS Bucket +# Copyright 2020 IBM +##################################################### + +output "cos_bucket_id" { + description = "The ID of the cos instance" + value = ibm_cos_bucket.testBucket.id //doubt +} \ No newline at end of file diff --git a/modules/cos_bucket/variables.tf b/modules/cos_bucket/variables.tf new file mode 100644 index 00000000..0e3c00d4 --- /dev/null +++ b/modules/cos_bucket/variables.tf @@ -0,0 +1,24 @@ +##################################################### +# COS Bucket +# Copyright 2020 IBM +##################################################### + +variable "bucket_name" { + description = "Name of the bucket" + type = string +} + +variable "location" { + description = "Location to provision" + type = string +} + +variable "storage_class" { + description = " storage class to use for the bucket." + type = string +} + +variable "cos_instance_id"{ + description = "resource instance id" + type = string +} \ No newline at end of file diff --git a/modules/cos_instance/README.md b/modules/cos_instance/README.md new file mode 100644 index 00000000..c7866b07 --- /dev/null +++ b/modules/cos_instance/README.md @@ -0,0 +1,38 @@ +# Module cos_instance + +This module is used to create a cloud object storage instance. + +## Example Usage +``` +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 +} + +``` + + +## 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 | + +## Outputs + +| Name | Description | +|------|-------------| +| cos\_instance\_id | COS Instance ID. | + + \ No newline at end of file diff --git a/modules/cos_instance/main.tf b/modules/cos_instance/main.tf new file mode 100644 index 00000000..ca4616bc --- /dev/null +++ b/modules/cos_instance/main.tf @@ -0,0 +1,13 @@ +##################################################### +# COS Instance +# Copyright 2020 IBM +##################################################### + +resource "ibm_resource_instance" "cos_instance" { + name = var.service_name + resource_group_id = var.resource_group_id + service = var.service_type + plan = var.plan + location = var.region +} + diff --git a/modules/cos_instance/output.tf b/modules/cos_instance/output.tf new file mode 100644 index 00000000..4af09783 --- /dev/null +++ b/modules/cos_instance/output.tf @@ -0,0 +1,9 @@ +##################################################### +# COS Instance +# Copyright 2020 IBM +##################################################### + +output "cos_instance_id" { + description = "The ID of the cos instance" + value = ibm_resource_instance.cos_instance.id +} \ No newline at end of file diff --git a/modules/cos_instance/variables.tf b/modules/cos_instance/variables.tf new file mode 100644 index 00000000..f7d23c1a --- /dev/null +++ b/modules/cos_instance/variables.tf @@ -0,0 +1,37 @@ +##################################################### +# COS Instance +# Copyright 2020 IBM +##################################################### + +######## configured by user ######################## + +variable "resource_group_id" { + description = "ID of the resource group" + type = string +} + +variable "service_name" { + description = "Name of the instance" + type = string +} + +variable "plan" { + description = "plan type" + type = string +} + +variable "region" { + description = "Provisioning Region" + type = string +} + +########### Having Default Values ############ + +variable "service_type" { + description = "Type of the service" + default = "cloud-object-storage" + type = string +} + + +