terraform-provider-hcloud

README

Terraform Provider for the Hetzner Cloud

• Documentation: https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs

Requirements

• Terraform
  • HashiCorp recommends to use the two latest terraform releases (1.8.x, 1.9.x). Our test suite validates that our provider works with these versions.
  • This provider uses the terraform plugin protocol version 6, and should work with all tools (ie. Terraform & OpenTofu) that supports it.
• Go 1.21.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

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.

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

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.

$ make testacc

You may save your acceptance tests environment variables in the .env file, for example:

$ cat .env
HCLOUD_TOKEN=YOUR_API_TEST_TOKEN
#TF_ACC=1
TF_LOG=DEBUG
TF_LOG_PATH_MASK=test-%s.log

$ go test -v -timeout=30m -parallel=8 ./internal/server
=== RUN   TestAccHcloudDataSourceServerTest
# ...