mygithub.libinneed.workers.dev/stackitcloud/terraform-provider-stackit

STACKIT Terraform Provider

This project is the official Terraform Provider for STACKIT, which allows you to manage STACKIT resources through Terraform.

Getting Started

To install the STACKIT Terraform Provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    stackit = {
      source = "stackitcloud/stackit"
      version = "X.X.X"
    }
  }
}

provider "stackit" {
  # Configuration options
}

Check one of the examples in the examples folder.

Authentication

To authenticate, you will need a service account. Create it in the STACKIT Portal and assign the necessary permissions to it, e.g. project.owner. There are multiple ways to authenticate:

• Key flow (recommended)
• Token flow (is scheduled for deprecation and will be removed on December 17, 2025.)

When setting up authentication, the provider will always try to use the key flow first and search for credentials in several locations, following a specific order:

• Explicit configuration, e.g. by setting the field service_account_key_path in the provider block (see example below)

• Environment variable, e.g. by setting STACKIT_SERVICE_ACCOUNT_KEY_PATH or STACKIT_SERVICE_ACCOUNT_KEY

• Credentials file

  The provider will check the credentials file located in the path defined by the STACKIT_CREDENTIALS_PATH env var, if specified, or in $HOME/.stackit/credentials.json as a fallback. The credentials file should be a JSON and each credential should be set using the name of the respective environment variable, as stated below in each flow. Example:

  {
    "STACKIT_SERVICE_ACCOUNT_TOKEN": "foo_token",
    "STACKIT_SERVICE_ACCOUNT_KEY_PATH": "path/to/sa_key.json"
  }
  

Key flow

The following instructions assume that you have created a service account and assigned the necessary permissions to it, e.g. `project.owner`.

To use the key flow, you need to have a service account key, which must have an RSA key-pair attached to it.

When creating the service account key, a new pair can be created automatically, which will be included in the service account key. This will make it much easier to configure the key flow authentication in the STACKIT Terraform Provider, by just providing the service account key.

Optionally, you can provide your own private key when creating the service account key, which will then require you to also provide it explicitly to the STACKIT Terraform Provider, additionally to the service account key. Check the STACKIT Docs for an example of how to create your own key-pair.

To configure the key flow, follow this steps:

• Create a service account key:

• Use the STACKIT Portal: go to the Service Accounts tab, choose a Service Account and go to Service Account Keys to create a key. For more details, see Create a service account key

• Save the content of the service account key by copying it and saving it in a JSON file.

  The expected format of the service account key is a JSON with the following structure:

{
  "id": "uuid",
  "publicKey": "public key",
  "createdAt": "2023-08-24T14:15:22Z",
  "validUntil": "2023-08-24T14:15:22Z",
  "keyType": "USER_MANAGED",
  "keyOrigin": "USER_PROVIDED",
  "keyAlgorithm": "RSA_2048",
  "active": true,
  "credentials": {
    "kid": "string",
    "iss": "[e-mail]",
    "sub": "uuid",
    "aud": "string",
    (optional) "privateKey": "private key when generated by the SA service"
  }
}

• Configure the service account key for authentication in the provider by following one of the alternatives below:

  • setting the fields in the provider block: service_account_key or service_account_key_path
  • setting the environment variable: STACKIT_SERVICE_ACCOUNT_KEY_PATH or STACKIT_SERVICE_ACCOUNT_KEY
    • ensure the set the service account key in STACKIT_SERVICE_ACCOUNT_KEY is correctly formatted. Use e.g. $ export STACKIT_SERVICE_ACCOUNT_KEY=$(cat ./service-account-key.json)
  • setting STACKIT_SERVICE_ACCOUNT_KEY_PATH in the credentials file (see above)

Optionally, only if you have provided your own RSA key-pair when creating the service account key, you also need to configure your private key (takes precedence over the one included in the service account key, if present). The private key must be PEM encoded and can be provided using one of the options below:

• setting the field in the provider block: private_key or private_key_path
• setting the environment variable: STACKIT_PRIVATE_KEY_PATH or STACKIT_PRIVATE_KEY
• setting STACKIT_PRIVATE_KEY_PATH in the credentials file (see above)

Token flow

Is scheduled for deprecation and will be removed on December 17, 2025.

Using this flow is less secure since the token is long-lived. You can provide the token in several ways:

• Setting the field service_account_token in the provider
• Setting the environment variable STACKIT_SERVICE_ACCOUNT_TOKEN
• Setting it in the credentials file (see above)

Backend configuration

To keep track of your terraform state, you can configure an S3 backend using STACKIT Object Storage.

To do so, you need an Object Storage S3 bucket and credentials to access it. If you need to create them, check Create and delete Object Storage buckets and Create and delete Object Storage credentials.

Once you have everything setup, you can configure the backend by adding the following block to your Terraform configuration:

terraform {
  backend "s3" {
    bucket = "BUCKET_NAME"
    key    = "path/to/key"
    endpoints = {
      s3 = "https://object.storage.eu01.onstackit.cloud"
    }
    region                      = "eu01"
    skip_credentials_validation = true
    skip_region_validation      = true
    skip_s3_checksum            = true
    skip_requesting_account_id  = true
    secret_key                  = "SECRET_KEY"
    access_key                  = "ACCESS_KEY"
  }
}

