Bigstep Metalcloud Terraform Provider

This is a terraform plugin for controlling Bigstep Metalcloud resources.

Maintainers

This provider plugin is maintained by the Bigstep Team.

Requirements

• Terraform 0.12.x
• Go 1.11 (to build the provider plugin)

Installing The Provider

1. Build the provider

This will install the plugin binary in $GOPATH/bin/:

git clone https://github.com/bigstepinc/terraform-provider-metalcloud
cd terraform-provider-metalcloud
make

2. Install the provider plugin

If $GOPATH/bin not in $PATH you might need to put the plugin in the plugin directory: <PLUGIN_PATH>/<OS>_<ARCH> on most operating systems or %APPDATA%\terraform.d\plugins\<OS>_<ARCH> on Windows.

See Terraform plugin locations for more information.

Note: <OS> and <ARCH> use the Go language's standard OS and architecture names; for example, darwin_amd64.

mkdir -p ~/.terraform.d/plugins/darwin_amd64/
cp $GOPATH/bin/terraform-provider-metalcloud ~/.terraform.d/plugins/darwin_amd64/
terraform init

Using the Provider

A terraform main.tf template file, for an infrastructure with a single server would look something like this:

provider "metalcloud" {
   user_email = var.user_email
   api_key = var.api_key 
   endpoint = var.endpoint
}

data "metalcloud_volume_template" "centos76" {
  volume_template_label = "centos7-6"
}

resource "metalcloud_infrastructure" "my-infra216" {
  
  infrastructure_label = "my-terraform-infra216"
  datacenter_name = var.datacenter
  
  prevent_deploy = true

  network{
    network_type = "san"
    network_label = "san"
  }

  network{
    network_type = "wan"
    network_label = "internet"
  }

  network{
    network_type = "lan"
    network_label = "private"
  }


  instance_array {
    instance_array_label = "exmaple-master"
    instance_array_instance_count = 2
    instance_array_ram_gbytes = 8
    instance_array_processor_count = 1
    instance_array_processor_core_count = 8

    interface{
        interface_index = 0
        network_label = "san"
    }

    interface{
        interface_index = 1
        network_label = "internet"
    }

    interface{
        interface_index = 2
        network_label = "private"
    }
    
    drive_array{
      drive_array_label = "example-master-os-drive"
      drive_array_storage_type = "iscsi_hdd"
      drive_size_mbytes_default = 49000
      volume_template_id = tonumber(data.metalcloud_volume_template.centos76.id)
    }

    firewall_rule {
      firewall_rule_description = "test fw rule"
      firewall_rule_port_range_start = 22
      firewall_rule_port_range_end = 22
      firewall_rule_source_ip_address_range_start="0.0.0.0"
      firewall_rule_source_ip_address_range_end="0.0.0.0"
      firewall_rule_protocol="tcp"
      firewall_rule_ip_address_type="ipv4"
    }
  }

  instance_array {
    instance_array_label = "example-slave"  
    instance_array_instance_count = 1
    instance_array_ram_gbytes = 8
    instance_array_processor_count = 1
    instance_array_processor_core_count = 8

    drive_array{
      drive_array_label = "example-slave-os-drive"
      drive_array_storage_type = "iscsi_hdd"
      drive_size_mbytes_default = 49000
      volume_template_id = tonumber(data.metalcloud_volume_template.centos76.id)
    }

    firewall_rule {
      firewall_rule_description = "test fw rule"
      firewall_rule_port_range_start = 22
      firewall_rule_port_range_end = 22
      firewall_rule_source_ip_address_range_start="0.0.0.0"
      firewall_rule_source_ip_address_range_end="0.0.0.0"
      firewall_rule_protocol="tcp"
      firewall_rule_ip_address_type="ipv4"
    }
  }
}

To deploy this infrastructure export the following variables (or use -var):

export TF_VAR_api_key="<yourkey>"
export TF_VAR_user="test@test.com"
export TF_VAR_endpoint="https://api.bigstep.com/metal-cloud"
export TF_VAR_datacenter="uk-reading"

The plan phase:

terraform plan

The apply phase:

terraform apply

To delete the infrastrucure:

terraform destroy

Building The Provider

Clone repository to: $GOPATH/src/github.com/bigstepinc/terraform-provider-metalcloud

$ mkdir -p $GOPATH/src/github.com/bigstepinc; cd $GOPATH/src/github.com/bigstepinc
$ git clone git@github.com:bigstepinc/terraform-provider-metalcloud.git

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/bigstepinc/terraform-provider-metalcloud
$ make build

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ 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-metalcloud
...

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.

export METALCLOUD_DATACENTER="uk-reading"
export METALCLOUD_API_KEY="<api-key>"
export METALCLOUD_USER_EMAIL="user"
export METALCLOUD_ENDPOINT="https://your-endpoint"

make testacc