Repository files navigation

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

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

Clone repository

git clone git@github.com:IBM-Cloud/terraform-provider-ibm.git

Enter the provider directory and build the provider

cd terraform-provider-ibmmake build

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

docker pull ibmterraform/terraform-provider-ibm-docker

Complete the following steps to configure the IBM Cloud provider plug-in for Terraform v0.13 and newer versions.

1. Download and install Terraform for your system.

2. Create aversions.tf file in in your Terraform module folder and add aterraform block using the syntax below. Note, you must be using Terraform v0.13.x or a newer version.

 terraform {   required_providers {      ibm = {         source = "IBM-Cloud/ibm"         version = "<provider version>"      }    }  }

3. Runterraform init to fetch the IBM Cloud provider plug-in for Terraform from the Terraform Registry.

If you want to run Terraform with the IBM Cloud provider plugin on your system, complete the following steps:

1. Download and install Terraform for your system.

2. Download the IBM Cloud provider plugin for Terraform.

3. Unzip the release archive to extract the plugin binary (terraform-provider-ibm_vX.Y.Z).

4. Move the binary into the Terraformplugins directory for the platform.

   • Linux/Unix/OS X:~/.terraform.d/plugins
   • Windows:%APPDATA%\terraform.d\plugins

5. Export API credential tokens as environment variables. This can either beIBM Cloud API keys or Softlayer API keys and usernames, depending on the resources you are provisioning.

export IC_API_KEY="IBM Cloud API Key"export IAAS_CLASSIC_API_KEY="IBM Cloud Classic Infrastructure API Key"export IAAS_CLASSIC_USERNAME="IBM Cloud Classic Infrastructure username associated with Classic Infrastructure API KEY".

6. Add the plug-in provider to the Terraform configuration file.

provider "ibm" {}

See theofficial documentation for more details on using the IBM provider.

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

To compile the provider, runmake 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 runmake test.

maketest

In order to run the full suite of Acceptance tests, runmake 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 variableTESTARGS. For example

export TESTARGS="-run TestAccIBMNetworkVlan_Basic"

Issuingmake testacc will now run the testcase with names matchingTestAccIBMNetworkVlan_Basic. This particular testcase is present inibm/resource_ibm_network_vlan_test.go

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

• IC_API_KEY- The IBM Cloud API Key
• IC_REGION - The IBM Cloudregion used by test resources - defaults tous-south
• IAAS_CLASSIC_API_KEY - The IBM Cloud Classic Infrastructure API Key
• IAAS_CLASSIC_USERNAME - The IBM Cloud Classic Infrastructure username associated with the Classic InfrastAPI Key.

Additional environment variables may be required depending on the tests being run. Check console log for warning messages about required variables.

Alternatively, look for the name of the function by PreCheck under the specific test case and inspectibm/acctest/acctest.go to find the list of environment variables required for the test.

resource.Test(t, resource.TestCase{PreCheck:     func() { acc.TestAccPreCheck(t) },Providers:    acc.TestAccProviders,

An Ansible Collection package contains many Ansible Modules,each Ansible Module is a wrapper around resource or data sourceelements of theTerraform Provider for IBM Cloud.At each execution of an Ansible Module, on-the-fly Terraformcode is generated and executed for the intended outcome.

Compatible with Ansible Core 2.12+, variousexample Ansible Playbooksare provided to show how to usethe Ansible Modules from the Ansible Collection for IBM Cloud.

See more information on the package index entryibm.cloudcollection Ansible Collection - Ansible Galaxy.