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
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,34 @@ | ||
| package kms | ||
|
|
||
| import ( | ||
| "context" | ||
| "github.com/hashicorp/terraform-plugin-framework/datasource" | ||
| "github.com/stackitcloud/stackit-sdk-go/services/kms" | ||
| ) | ||
|
|
||
| var ( | ||
| _ datasource.DataSource = &keyRingDataSource{} | ||
| ) | ||
|
|
||
| func NewKeyRingDataSource() datasource.DataSource { | ||
| return &keyRingDataSource{} | ||
| } | ||
|
|
||
| type keyRingDataSource struct { | ||
| client *kms.APIClient | ||
| } | ||
|
|
||
| func (k keyRingDataSource) Metadata(ctx context.Context, request datasource.MetadataRequest, response *datasource.MetadataResponse) { | ||
| //TODO implement me | ||
| panic("implement me") | ||
| } | ||
|
|
||
| func (k keyRingDataSource) Schema(ctx context.Context, request datasource.SchemaRequest, response *datasource.SchemaResponse) { | ||
| //TODO implement me | ||
| panic("implement me") | ||
| } | ||
|
|
||
| func (k keyRingDataSource) Read(ctx context.Context, request datasource.ReadRequest, response *datasource.ReadResponse) { | ||
| //TODO implement me | ||
| panic("implement me") | ||
| } | ||
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,212 @@ | ||||||
| package kms | ||||||
|
|
||||||
| import ( | ||||||
| "context" | ||||||
| "fmt" | ||||||
| "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/resource" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/resource/schema" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/schema/validator" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/types" | ||||||
| "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" | ||||||
| ) | ||||||
|
|
||||||
| type Model struct { | ||||||
| Description types.String `tfsdk:"description"` | ||||||
| DisplayName types.String `tfsdk:"display_name"` | ||||||
| KeyRingId types.String `tfsdk:"key_ring_id"` | ||||||
| Id types.String `tfsdk:"id"` // needed by TF | ||||||
| ProjectId types.String `tfsdk:"project_id"` | ||||||
| RegionId types.String `tfsdk:"region_id"` | ||||||
|
||||||
| RegionId types.String `tfsdk:"region_id"` | |
| Region types.String `tfsdk:"region"` # small adjustment to stick with the naming conventions across the codebase |
According to https://docs.api.stackit.cloud/documentation/kms/version/v1beta , the KMS API already uses the new multi-region concept.
See e.g. the stackit_routing_table resource how to implement the multi-region concept. The resource has a region field which is marked as optional and will use the default_region configured in the provider as a fallback: https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/resources/routing_table
- You will need to store the provider configuration within your resource struct: and
- Field definition:
- Then use this helper func to read the region:
There was a problem hiding this comment.
Don't know if you are aware of this, please don't forget to implement the import.
You can ensure this by adding the code below:
// Ensure the implementation satisfies the expected interfaces.
var (
_ resource.Resource = &keyRingResource{}
_ resource.ResourceWithConfigure = &keyRingResource{}
_ resource.ResourceWithImportState = &keyRingResource{}
)See the git instance resource how to do it:
Consider doing the same for the datasource, see the git instance datasource for example:
Outdated
There was a problem hiding this comment.
Suggested change
| response.TypeName = request.ProviderTypeName + "kms_key_ring" | |
| response.TypeName = request.ProviderTypeName + "_kms_key_ring" |
Outdated
There was a problem hiding this comment.
Please consider implementing a unit test for this func.
Outdated
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,29 @@ | ||||||
| package utils | ||||||
|
|
||||||
| import ( | ||||||
| "context" | ||||||
| "fmt" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/diag" | ||||||
| "github.com/stackitcloud/stackit-sdk-go/core/config" | ||||||
| "github.com/stackitcloud/stackit-sdk-go/services/kms" | ||||||
| "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/core" | ||||||
| "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/utils" | ||||||
| ) | ||||||
|
|
||||||
| func ConfigureClient(ctx context.Context, providerData *core.ProviderData, diags *diag.Diagnostics) *kms.APIClient { | ||||||
| apiClientConfigOptions := []config.ConfigurationOption{ | ||||||
| config.WithCustomAuth(providerData.RoundTripper), | ||||||
| utils.UserAgentConfigOption(providerData.Version), | ||||||
| } | ||||||
| if providerData.KMSCustomEndpoint != "" { | ||||||
| apiClientConfigOptions = append(apiClientConfigOptions, config.WithEndpoint(providerData.KMSCustomEndpoint)) | ||||||
| } else { | ||||||
| apiClientConfigOptions = append(apiClientConfigOptions, config.WithRegion(providerData.GetRegion())) | ||||||
|
||||||
| apiClientConfigOptions = append(apiClientConfigOptions, config.WithRegion(providerData.GetRegion())) | |
| apiClientConfigOptions = append(apiClientConfigOptions)) |
Since the KMS API already implemented the new multi-region concept, you don't need to set the region here (or better: the SDK should throw an error if you do 😄 ).
Apart from that, consider adding a unit tests for this func, see e.g. https://github.com/stackitcloud/terraform-provider-stackit/blob/8e776757ea2280d1222afe50c3024945b4d99eed/stackit/internal/services/git/utils/util_test.go
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.
Only a nitpick and most of our datasources are also missing this. But this ensures that the Configure method is implemented correct