Add kibana_saved_object resource #948
Open
Conversation
This file contains 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 was referenced Dec 12, 2024
tobio
reviewed
Dec 13, 2024
| }, | ||
| "object": schema.StringAttribute{ | ||
| Description: "Kibana object to import in JSON format", | ||
| Required: true, |
There was a problem hiding this comment.
Suggested change
| Required: true, | |
| Required: true, | |
| CustomType: jsontypes.NormalizedType{}, |
The index resource has an example of using this. It means simply restructuring the JSON won't be seen as a diff.
There was a problem hiding this comment.
Nice, thanks for pointing that out
| return | ||
| } | ||
|
|
||
| result, err := kibanaClient.KibanaSavedObject.Import([]byte(model.Imported.ValueString()), false, model.SpaceID.ValueString()) |
There was a problem hiding this comment.
Suggested change
| result, err := kibanaClient.KibanaSavedObject.Import([]byte(model.Imported.ValueString()), false, model.SpaceID.ValueString()) | |
| result, err := kibanaClient.KibanaSavedObject.Import([]byte(model.Imported.ValueString()), true, model.SpaceID.ValueString()) |
Given the use case here, I wonder if we should just always overwrite existing objects. It would simplify the workflow for bringing existing objects into TF, especially in a resource where a proper import handler is kind of tricky given the API constraints.
There was a problem hiding this comment.
I wondered about that and initially had overwrite set to true. I agree it would simplify importing resources into TF to have it set to true.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR implements proper support for managing a Kibana saved object.
Unlike existing resource
kibana_import_saved_objects, this new resource can only manage one single saved object but it keeps track of the changes, if the resource is changed in the Terraform code or in Kibana, the TF plan will show the difference. It also supports removing the saved object.Providing support for all CRUD operations is required to expose this resource in a Crossplane provider.
This PR has been tested both with Terraform and with a Crossplane provider that relies on this code.