terraform-ibmcloud-modules

README

Terraform Ibmcloud Modules

Collection of Terraform modules for IBM Cloud that will allow for users to more easily use Terraform to manage resources in the IBMCloud

Required Packages/Tools

1. Terraform >= v0.12.x - https://github.com/IBM-Cloud/terraform-provider-ibm
2. Terraform IBM Provider >= v1.7.1 - https://learn.hashicorp.com/tutorials/terraform/install-cli
3. Terratest - https://github.com/gruntwork-io/terratest
4. GO - https://golang.org/dl/
5. Gotestsum - https://github.com/gotestyourself/gotestsum

Optional Packages/Tools

1. Docker - https://www.docker.com/products/docker-desktop
2. Make - https://www.gnu.org/software/make/

Required Environment Variables

IBMCLOUD_API_KEY=<YOUR_API_KEY>

Convenience Container

There is a convenience container that you can build, run tests, and create a bash session with dev packages already installed.

** IBMCLOUD_API_KEY needs to be set to use the docker container **

Building the Container

Build the convenience container

make docker-build

Executing Commands

Once on the container you can execute Terraform commands from Terraform created on your local source tree as it will mount the repo directory in the container

make debug-container

Executing Tests

Will execute all of the tests in the test directory. If you want to point at a different environment you can add an env file to the environments directory and pass it into the make run-tests. It currently defaults to our staging environment

make run-tests
or
make run-tests ENVIRONMENT=staging

Contributing

1. The modules that are added need to be self contained Terraform modules for a specific Terraform resource in the provider.
2. Each module should take care of initializing each dependent resource that is needed for the resource type i.e. VPC module will initiate a resource group
3. Each module directory should have the following minimal files
   1. main.tf - Institiates the IBMCloud resources from the provider
   2. outputs.tf - Defines output objects
   3. variables.tf - What required inputs are needed for the specific module use defaults whenever possible
   4. versions.tf - Any specific version required for the modules

Rules of Engagement

In order to have your additions to the repo merged into main all of the below must happen

• Branch is up to date with master
• All tests need to pass in Travis which can be executed locally by running
  make run-tests
• PR has been reviewed by at least 1 repo Admin
• The contributor has added a test for any new modules created and/or updated any tests to test the new functionality they are adding

It is the responsibility of the person who submitted the PR to merge into main once all of the requirements above have been met

Module Requests and Defects

If there are any specific module requests and/or any bugs that are found that need to be fixed please submit an issue through github. One of the admins will groom the issues backlog on a regular cadence to make sure bugs and modules are getting completed