stackit-dev-tools/terraform-provider-stackitprivatepreview
2
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions
No description
15 commits 9 branches 23 tags 11 MiB
Find a file
João Palet cd0e6b255d
Improve MIGRATION.md note regarding read-only fields added to generat… (#16) 
* Improve MIGRATION.md note regarding read-only fields added to generation config

* Point users to opening issues

* Add link to community provider
2023-09-11 17:03:00 +02:00
.github Implement release pipeline (#9) 2023-09-08 16:03:00 +01:00
docs Add migration import examples for the SKE and LogMe services (#15) 2023-09-11 15:09:33 +02:00
examples Format example (#1) 2023-09-07 11:11:14 +00:00
scripts Initial commit 2023-09-07 11:34:45 +01:00
stackit Add migration import examples for the SKE and LogMe services (#15) 2023-09-11 15:09:33 +02:00
.gitignore Initial commit 2023-09-07 11:34:45 +01:00
.goreleaser.yaml Add goreleaser settings (#10) 2023-09-08 16:30:31 +01:00
CONTRIBUTION.md Update contributing.md (#3) 2023-09-07 14:28:06 +01:00
go.mod Update DSA dependencies (#5) 2023-09-07 16:09:14 +01:00
go.sum Update DSA dependencies (#5) 2023-09-07 16:09:14 +01:00
golang-ci.yaml Initial commit 2023-09-07 11:34:45 +01:00
LICENSE.md Initial commit 2023-09-07 11:34:45 +01:00
main.go Fix provider address (#13) 2023-09-08 18:07:46 +01:00
Makefile Initial commit 2023-09-07 11:34:45 +01:00
MIGRATION.md Improve MIGRATION.md note regarding read-only fields added to generat… (#16) 2023-09-11 17:03:00 +02:00
README.md Initial commit 2023-09-07 11:34:45 +01:00
terraform-registry-manifest.json Implement release pipeline (#9) 2023-09-08 16:03:00 +01:00

README.md

Introduction

This project is the official Terraform provider for STACKIT.

Getting Started

Check one of the examples in the examples folder.

Authentication

Currently, only the token flow is supported. The Terraform provider will first try to find a token in the STACKIT_SERVICE_ACCOUNT_TOKEN env var. If not present, it 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. If the token is found, all the requests are authenticated using that token.

Acceptance tests

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.
  • 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.

Additionally, for the Resource Manager service,

  • A service account with permissions to create and delete projects is required.
  • The env var TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_EMAIL must be set as the email of the service account.
  • The env var TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_TOKEN must be set as a valid token of the service account. Can also be set in the credentials file used by authentication (see Authentication for more details)
  • The env var TF_ACC_PROJECT_ID is ignored.

WARNING: Acceptance tests will create real resources, which may incur in costs.

Reporting issues

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

Contribute

Your contribution is welcome! Please create a pull request (PR). The STACKIT Developer Tools team will review it. A more detailed contribution guideline is planned to come.

License

Apache 2.0