Terraform Provider for the Hetzner Cloud

Website: https://www.terraform.io
Documentation: https://www.terraform.io/docs/providers/hcloud/index.html

Requirements

Terraform 0.13.x, 0.14.x
Go 1.16.x (to build the provider plugin)

API Stability

This Go module implements a Terraform Provider for Hetzner Cloud Services. We thus guarantee backwards compatibility only for use through Terraform HCL. The actual Go code in this repository may change without a major version increase.

Currently the code is mostly located in the hcloud package. In the long term we want to move most of the hcloud package into individual sub-packages located in the internal directory. The goal is a structure similar to HashiCorp's Terraform Provider Scaffolding

Building the provider

Clone repository to: $GOPATH/src/github.com/hetznercloud/terraform-provider-hcloud

$ mkdir -p $GOPATH/src/github.com/hetznercloud; cd $GOPATH/src/github.com/hetznercloud
$ git clone https://github.com/hetznercloud/terraform-provider-hcloud.git

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/hetznercloud/terraform-provider-hcloud
$ make build

Using the provider

if you are 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.14+ 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
...
$ ./bin/terraform-provider-hcloud
...

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.