Skip to content

Latest commit

 

History

History
187 lines (128 loc) · 7.18 KB

README.md

File metadata and controls

187 lines (128 loc) · 7.18 KB
Raw

GitHub go.mod Go version GitHub release (latest by date including pre-releases) GitHub Workflow Status GitHub
GitHub contributors GitHub commit activity GitHub all releases GitHub stars

Terraform Provider

Requirements

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

Building The Provider

Clone repository

git clone [email protected]:IBM-Cloud/terraform-provider-ibm.git

Enter the provider directory and build the provider

cd 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

Download the Provider from the Terraform Registry (Option 1)

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 a versions.tf file in in your Terraform module folder and add a terraform 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>"
      }
    }
  }
  1. Run terraform init to fetch the IBM Cloud provider plug-in for Terraform from the Terraform Registry.

Download the Provider Manually (Option 2)

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 Terraform plugins 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 be IBM 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".
  1. Add the plug-in provider to the Terraform configuration file.
provider "ibm" {}

See the official documentation for more details on 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.

  • IC_API_KEY- The IBM Cloud API Key
  • IC_REGION - The IBM Cloud region used by test resources - defaults to us-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 inspect ibm/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,

IBM Cloud Ansible Modules

An implementation of generated Ansible modules using the IBM Cloud Terraform Provider.

Prerequisites

  1. Install Python3

  2. RedHat Ansible 2.8+

    pip install "ansible>=2.8.0"

Install

  1. Download IBM Cloud Ansible modules from release page

  2. Extract module archive.

    unzip ibmcloud_ansible_modules.zip

  3. Add modules and module_utils to the Ansible search path. E.g.:

    cp build/modules/* $HOME/.ansible/plugins/modules/.
cp build/module_utils/* $HOME/.ansible/plugins/module_utils/.

Example Projects

  1. VPC Virtual Server Instance

  2. Power Virtual Server Instance