Skip to content

MissionCriticalCloud/terraform-provider-cosmic

Repository files navigation

Terraform Provider

Requirements

  • Terraform 0.10+
  • Go 1.11 (to build the provider plugin)

Building The Provider

Clone repository to: $GOPATH/src/github.com/MissionCriticalCloud/terraform-provider-cosmic

$ mkdir -p $GOPATH/src/github.com/MissionCriticalCloud; cd $GOPATH/src/github.com/MissionCriticalCloud
$ git clone [email protected]:MissionCriticalCloud/terraform-provider-cosmic

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/MissionCriticalCloud/terraform-provider-cosmic
$ make build

Using the provider

If you're building the provider, follow the instructions to install it as a plugin. After placing it into your plugins directory, run terraform init to initialize it.

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-cosmic
...

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.

$ make testacc

Note: Acceptance tests create real resources and require the following shell variables to be exported:

  • COSMIC_API_URL - Cosmic API URL to run tests against
  • COSMIC_API_KEY - Valid API key
  • COSMIC_SECRET_KEY - Valid API secret key
  • COSMIC_ZONE - Cosmic zone to run tests against

Optionally the following need to be exported for certain tests:

  • COSMIC_DISK_OFFERING - An existing disk offering to test storage
  • COSMIC_SERVICE_OFFERING_1 - An existing service offering to test provisioning instances
  • COSMIC_SERVICE_OFFERING_2 - A second existing service offering to test provisioning instances
  • COSMIC_TEMPLATE - An existing template to test provisioning instances
  • COSMIC_VPC_NETWORK_OFFERING - An existing VPC network offering to test provisioning VPC networks