chore(examples): Add import examples for all resources (#939)

* chore(examples): Add import examples for all resources

Signed-off-by: Alexander Dahmen <[email protected]>

* Add guide: How to import resources

Signed-off-by: Alexander Dahmen <[email protected]>

---------

Signed-off-by: Alexander Dahmen <[email protected]>

Author: Fyusel

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/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     = "[email protected]"
 }
+
+# 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     = "[email protected]"
 }
+
+# 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 -->

docs/resources/dns_zone.md

@@ -23,6 +23,12 @@ resource "stackit_dns_zone" "example" {
   description   = "Example description"
   default_ttl   = 1230
 }
+
+# Only use the import statement, if you want to import an existing dns zone
+import {
+  to = stackit_dns_zone.import-example
+  id = "${var.project_id},${var.zone_id}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

docs/resources/git.md

@@ -29,6 +29,12 @@ resource "stackit_git" "git" {
   ]
   flavor = "git-100"
 }
+
+# Only use the import statement, if you want to import an existing git resource
+import {
+  to = stackit_git.import-example
+  id = "${var.project_id},${var.git_instance_id}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

docs/resources/image.md

@@ -21,6 +21,18 @@ resource "stackit_image" "example_image" {
   min_disk_size   = 10
   min_ram         = 5
 }
+
+# Only use the import statement, if you want to import an existing image
+# Must set a configuration value for the local_file_path attribute as the provider has marked it as required.
+# Since this attribute is not fetched in general from the API call, after adding it this would replace your image resource after an terraform apply.
+# In order to prevent this you need to add:
+#lifecycle {
+#    ignore_changes = [ local_file_path ]
+#  }
+import {
+  to = stackit_image.import-example
+  id = "${var.project_id},${var.image_id}"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->