Document resource's internal ID structure and create foundation for migration guide (#12)

* Add internal ID structure to DSA instance descriptions

* Add internal ID structure to DSA credential descriptions

* Add internal ID structure to Argus descriptions

* Add internal ID structure to DNS descriptions

* Add internal ID structure to PostgresFlex descriptions

* Add internal ID structure to ResourceManager descriptions

* Add internal ID structure to SKE descriptions

* Generate updated docs

* Add first basis for migration guide

docs/data-sources/argus_instance.md

@@ -35,7 +35,7 @@ data "stackit_argus_instance" "example" {
 - `grafana_initial_admin_user` (String) Specifies an initial Grafana admin username.
 - `grafana_public_read_access` (Boolean) If true, anyone can access Grafana dashboards without logging in.
 - `grafana_url` (String) Specifies Grafana URL.
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `is_updatable` (Boolean) Specifies if the instance can be updated.
 - `jaeger_traces_url` (String)
 - `jaeger_ui_url` (String)

docs/data-sources/argus_scrapeconfig.md

@@ -32,7 +32,7 @@ data "stackit_argus_scrapeconfig" "example" {
 ### Read-Only
 
 - `basic_auth` (Attributes) A basic authentication block. (see [below for nested schema](#nestedatt--basic_auth))
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`name`".
 - `metrics_path` (String) Specifies the job scraping url path.
 - `saml2` (Attributes) A SAML2 configuration block (see [below for nested schema](#nestedatt--saml2))
 - `scheme` (String) Specifies the http scheme.

docs/data-sources/dns_record_set.md

@@ -34,7 +34,7 @@ data "stackit_dns_record_set" "example" {
 - `active` (Boolean) Specifies if the record set is active or not.
 - `comment` (String) Comment.
 - `error` (String) Error shows error in case create/update/delete failed.
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`record_set_id`".
 - `name` (String) Name of the record which should be a valid domain according to rfc1035 Section 2.3.4. E.g. `example.com`
 - `records` (List of String) Records.
 - `state` (String) Record set state.

docs/data-sources/dns_zone.md

@@ -36,7 +36,7 @@ data "stackit_dns_zone" "example" {
 - `description` (String) Description of the zone.
 - `dns_name` (String) The zone name. E.g. `example.com`
 - `expire_time` (Number) Expire time.
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`zone_id`".
 - `is_reverse_zone` (Boolean) Specifies, if the zone is a reverse zone or not.
 - `name` (String) The user given name of the zone.
 - `negative_cache` (Number) Negative caching.

docs/data-sources/logme_credentials.md

@@ -34,7 +34,7 @@ data "stackit_logme_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/data-sources/logme_instance.md

@@ -30,12 +30,12 @@ data "stackit_logme_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`zone_id`".
 - `image_url` (String)
 - `name` (String) Instance name.
-- `cf_organization_guid` (String)
 - `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
 - `plan_id` (String) The selected plan ID.
 - `plan_name` (String) The selected plan name.

docs/data-sources/mariadb_credentials.md

@@ -34,7 +34,7 @@ data "stackit_mariadb_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/data-sources/mariadb_instance.md

@@ -30,12 +30,12 @@ data "stackit_mariadb_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `name` (String) Instance name.
-- `cf_organization_guid` (String)
 - `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
 - `plan_id` (String) The selected plan ID.
 - `plan_name` (String) The selected plan name.

docs/data-sources/opensearch_credentials.md

@@ -34,7 +34,7 @@ data "stackit_opensearch_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/data-sources/opensearch_instance.md

@@ -30,12 +30,12 @@ data "stackit_opensearch_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `name` (String) Instance name.
-- `cf_organization_guid` (String)
 - `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
 - `plan_id` (String) The selected plan ID.
 - `plan_name` (String) The selected plan name.

docs/data-sources/postgresflex_instance.md

@@ -32,7 +32,7 @@ data "stackit_postgresflex_instance" "example" {
 - `acl` (List of String) The Access Control List (ACL) for the PostgresFlex instance.
 - `backup_schedule` (String)
 - `flavor` (Attributes) (see [below for nested schema](#nestedatt--flavor))
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `name` (String) Instance name.
 - `replicas` (Number)
 - `storage` (Attributes) (see [below for nested schema](#nestedatt--storage))

docs/data-sources/postgresflex_user.md

@@ -32,7 +32,7 @@ data "stackit_postgresflex_user" "example" {
 ### Read-Only
 
 - `host` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`user_id`".
 - `password` (String, Sensitive)
 - `port` (Number)
 - `roles` (Set of String)

docs/data-sources/postgresql_credentials.md

@@ -34,7 +34,7 @@ data "stackit_postgresql_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/data-sources/postgresql_instance.md

@@ -30,12 +30,12 @@ data "stackit_postgresql_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `name` (String) Instance name.
-- `cf_organization_guid` (String)
 - `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
 - `plan_id` (String) The selected plan ID.
 - `plan_name` (String) The selected plan name.

docs/data-sources/rabbitmq_credentials.md

@@ -34,7 +34,7 @@ data "stackit_rabbitmq_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/data-sources/rabbitmq_instance.md

@@ -30,12 +30,12 @@ data "stackit_rabbitmq_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `name` (String) Instance name.
-- `cf_organization_guid` (String)
 - `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
 - `plan_id` (String) The selected plan ID.
 - `plan_name` (String) The selected plan name.

docs/data-sources/redis_credentials.md

@@ -34,7 +34,7 @@ data "stackit_redis_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/data-sources/redis_instance.md

@@ -30,12 +30,12 @@ data "stackit_redis_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `name` (String) Instance name.
-- `cf_organization_guid` (String)
 - `parameters` (Attributes) (see [below for nested schema](#nestedatt--parameters))
 - `plan_id` (String) The selected plan ID.
 - `plan_name` (String) The selected plan name.

docs/data-sources/resourcemanager_project.md

@@ -28,7 +28,7 @@ data "stackit_resourcemanager_project" "example" {
 
 ### Read-Only
 
-- `id` (String) Terraform's internal unique identifier of the project, equivalent to the container ID
+- `id` (String) Terraform's internal resource ID. It is structured as "`container_id`".
 - `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container. A label key must match the regex [A-ZÄÜÖa-zäüöß0-9_-]{1,64}. A label value must match the regex ^$|[A-ZÄÜÖa-zäüöß0-9_-]{1,64}
 - `name` (String) Project name.
 - `parent_container_id` (String) Parent container ID

docs/data-sources/ske_cluster.md

@@ -34,7 +34,7 @@ data "stackit_ske_cluster" "example" {
 This should be used with care since it also disables a couple of other features like the use of some volume type (e.g. PVCs).
 - `extensions` (Attributes) A single extensions block as defined below (see [below for nested schema](#nestedatt--extensions))
 - `hibernations` (Attributes List) One or more hibernation block as defined below. (see [below for nested schema](#nestedatt--hibernations))
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`name`".
 - `kube_config` (String, Sensitive) Kube config file used for connecting to the cluster
 - `kubernetes_version` (String) Kubernetes version.
 - `kubernetes_version_used` (String) Full Kubernetes version used. For example, if `1.22` was selected, this value may result to `1.22.15`

docs/data-sources/ske_project.md

@@ -27,4 +27,4 @@ data "stackit_ske_project" "example" {
 
 ### Read-Only
 
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`".

docs/resources/argus_credential.md

@@ -22,6 +22,6 @@ description: |-
 
 ### Read-Only
 
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`username`".
 - `password` (String, Sensitive) Credential password
 - `username` (String) Credential username

docs/resources/argus_instance.md

@@ -41,7 +41,7 @@ resource "stackit_argus_instance" "example" {
 - `grafana_initial_admin_user` (String) Specifies an initial Grafana admin username.
 - `grafana_public_read_access` (Boolean) If true, anyone can access Grafana dashboards without logging in.
 - `grafana_url` (String) Specifies Grafana URL.
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `instance_id` (String) The Argus instance ID.
 - `is_updatable` (Boolean) Specifies if the instance can be updated.
 - `jaeger_traces_url` (String)

docs/resources/argus_scrapeconfig.md

@@ -53,7 +53,7 @@ resource "stackit_argus_scrapeconfig" "example" {
 
 ### Read-Only
 
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`name`".
 
 <a id="nestedatt--targets"></a>
 ### Nested Schema for `targets`

docs/resources/dns_record_set.md

@@ -43,6 +43,6 @@ resource "stackit_dns_record_set" "example" {
 ### Read-Only
 
 - `error` (String) Error shows error in case create/update/delete failed.
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`record_set_id`".
 - `record_set_id` (String) The rr set id.
 - `state` (String) Record set state.

docs/resources/dns_zone.md

@@ -51,7 +51,7 @@ resource "stackit_dns_zone" "example" {
 
 ### Read-Only
 
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`zone_id`".
 - `primary_name_server` (String) Primary name server. FQDN.
 - `record_count` (Number) Record count how many records are in the zone.
 - `serial_number` (Number) Serial number. E.g. `2022111400`.

docs/resources/logme_credentials.md

@@ -26,7 +26,7 @@ LogMe credentials resource schema.
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/resources/logme_instance.md

@@ -41,12 +41,12 @@ resource "stackit_logme_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `instance_id` (String) ID of the LogMe instance.
-- `cf_organization_guid` (String)
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>

docs/resources/mariadb_credentials.md

@@ -33,7 +33,7 @@ resource "stackit_mariadb_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/resources/mariadb_instance.md

@@ -41,12 +41,12 @@ resource "stackit_mariadb_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `instance_id` (String) ID of the MariaDB instance.
-- `cf_organization_guid` (String)
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>

docs/resources/opensearch_credentials.md

@@ -33,7 +33,7 @@ resource "stackit_opensearch_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/resources/opensearch_instance.md

@@ -41,12 +41,12 @@ resource "stackit_opensearch_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `instance_id` (String) ID of the OpenSearch instance.
-- `cf_organization_guid` (String)
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>

docs/resources/postgresflex_instance.md

@@ -47,7 +47,7 @@ resource "stackit_postgresflex_instance" "example" {
 
 ### Read-Only
 
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `instance_id` (String) ID of the PostgresFlex instance.
 
 <a id="nestedatt--flavor"></a>

docs/resources/postgresflex_user.md

@@ -17,7 +17,7 @@ resource "stackit_postgresflex_user" "example" {
   project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
   instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
   username    = "username"
-  roles = ["role"]
+  roles       = ["role"]
 }
 ```
 
@@ -34,7 +34,7 @@ resource "stackit_postgresflex_user" "example" {
 ### Read-Only
 
 - `host` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`,`user_id`".
 - `password` (String, Sensitive)
 - `port` (Number)
 - `user_id` (String) User ID.

docs/resources/postgresql_credentials.md

@@ -33,7 +33,7 @@ resource "stackit_postgresql_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/resources/postgresql_instance.md

@@ -41,12 +41,12 @@ resource "stackit_postgresql_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `instance_id` (String) ID of the PostgreSQL instance.
-- `cf_organization_guid` (String)
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>

docs/resources/rabbitmq_credentials.md

@@ -33,7 +33,7 @@ resource "stackit_rabbitmq_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/resources/rabbitmq_instance.md

@@ -41,12 +41,12 @@ resource "stackit_rabbitmq_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `instance_id` (String) ID of the RabbitMQ instance.
-- `cf_organization_guid` (String)
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>

docs/resources/redis_credentials.md

@@ -33,7 +33,7 @@ resource "stackit_redis_credentials" "example" {
 - `host` (String)
 - `hosts` (List of String)
 - `http_api_uri` (String)
-- `id` (String) Terraform's internal resource identifier.
+- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`instance_id`,`credentials_id`".
 - `name` (String)
 - `password` (String, Sensitive)
 - `port` (Number)

docs/resources/redis_instance.md

@@ -41,12 +41,12 @@ resource "stackit_redis_instance" "example" {
 ### Read-Only
 
 - `cf_guid` (String)
+- `cf_organization_guid` (String)
 - `cf_space_guid` (String)
 - `dashboard_url` (String)
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`".
 - `image_url` (String)
 - `instance_id` (String) ID of the Redis instance.
-- `cf_organization_guid` (String)
 - `plan_id` (String) The selected plan ID.
 
 <a id="nestedatt--parameters"></a>

docs/resources/resourcemanager_project.md

@@ -40,4 +40,4 @@ resource "stackit_resourcemanager_project" "example" {
 ### Read-Only
 
 - `container_id` (String) Project container ID. Globally unique, user-friendly identifier.
-- `id` (String) Terraform's internal unique identifier of the project, equivalent to the container ID
+- `id` (String) Terraform's internal resource ID. It is structured as "`container_id`".

docs/resources/ske_cluster.md

@@ -57,7 +57,7 @@ Deprecated as of Kubernetes 1.25 and later
 
 ### Read-Only
 
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`name`".
 - `kube_config` (String, Sensitive) Kube config file used for connecting to the cluster
 - `kubernetes_version_used` (String) Full Kubernetes version used. For example, if 1.22 was selected, this value may result to 1.22.15
 

docs/resources/ske_project.md

@@ -27,4 +27,4 @@ resource "stackit_ske_project" "example" {
 
 ### Read-Only
 
-- `id` (String) Terraform's internal resource ID.
+- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`".