Terraform Provider for the Hetzner Cloud

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

Requirements

• Terraform or OpenTofu
  • Our provider tests run with Terraform or OpenTofu releases that are supported upstream.
  • Our provider should work with any tool that supports the terraform plugin protocol version 6.
• 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
# ...

Running a local build

Choose a terraform cli config file path:

export TF_CLI_CONFIG_FILE="terraform.tfrc"

In the terraform cli config file, override the lookup path for the hetznercloud/hcloud provider to use the local build:

cat <<EOF >"$TF_CLI_CONFIG_FILE"
provider_installation {
  dev_overrides {
    "hetznercloud/hcloud" = "$PWD"
  }

  direct {}
}
EOF

Build the provider, resulting in a terraform-provider-hcloud binary:

make build

Finally, run your terraform plan to see if it works:

tofu plan

You should see the following warning:

╷
│ Warning: Provider development overrides are in effect
│
│ The following provider development overrides are set in the CLI configuration:
│  - hetznercloud/hcloud in /home/user/code/github.com/hetznercloud/terraform-provider-hcloud
│
│ The behavior may therefore not match any released version of the provider and applying changes may cause the state to become incompatible with published releases.
╵

Releasing experimental features

To publish experimental features as part of regular releases:

• an announcement, including a link to a changelog entry, must be added to the release notes.

• an Experimental notice, must be added to the experimental resource, datasource, and functions descriptions:

  func (r *Resource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
    resp.Schema.MarkdownDescription = `
  Manage a Hetzner Cloud Product.
  
  See https://docs.hetzner.cloud/reference/cloud#product for more details.
  `
    experimental.Product.AppendNotice(&resp.Schema.MarkdownDescription)
  }

• a Experimental warning must be logged when experimental resource, datasource, or functions are being used:

  func (r *Resource) Configure(_ context.Context, _ resource.ConfigureRequest, resp *resource.ConfigureResponse) {
    experimental.Product.AppendDiagnostic(&resp.Diagnostics)
  }