first steps for kms key-ring resource and datasource #897
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_key Data Source - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Key resource schema. Must have a region specified in the provider configuration. | ||
| --- | ||
|
|
||
| # stackit_kms_key (Data Source) | ||
|
|
||
| KMS Key resource schema. Must have a `region` specified in the provider configuration. | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `algorithm` (String) The encryption algorithm that the key will use to encrypt data | ||
| - `backend` (String) The backend that is used for KMS. Right now, only software is accepted. | ||
| - `display_name` (String) The display name to distinguish multiple keys | ||
| - `import_only` (Boolean) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". | ||
| - `key_id` (String) | ||
| - `key_ring_id` (String) The ID of the associated key ring | ||
| - `project_id` (String) STACKIT project ID to which the key ring is associated. | ||
| - `purpose` (String) The purpose for which the key will be used | ||
|
|
||
| ### Optional | ||
|
|
||
| - `description` (String) A user chosen description to distinguish multiple keys | ||
| - `region` (String) The resource region. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_key_ring Data Source - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Key Ring resource schema. | ||
| --- | ||
|
|
||
| # stackit_kms_key_ring (Data Source) | ||
|
|
||
| KMS Key Ring resource schema. | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `key_ring_id` (String) An auto generated unique id which identifies the key ring. | ||
| - `project_id` (String) STACKIT project ID to which the key ring is associated. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `description` (String) A user chosen description to distinguish multiple key rings. | ||
| - `display_name` (String) A user chosen description to distinguish multiple key rings. | ||
| - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". | ||
| - `region` (String) The resource region. If not defined, the provider region is used. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_wrapping_key Data Source - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Key resource schema. Must have a region specified in the provider configuration. | ||
| --- | ||
|
|
||
| # stackit_kms_wrapping_key (Data Source) | ||
|
|
||
| KMS Key resource schema. Must have a `region` specified in the provider configuration. | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `algorithm` (String) The encryption algorithm that the key will use to encrypt data | ||
| - `backend` (String) The backend that is used for KMS. Right now, only software is accepted. | ||
| - `display_name` (String) The display name to distinguish multiple keys | ||
| - `key_ring_id` (String) The ID of the associated key ring | ||
| - `project_id` (String) STACKIT project ID to which the key ring is associated. | ||
| - `purpose` (String) The purpose for which the key will be used | ||
| - `wrapping_key_id` (String) | ||
|
|
||
| ### Optional | ||
|
|
||
| - `description` (String) A user chosen description to distinguish multiple keys | ||
| - `region` (String) The resource region. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_key Resource - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Key resource schema. Must have a region specified in the provider configuration. | ||
| --- | ||
|
|
||
| # stackit_kms_key (Resource) | ||
|
|
||
| KMS Key resource schema. Must have a `region` specified in the provider configuration. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "stackit_kms_key" "name" { | ||
| algorithm = "example algorithm" | ||
| backend = "software" | ||
| description = "new descr" | ||
| display_name = "example name" | ||
| import_only = false | ||
| key_ring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| purpose = "example purpose" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `algorithm` (String) The encryption algorithm that the key will use to encrypt data | ||
| - `backend` (String) The backend that is used for KMS. Right now, only software is accepted. | ||
|
There was a problem hiding this comment. I think with the migration from v1beta -> v1, this was renamed to |
||
| - `display_name` (String) The display name to distinguish multiple keys | ||
| - `import_only` (Boolean) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". | ||
|
There was a problem hiding this comment. Description of |
||
| - `key_ring_id` (String) The ID of the associated key ring | ||
| - `project_id` (String) STACKIT project ID to which the key ring is associated. | ||
| - `purpose` (String) The purpose for which the key will be used | ||
|
|
||
| ### Optional | ||
|
|
||
|
There was a problem hiding this comment. Regarding the api spec |
||
| - `description` (String) A user chosen description to distinguish multiple keys | ||
| - `region` (String) The resource region. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". | ||
| - `key_id` (String) The ID of the key | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_key_ring Resource - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Key Ring resource schema. Must have a region specified in the provider configuration. | ||
| --- | ||
|
|
||
| # stackit_kms_key_ring (Resource) | ||
|
|
||
| KMS Key Ring resource schema. Must have a `region` specified in the provider configuration. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "stackit_kms_key_ring" "example" { | ||
| description = "example description" | ||
| display_name = "example name" | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| region_id = "eu01" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `display_name` (String) A user chosen description to distinguish multiple key rings. | ||
| - `project_id` (String) STACKIT project ID to which the key ring is associated. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `description` (String) A user chosen description to distinguish multiple key rings. | ||
| - `region` (String) The resource region. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". | ||
| - `key_ring_id` (String) An auto generated unique id which identifies the key ring. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_wrapping_key Resource - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Key resource schema. Must have a region specified in the provider configuration. | ||
| --- | ||
|
|
||
| # stackit_kms_wrapping_key (Resource) | ||
|
|
||
| KMS Key resource schema. Must have a `region` specified in the provider configuration. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "stackit_kms_wrapping_key" "name" { | ||
| algorithm = "example algorithm" | ||
| backend = "software" | ||
| description = "new descr" | ||
| display_name = "example name" | ||
| key_ring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| purpose = "example purpose" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `algorithm` (String) The encryption algorithm that the key will use to encrypt data | ||
| - `backend` (String) The backend that is used for KMS. Right now, only software is accepted. | ||
|
There was a problem hiding this comment. here also renamed to |
||
| - `display_name` (String) The display name to distinguish multiple keys | ||
| - `key_ring_id` (String) The ID of the associated key ring | ||
| - `project_id` (String) STACKIT project ID to which the key ring is associated. | ||
| - `purpose` (String) The purpose for which the key will be used | ||
|
|
||
| ### Optional | ||
|
|
||
|
|
||
| - `description` (String) A user chosen description to distinguish multiple keys | ||
| - `region` (String) The resource region. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`instance_id`". | ||
| - `wrapping_key_id` (String) The ID of the wrapping key | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,10 @@ | ||||||||||||||||||||||||||||||||
| resource "stackit_kms_key" "name" { | ||||||||||||||||||||||||||||||||
| algorithm = "example algorithm" | ||||||||||||||||||||||||||||||||
| backend = "software" | ||||||||||||||||||||||||||||||||
| description = "new descr" | ||||||||||||||||||||||||||||||||
| display_name = "example name" | ||||||||||||||||||||||||||||||||
| import_only = false | ||||||||||||||||||||||||||||||||
| key_ring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||||||||||||||||||||||||||||||||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||||||||||||||||||||||||||||||||
| purpose = "example purpose" | ||||||||||||||||||||||||||||||||
|
Comment on lines
+2
to
+9
There was a problem hiding this comment. We usually have the
Suggested change
If you want you can also add an additional example, where the |
||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Add an example how the resource can be imported, like we have it here terraform-provider-stackit/docs/resources/ske_cluster.md Lines 41 to 45 in 813b8c0 |
||||||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,6 @@ | ||||||||||||||||||||
| resource "stackit_kms_key_ring" "example" { | ||||||||||||||||||||
| description = "example description" | ||||||||||||||||||||
| display_name = "example name" | ||||||||||||||||||||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||||||||||||||||||||
| region_id = "eu01" | ||||||||||||||||||||
| } | ||||||||||||||||||||
|
Comment on lines
+2
to
+6
There was a problem hiding this comment. Change also the order here, so that project_id is first and remove region_id. Also add an import example
Suggested change
|
||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,9 @@ | ||||||||||||||||||||||||||||||
| resource "stackit_kms_wrapping_key" "name" { | ||||||||||||||||||||||||||||||
| algorithm = "example algorithm" | ||||||||||||||||||||||||||||||
| backend = "software" | ||||||||||||||||||||||||||||||
| description = "new descr" | ||||||||||||||||||||||||||||||
| display_name = "example name" | ||||||||||||||||||||||||||||||
| key_ring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||||||||||||||||||||||||||||||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||||||||||||||||||||||||||||||
| purpose = "example purpose" | ||||||||||||||||||||||||||||||
|
Comment on lines
+2
to
+8
There was a problem hiding this comment. Change the order, so that project_id and key_ring_id are first. And add an import example
Suggested change
|
||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In all three data sources the examples are missing. Please add them in examples/data-sources/<data-source-name>/data-source.tf like you did it for the resources