-
Notifications
You must be signed in to change notification settings - Fork 38
feat(kms): add keyring resource and datasource #1049
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,38 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_keyring Data Source - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Keyring datasource schema. Uses the default_region specified in the provider configuration as a fallback in case no region is defined on datasource level. | ||
| --- | ||
|
|
||
| # stackit_kms_keyring (Data Source) | ||
|
|
||
| KMS Keyring datasource schema. Uses the `default_region` specified in the provider configuration as a fallback in case no `region` is defined on datasource level. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "stackit_kms_keyring" "example" { | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| keyring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `keyring_id` (String) An auto generated unique id which identifies the keyring. | ||
| - `project_id` (String) STACKIT project ID to which the keyring is associated. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `region` (String) The resource region. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `description` (String) A user chosen description to distinguish multiple keyrings. | ||
| - `display_name` (String) The display name to distinguish multiple keyrings. | ||
| - `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`keyring_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,42 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_kms_keyring Resource - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| KMS Keyring resource schema. Uses the default_region specified in the provider configuration as a fallback in case no region is defined on resource level. | ||
| ~> Keyrings will not be destroyed by terraform during a terraform destroy. They will just be thrown out of the Terraform state and not deleted on API side. This way we can ensure no keyring setups are deleted by accident and it gives you the option to recover your keys within the grace period. | ||
| --- | ||
|
|
||
| # stackit_kms_keyring (Resource) | ||
|
|
||
| KMS Keyring resource schema. Uses the `default_region` specified in the provider configuration as a fallback in case no `region` is defined on resource level. | ||
|
|
||
| ~> Keyrings will **not** be destroyed by terraform during a `terraform destroy`. They will just be thrown out of the Terraform state and not deleted on API side. **This way we can ensure no keyring setups are deleted by accident and it gives you the option to recover your keys within the grace period.** | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "stackit_kms_keyring" "example" { | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| display_name = "example name" | ||
| description = "example description" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `display_name` (String) The display name to distinguish multiple keyrings. | ||
| - `project_id` (String) STACKIT project ID to which the keyring is associated. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `description` (String) A user chosen description to distinguish multiple keyrings. | ||
| - `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`,`region`,`keyring_id`". | ||
| - `keyring_id` (String) An auto generated unique id which identifies the keyring. |
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,4 @@ | ||
| data "stackit_kms_keyring" "example" { | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| keyring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| } |
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,5 @@ | ||
| resource "stackit_kms_keyring" "example" { | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| display_name = "example name" | ||
| description = "example description" | ||
| } |
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
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,139 @@ | ||
| package kms | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/datasource" | ||
| "github.com/hashicorp/terraform-plugin-framework/datasource/schema" | ||
| "github.com/hashicorp/terraform-plugin-framework/schema/validator" | ||
| "github.com/hashicorp/terraform-plugin-log/tflog" | ||
| "github.com/stackitcloud/stackit-sdk-go/services/kms" | ||
| "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/conversion" | ||
| "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/core" | ||
| kmsUtils "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/kms/utils" | ||
| "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/utils" | ||
| "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/validate" | ||
| ) | ||
|
|
||
| var ( | ||
| _ datasource.DataSource = &keyRingDataSource{} | ||
| ) | ||
|
|
||
| func NewKeyRingDataSource() datasource.DataSource { | ||
| return &keyRingDataSource{} | ||
| } | ||
|
|
||
| type keyRingDataSource struct { | ||
| client *kms.APIClient | ||
| providerData core.ProviderData | ||
| } | ||
|
|
||
| func (k *keyRingDataSource) Metadata(_ context.Context, request datasource.MetadataRequest, response *datasource.MetadataResponse) { | ||
| response.TypeName = request.ProviderTypeName + "_kms_keyring" | ||
| } | ||
|
|
||
| func (k *keyRingDataSource) Configure(ctx context.Context, request datasource.ConfigureRequest, response *datasource.ConfigureResponse) { | ||
| var ok bool | ||
| k.providerData, ok = conversion.ParseProviderData(ctx, request.ProviderData, &response.Diagnostics) | ||
| if !ok { | ||
| return | ||
| } | ||
|
|
||
| apiClient := kmsUtils.ConfigureClient(ctx, &k.providerData, &response.Diagnostics) | ||
| if response.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| k.client = apiClient | ||
| tflog.Info(ctx, "KMS client configured") | ||
| } | ||
|
|
||
| func (k *keyRingDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, response *datasource.SchemaResponse) { | ||
| response.Schema = schema.Schema{ | ||
| Description: fmt.Sprintf("KMS Keyring datasource schema. %s", core.DatasourceRegionFallbackDocstring), | ||
| Attributes: map[string]schema.Attribute{ | ||
| "description": schema.StringAttribute{ | ||
| Description: "A user chosen description to distinguish multiple keyrings.", | ||
| Computed: true, | ||
| }, | ||
| "display_name": schema.StringAttribute{ | ||
| Description: "The display name to distinguish multiple keyrings.", | ||
| Computed: true, | ||
| }, | ||
| "keyring_id": schema.StringAttribute{ | ||
| Description: "An auto generated unique id which identifies the keyring.", | ||
| Required: true, | ||
| Validators: []validator.String{ | ||
| validate.UUID(), | ||
| validate.NoSeparator(), | ||
| }, | ||
| }, | ||
| "id": schema.StringAttribute{ | ||
| Description: "Terraform's internal resource ID. It is structured as \"`project_id`,`region`,`keyring_id`\".", | ||
| Computed: true, | ||
| }, | ||
| "project_id": schema.StringAttribute{ | ||
| Description: "STACKIT project ID to which the keyring is associated.", | ||
| Required: true, | ||
| Validators: []validator.String{ | ||
| validate.UUID(), | ||
| validate.NoSeparator(), | ||
| }, | ||
| }, | ||
| "region": schema.StringAttribute{ | ||
| Optional: true, | ||
| // must be computed to allow for storing the override value from the provider | ||
| Computed: true, | ||
| Description: "The resource region. If not defined, the provider region is used.", | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (k *keyRingDataSource) Read(ctx context.Context, request datasource.ReadRequest, response *datasource.ReadResponse) { // nolint:gocritic // function signature required by Terraform | ||
| var model Model | ||
|
|
||
| diags := request.Config.Get(ctx, &model) | ||
| response.Diagnostics.Append(diags...) | ||
| if response.Diagnostics.HasError() { | ||
| return | ||
| } | ||
| projectId := model.ProjectId.ValueString() | ||
| keyRingId := model.KeyRingId.ValueString() | ||
| region := k.providerData.GetRegionWithOverride(model.Region) | ||
|
|
||
| ctx = tflog.SetField(ctx, "keyring_id", keyRingId) | ||
| ctx = tflog.SetField(ctx, "project_id", projectId) | ||
| ctx = tflog.SetField(ctx, "region", region) | ||
|
|
||
| keyRingResponse, err := k.client.GetKeyRing(ctx, projectId, region, keyRingId).Execute() | ||
| if err != nil { | ||
| utils.LogError( | ||
| ctx, | ||
| &response.Diagnostics, | ||
| err, | ||
| "Reading keyring", | ||
| fmt.Sprintf("Keyring with ID %q does not exist in project %q.", keyRingId, projectId), | ||
| map[int]string{ | ||
| http.StatusForbidden: fmt.Sprintf("Project with ID %q not found or forbidden access", projectId), | ||
| }, | ||
| ) | ||
| response.State.RemoveResource(ctx) | ||
| return | ||
| } | ||
|
|
||
| err = mapFields(keyRingResponse, &model, region) | ||
| if err != nil { | ||
| core.LogAndAddError(ctx, &response.Diagnostics, "Error reading keyring", fmt.Sprintf("Processing API payload: %v", err)) | ||
| return | ||
| } | ||
|
|
||
| diags = response.State.Set(ctx, &model) | ||
| response.Diagnostics.Append(diags...) | ||
| if response.Diagnostics.HasError() { | ||
| return | ||
| } | ||
| tflog.Info(ctx, "Key ring read") | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.