diff --git a/MIGRATION.md b/MIGRATION.md index 26d31ec15..ac1509fb5 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -1,6 +1,6 @@ -# Migration from the Terraform community provider +# Migration Guide -In this guide, we want to offer some strategy for a migration of configurations from the [Terraform community provider](https://github.com/SchwarzIT/terraform-provider-stackit) to this new official provider. In this provider, some attribute names and structure have changed, as well as the internal resource ID structure. +In this guide we want to offer some strategy for a migration of configurations or existing resources to the STACKIT official provider. In relation to the [Terraform community provider](https://github.com/SchwarzIT/terraform-provider-stackit), some attribute names and structure have changed, as well as the internal resource ID structure. To import your existing infrastructure resources to the new provider, you'll need the internal ID of each resource. The structure of the new provider's internal ID can be located in the [documentation](./docs/resources) file for each resource, specifically within the description of the `id` attribute. diff --git a/README.md b/README.md index ac8010963..535561cc1 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Check one of the examples in the [examples](examples/) folder. 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 +## 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. @@ -25,7 +25,10 @@ Additionally, for the Resource Manager service, **WARNING:** Acceptance tests will create real resources, which may incur in costs. -## Reporting issues +## Migration +For guidance on how to migrate to using this provider, please see our [Migration Guide](./MIGRATION.md). + +## Reporting Issues If you encounter any issues or have suggestions for improvements, please open an issue in the repository. ## Contribute