Merge branch 'main' into feat/add-datasource-to-query-machine-types

Author: h3adex

CONTRIBUTION.md

@@ -121,7 +121,7 @@ To test your changes locally, you have to compile the provider (requires Go 1.24
 
 1. Go to the copied example and initialize Terraform by running `terraform init -reconfigure -upgrade`. This will throw an error ("Failed to query available provider packages") which can be ignored since we are using the local provider build.
    > Note: Terraform will store its resources' states locally. To allow multiple people to use the same resources, check [Setup for multi-person usage](#setup-centralized-terraform-state)
-1. Setup authentication by setting the env var `STACKIT_SERVICE_ACCOUNT_TOKEN` as a valid token (see [Authentication](#authentication) for more details on how to autenticate).
+1. Setup authentication (see [Authentication](#authentication) for more details on how to authenticate).
 1. Run `terraform plan` or `terraform apply` commands.
 1. To debug the terraform provider, execute the following steps:
 	* install the compiled terraform provider to binary path defined in the .terraformrc file

README.md

@@ -37,7 +37,7 @@ Check one of the examples in the [examples](examples/) folder.
 To authenticate, you will need a [service account](https://docs.stackit.cloud/stackit/en/service-accounts-134415819.html). Create it in the [STACKIT Portal](https://portal.stackit.cloud/) and assign the necessary permissions to it, e.g. `project.owner`. There are multiple ways to authenticate:
 
 - Key flow (recommended)
-- Token flow
+- 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:
 
@@ -112,6 +112,8 @@ To configure the key flow, follow this steps:
 
 ### 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:
 
 1. Setting the field `service_account_token` in the provider

docs/guides/import_resources.md

@@ -0,0 +1,27 @@
+---
+page_title: "How to import an existing resources"
+---
+# How to import an existing resources?
+
+## 1. **Create a terraform config file and add an import block for your resource**
+
+In order to import an existing resources in terraform you need to add an import block for the corresponding resource in a terraform config file.
+There is an example for every resource under the [examples](../../examples/) folder.
+
+E.g. the import statement for a `stackit_volume` looks like the following:
+
+```terraform
+import {
+  to = stackit_volume.import-example
+  id = "${var.project_id},${var.volume_id}"
+}
+```
+
+## 2. **Generate the destination resource automatically**
+
+Run `terraform plan -generate-config-out=generated.tf` to let terraform generate the configuration for you.
+In this step the `stackit_volume.import-example` resource is generated and filled with informations of your existing resource.
+
+## 3. **Finish the import**
+
+Run `terraform apply` to add your resource to the terraform state.

docs/index.md

@@ -11,7 +11,7 @@ provider "stackit" {
 
 # Authentication
 
-# Token flow
+# Token flow (scheduled for deprecation and will be removed on December 17, 2025)
 provider "stackit" {
   default_region        = "eu01"
   service_account_token = var.service_account_token
@@ -37,7 +37,7 @@ provider "stackit" {
 To authenticate, you will need a [service account](https://docs.stackit.cloud/stackit/en/service-accounts-134415819.html). Create it in the [STACKIT Portal](https://portal.stackit.cloud/) and assign it the necessary permissions, e.g. `project.owner`. There are multiple ways to authenticate:
 
 - Key flow (recommended)
-- Token flow
+- 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:
 
@@ -112,6 +112,8 @@ To configure the key flow, follow this steps:
 
 ### 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:
 
 1. Setting the field `service_account_token` in the provider
@@ -182,7 +184,7 @@ Note: AWS specific checks must be skipped as they do not work on STACKIT. For de
 - `service_account_email` (String, Deprecated) Service account email. It can also be set using the environment variable STACKIT_SERVICE_ACCOUNT_EMAIL. It is required if you want to use the resource manager project resource.
 - `service_account_key` (String) Service account key used for authentication. If set, the key flow will be used to authenticate all operations.
 - `service_account_key_path` (String) Path for the service account key used for authentication. If set, the key flow will be used to authenticate all operations.
-- `service_account_token` (String) Token used for authentication. If set, the token flow will be used to authenticate all operations.
+- `service_account_token` (String, Deprecated) Token used for authentication. If set, the token flow will be used to authenticate all operations.
 - `service_enablement_custom_endpoint` (String) Custom endpoint for the Service Enablement API
 - `ske_custom_endpoint` (String) Custom endpoint for the Kubernetes Engine (SKE) service
 - `sqlserverflex_custom_endpoint` (String) Custom endpoint for the SQL Server Flex service

docs/resources/affinity_group.md

@@ -87,6 +87,12 @@ resource "stackit_affinity_group" "example" {
   name       = "example-affinity-group-name"
   policy     = "hard-anti-affinity"
 }
+
+# Only use the import statement, if you want to import an existing affinity group
+import {
+  to = stackit_affinity_group.import-example
+  id = "${var.project_id},${var.affinity_group_id}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

docs/resources/authorization_organization_role_assignment.md

@@ -21,6 +21,12 @@ resource "stackit_authorization_organization_role_assignment" "example" {
   role        = "owner"
   subject     = "john.doe@stackit.cloud"
 }
+
+# Only use the import statement, if you want to import an existing organization role assignment
+import {
+  to = stackit_authorization_organization_role_assignment.import-example
+  id = "${var.organization_id},${var.org_role_assignment_role},${var.org_role_assignment_subject}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

docs/resources/authorization_project_role_assignment.md

@@ -21,6 +21,12 @@ resource "stackit_authorization_project_role_assignment" "example" {
   role        = "owner"
   subject     = "john.doe@stackit.cloud"
 }
+
+# Only use the import statement, if you want to import an existing project role assignment
+import {
+  to = stackit_authorization_project_role_assignment.import-example
+  id = "${var.project_id},${var.project_role_assignment_role},${var.project_role_assignment_subject}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

docs/resources/cdn_custom_domain.md

@@ -21,6 +21,12 @@ resource "stackit_cdn_custom_domain" "example" {
   distribution_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
   name            = "https://xxx.xxx"
 }
+
+# Only use the import statement, if you want to import an existing cdn custom domain
+import {
+  to = stackit_cdn_custom_domain.import-example
+  id = "${var.project_id},${var.distribution_id},${var.custom_domain_name}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

docs/resources/cdn_distribution.md

@@ -21,7 +21,7 @@ resource "stackit_cdn_distribution" "example_distribution" {
   config = {
     backend = {
       type       = "http"
-      origin_url = "mybackend.onstackit.cloud"
+      origin_url = "https://mybackend.onstackit.cloud"
     }
     regions           = ["EU", "US", "ASIA", "AF", "SA"]
     blocked_countries = ["DE", "AT", "CH"]
@@ -31,6 +31,12 @@ resource "stackit_cdn_distribution" "example_distribution" {
     }
   }
 }
+
+# Only use the import statement, if you want to import an existing cdn distribution
+import {
+  to = stackit_cdn_distribution.import-example
+  id = "${var.project_id},${var.distribution_id}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

docs/resources/dns_record_set.md

@@ -21,6 +21,12 @@ resource "stackit_dns_record_set" "example" {
   comment    = "Example comment"
   records    = ["1.2.3.4"]
 }
+
+# Only use the import statement, if you want to import an existing dns record set
+import {
+  to = stackit_dns_record_set.import-example
+  id = "${var.project_id},${var.zone_id},${var.record_set_id}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->