terraform-provider-ibm

README

Terraform Provider

• Website: https://www.terraform.io
• 
• Mailing list: Google Groups

Requirements

• Terraform 0.10.1+
• Go 1.9 (to build the provider plugin)

Building The Provider

Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-ibm

$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone git@github.com:IBM-Bluemix/terraform-provider-ibm.git

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-ibm
$ make build

Docker Image For The Provider

You can also pull the docker image for the ibmcloud terraform provider :

 $ docker pull ibmterraform/terraform-provider-ibm-docker

Using the provider

See the IBM Provider documentation to get started using the IBM provider.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.8+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make build
...
$ $GOPATH/bin/terraform-provider-ibm
...

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc

In order to run a particular Acceptance test, export the variable TESTARGS. For example

$ export TESTARGS="-run TestAccIBMNetworkVlan_Basic"

Issuing make testacc will now run the testcase with names matching TestAccIBMNetworkVlan_Basic. This particular testcase is present in ibm/resource_ibm_network_vlan_test.go

You will also need to export the following environment variables for running the Acceptance tests.

• BM_API_KEY- The Bluemix API Key
• SL_API_KEY - The SoftLayer API Key
• SL_USERNAME - The SoftLayer username associated with the SoftLayer API Key.