Note: AWS specific checks must be skipped as they do not work on STACKIT. For details on what those validations do, see here.

Opting into Beta Resources

To use beta resources in the STACKIT Terraform provider, follow these steps:

• Provider Configuration Option

  Set the enable_beta_resources option in the provider configuration. This is a boolean attribute that can be either true or false.

  provider "stackit" {
    default_region        = "eu01"
    enable_beta_resources = true
  }
  

• Environment Variable

  Set the STACKIT_TF_ENABLE_BETA_RESOURCES environment variable to "true" or "false". Other values will be ignored and will produce a warning.

  export STACKIT_TF_ENABLE_BETA_RESOURCES=true
  

Note: The environment variable takes precedence over the provider configuration option. This means that if the STACKIT_TF_ENABLE_BETA_RESOURCES environment variable is set to a valid value ("true" or "false"), it will override the enable_beta_resources option specified in the provider configuration.

For more details, please refer to the beta resources configuration guide.

Opting into Experiments

Experiments are features that are even less mature and stable than Beta Resources. While there is some assumed stability in beta resources, will have to expect breaking changes while using experimental resources. Experimental Resources do not come with any support or warranty.

To enable experiments set the experiments field in the provider definition:

provider "stackit" {
  default_region        = "eu01"
  experiments           = ["iam", "routing-tables", "network"]
}

Available Experiments

iam

Enables IAM management features in the Terraform provider. The underlying IAM API is expected to undergo a redesign in the future, which leads to it being considered experimental.

routing-tables

This feature enables experimental routing table capabilities in the Terraform Provider, available only to designated SNAs at this time.

network

The stackit_network provides the fields region and routing_table_id when the experiment flag network is set. The underlying API is not stable yet and could change in the future.
If you don't need these fields, don't set the experiment flag network, to use the stable api.

Acceptance Tests

[!WARNING] Acceptance tests will create real resources, which may incur in costs. Some resource may leftover after a test run. This could happen if the tests are modified, tests are stopped during the run or losing the network connection. These resource must be removed manually with the STACKIT CLI or the STACKIT Portal.

Terraform acceptance tests are run using the command make test-acceptance-tf. For all services,

• The env var TF_ACC_PROJECT_ID must be set with the ID of the STACKIT test project to test it.
• The env var TF_ACC_REGION must be set with the region in which the tests should be run.
• Authentication is set as usual.
• Optionally, the env var TF_ACC_XXXXXX_CUSTOM_ENDPOINT (where XXXXXX is the uppercase name of the service) can be set to use endpoints other than the default value.
• There are some acceptance test where it is needed to provide additional parameters, some of them have default values in order to run normally without manual interaction. Those default values can be overwritten (see testutils.go for a full list.)

Additionally:

Env var	Value	Example value	needed for Acc tests of the following services
TF_ACC_ORGANIZATION_ID	ID of the STACKIT test organization	5353ccfa-a984-4b96-a71d-b863dd2b7087	authorization, iaas
TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_EMAIL	Email of the STACKIT service account	[e-mail]	authorization, resourcemanager
TF_ACC_SERVER_ID	ID of a STACKIT Server with STACKIT Server Agent enabled	5353ccfa-a984-4b96-a71d-b863dd2b7087	serverbackup, serverupdate
TF_ACC_TEST_PROJECT_PARENT_CONTAINER_ID	Container ID of the project parent container (folder within an organization or the organization itself)	organization-d2b7087	resourcemanager
TF_ACC_TEST_PROJECT_PARENT_UUID	UUID ID of the project parent container (folder within an organization or the organization itself)	5353ccfa-a984-4b96-a71d-b863dd2b7087	resourcemanager

Run Acceptance Tests of a single service

[!WARNING] Acceptance tests will create real resources, which may incur in costs. Some resource may leftover after a test run. This could happen if the tests are modified, tests are stopped during the run or losing the network connection. These resource must be removed manually with the STACKIT CLI or the STACKIT Portal.

For running the acceptance tests of a single service, set the required env vars from above. Set the env var TF_ACC=1, to enable the acceptance tests.

Start the acceptance tests:

• Configure your env vars in a file, e.g.

  # acc-tests.env
  export TF_ACC="1"
  export TF_ACC_REGION="eu01"
  ...
  

• Read the env vars from the file

  source acc-tests.env
  

• Start the acceptance tests

  $ go test -timeout=60m -v stackit/internal/services/<service>/<service>_acc_test.go
  

Alternative, set your env vars inline and start the acceptance test:

$ TF_ACC=1 \
  TF_ACC_PROJECT_ID=<PROJECT_ID> \
  TF_ACC_REGION=<REGION> \
  STACKIT_SERVICE_ACCOUNT_KEY_PATH=<PATH/TO/SA_KEY.json> \
  go test -timeout=60m -v stackit/internal/services/<service>/<service>_acc_test.go

For some services the acceptance tests take more time. By setting the timeout via the flag -timeout= to a higher time, you ensure that the tests will not be stopped.

Migration

For guidance on how to migrate to using this provider, please see our Migration Guide.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue in the repository.

Contribute

Your contribution is welcome! For more details on how to contribute, refer to our Contribution Guide.

Release creation

See the release documentation for further information.

License

Apache 2.0

Useful Links

• STACKIT Terraform Provider

• STACKIT Portal

• STACKIT

• STACKIT Docs

• STACKIT CLI