Links

Introduction

IONOS Cloud Terraform Provider

The IonosCloud provider gives the ability to deploy and configure resources using the IonosCloud APIs.

Migrating from the ProfitBricks provider

Please see the Documentation on how to migrate from the ProfitBricks provider.

Requirements

  • Terraform 0.12.x
  • Go 1.18 (to build the provider plugin)
NOTE: In order to use a specific version of this provider, please include the following block at the beginning of your terraform config files details:
provider "ionoscloud" {
version = "~> 6.3.0"
}

Building The Provider

Clone repository to: $GOPATH/src/github.com/ionos-cloud/terraform-provider-ionoscloud
$ mkdir -p $GOPATH/src/github.com/ionos-cloud; cd $GOPATH/src/github.com/ionos-cloud
$ git clone [email protected]:ionos-cloud/terraform-provider-ionoscloud
Enter the provider directory and build the provider
$ cd $GOPATH/src/github.com/ionos-cloud/terraform-provider-ionoscloud
$ make build

Using the provider

See the IonosCloud Provider documentation to get started using the IonosCloud provider.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.18+ is required). You'll also need to correctly set up 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-ionoscloud
...
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

Environment Variables

Environment Variable
Description
IONOS_USERNAME
Specify the username used to login, to authenticate against the IONOS Cloud API
IONOS_PASSWORD
Specify the password used to login, to authenticate against the IONOS Cloud API
IONOS_TOKEN
Specify the token used to login, if a token is being used instead of username and password
IONOS_API_URL
Specify the API URL. It will overwrite the API endpoint default value api.ionos.com`. It is not necessary to override this value unless you have special routing config
IONOS_LOG_LEVEL
Specify the Log Level used to log messages. Possible values: Off, Debug, Trace `
IONOS_PINNED_CERT
Specify the SHA-256 public fingerprint here, enables certificate pinning
IONOS_CONTRACT_NUMBER
Specify the contract number on which you wish to provision. Only valid for reseller accounts, for other types of accounts the header will be ignored

Certificate pinning:

You can enable certificate pinning if you want to bypass the normal certificate checking procedure, by doing the following:
Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>
You can get the sha256 fingerprint most easily form the browser by inspecting the certificate.

Debugging

In the default mode, the Terraform provider returns only HTTP client errors. These usually consist only of the HTTP status code. There is no clear description of the problem. But if you want to see the API call error messages as well, you need to set the SDK and Terraform provider environment variables.
You can enable logging now using the IONOS_LOG_LEVEL env variable. Allowed values: off, debug and trace. Defaults to off.
⚠️ Note: We recommend you only use trace level for debugging purposes. Disable it in your production environments because it can log sensitive data. It logs the full request and response without encryption, even for an HTTPS call. Verbose request and response logging can also significantly impact your application’s performance.
$ export IONOS_LOG_LEVEL=debug
⚠️ Note: IONOS_DEBUG is now deprecated and will be removed in a future release.
⚠️ Note: We recommend you only use IONOS_DEBUG for debugging purposes. Disable it in your production environments because it can log sensitive data. It logs the full request and response without encryption, even for an HTTPS call. Verbose request and response logging can also significantly impact your application’s performance.
$ export TF_LOG=debug
$ export IONOS_DEBUG=true
$ terraform apply
now you can see the response body incl. api error message:
{
"httpStatus" : 422,
"messages" : [ {
"errorCode" : "200",
"message" : "[VDC-yy-xxxx] Operation cannot be executed since this Kubernetes Nodepool is already marked for deletion. Current state of the resource is FAILED_DESTROYING."
}]
}
Last modified 20d ago