WIP: Add framework provider #234
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,9 +3,128 @@ package schema | |||||
| import ( | ||||||
| "fmt" | ||||||
|
|
||||||
| "github.com/hashicorp/terraform-plugin-framework-validators/listvalidator" | ||||||
| "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/path" | ||||||
| fwschema "github.com/hashicorp/terraform-plugin-framework/provider/schema" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/schema/validator" | ||||||
| "github.com/hashicorp/terraform-plugin-framework/types" | ||||||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||||||
| ) | ||||||
|
|
||||||
| func GetEsFWConnectionBlock(keyName string, isProviderConfiguration bool) fwschema.Block { | ||||||
| usernamePath := makePathRef(keyName, "username") | ||||||
| passwordPath := makePathRef(keyName, "password") | ||||||
| caFilePath := makePathRef(keyName, "ca_file") | ||||||
| caDataPath := makePathRef(keyName, "ca_data") | ||||||
| certFilePath := makePathRef(keyName, "cert_file") | ||||||
| certDataPath := makePathRef(keyName, "cert_data") | ||||||
| keyFilePath := makePathRef(keyName, "key_file") | ||||||
| keyDataPath := makePathRef(keyName, "key_data") | ||||||
|
|
||||||
| usernameValidators := []validator.String{stringvalidator.AlsoRequires(path.MatchRoot(passwordPath))} | ||||||
| passwordValidators := []validator.String{stringvalidator.AlsoRequires(path.MatchRoot(usernamePath))} | ||||||
|
|
||||||
| if isProviderConfiguration { | ||||||
| // RequireWith validation isn't compatible when used in conjunction with DefaultFunc | ||||||
| usernameValidators = nil | ||||||
| passwordValidators = nil | ||||||
| } | ||||||
|
|
||||||
| return fwschema.ListNestedBlock{ | ||||||
| MarkdownDescription: fmt.Sprintf("Elasticsearch connection configuration block. %s", getDeprecationMessage(isProviderConfiguration)), | ||||||
| DeprecationMessage: getDeprecationMessage(isProviderConfiguration), | ||||||
| NestedObject: fwschema.NestedBlockObject{ | ||||||
| Attributes: map[string]fwschema.Attribute{ | ||||||
| "username": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "Username to use for API authentication to Elasticsearch.", | ||||||
| Optional: true, | ||||||
| Validators: usernameValidators, | ||||||
| }, | ||||||
| "password": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "Password to use for API authentication to Elasticsearch.", | ||||||
| Optional: true, | ||||||
| Sensitive: true, | ||||||
| Validators: passwordValidators, | ||||||
| }, | ||||||
| "api_key": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "API Key to use for authentication to Elasticsearch", | ||||||
| Optional: true, | ||||||
| Sensitive: true, | ||||||
| Validators: []validator.String{ | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(usernamePath)), | ||||||
|
Member
There was a problem hiding this comment. Can we instead use a relative path matcher in the new schema?
Suggested change
|
||||||
| stringvalidator.ConflictsWith(path.MatchRoot(passwordPath)), | ||||||
| }, | ||||||
| }, | ||||||
| "endpoints": fwschema.ListAttribute{ | ||||||
| MarkdownDescription: "A comma-separated list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.", | ||||||
| Optional: true, | ||||||
| Sensitive: true, | ||||||
| ElementType: types.StringType, | ||||||
| }, | ||||||
| "insecure": fwschema.BoolAttribute{ | ||||||
| MarkdownDescription: "Disable TLS certificate validation", | ||||||
| Optional: true, | ||||||
| }, | ||||||
| "ca_file": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "Path to a custom Certificate Authority certificate", | ||||||
| Optional: true, | ||||||
| Validators: []validator.String{ | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(caDataPath)), | ||||||
| }, | ||||||
| }, | ||||||
| "ca_data": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "PEM-encoded custom Certificate Authority certificate", | ||||||
| Optional: true, | ||||||
| Validators: []validator.String{ | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(caFilePath)), | ||||||
| }, | ||||||
| }, | ||||||
| "cert_file": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "Path to a file containing the PEM encoded certificate for client auth", | ||||||
| Optional: true, | ||||||
| Validators: []validator.String{ | ||||||
| stringvalidator.AlsoRequires(path.MatchRoot(keyFilePath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(certDataPath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(keyDataPath)), | ||||||
| }, | ||||||
| }, | ||||||
| "key_file": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "Path to a file containing the PEM encoded private key for client auth", | ||||||
| Optional: true, | ||||||
| Validators: []validator.String{ | ||||||
| stringvalidator.AlsoRequires(path.MatchRoot(certFilePath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(certDataPath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(keyDataPath)), | ||||||
| }, | ||||||
| }, | ||||||
| "cert_data": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "PEM encoded certificate for client auth", | ||||||
| Optional: true, | ||||||
| Validators: []validator.String{ | ||||||
| stringvalidator.AlsoRequires(path.MatchRoot(keyDataPath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(certFilePath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(keyFilePath)), | ||||||
| }, | ||||||
| }, | ||||||
| "key_data": fwschema.StringAttribute{ | ||||||
| MarkdownDescription: "PEM encoded private key for client auth", | ||||||
| Optional: true, | ||||||
| Sensitive: true, | ||||||
| Validators: []validator.String{ | ||||||
| stringvalidator.AlsoRequires(path.MatchRoot(certDataPath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(certFilePath)), | ||||||
| stringvalidator.ConflictsWith(path.MatchRoot(keyFilePath)), | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| Validators: []validator.List{ | ||||||
| listvalidator.SizeAtMost(1), | ||||||
| }, | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| func GetEsConnectionSchema(keyName string, isProviderConfiguration bool) *schema.Schema { | ||||||
| usernamePath := makePathRef(keyName, "username") | ||||||
| passwordPath := makePathRef(keyName, "password") | ||||||
|
|
@@ -20,20 +139,18 @@ func GetEsConnectionSchema(keyName string, isProviderConfiguration bool) *schema | |||||
| passwordRequiredWithValidation := []string{usernamePath} | ||||||
|
|
||||||
| withEnvDefault := func(key string, dv interface{}) schema.SchemaDefaultFunc { return nil } | ||||||
|
|
||||||
| if isProviderConfiguration { | ||||||
| withEnvDefault = func(key string, dv interface{}) schema.SchemaDefaultFunc { return schema.EnvDefaultFunc(key, dv) } | ||||||
|
|
||||||
| // RequireWith validation isn't compatible when used in conjunction with DefaultFunc | ||||||
| usernameRequiredWithValidation = nil | ||||||
| passwordRequiredWithValidation = nil | ||||||
| } | ||||||
|
|
||||||
| return &schema.Schema{ | ||||||
| Description: fmt.Sprintf("Elasticsearch connection configuration block. %s", getDeprecationMessage(isProviderConfiguration)), | ||||||
| Deprecated: getDeprecationMessage(isProviderConfiguration), | ||||||
| Type: schema.TypeList, | ||||||
| MaxItems: 1, | ||||||
| Optional: true, | ||||||
|
|
@@ -168,3 +285,10 @@ func GetKibanaConnectionSchema() *schema.Schema { | |||||
| func makePathRef(keyName string, keyValue string) string { | ||||||
| return fmt.Sprintf("%s.0.%s", keyName, keyValue) | ||||||
| } | ||||||
|
|
||||||
| func getDeprecationMessage(isProviderConfiguration bool) string { | ||||||
| if isProviderConfiguration { | ||||||
| return "" | ||||||
| } | ||||||
| return "This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead." | ||||||
| } | ||||||
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 |
|---|---|---|
|
|
@@ -2,6 +2,9 @@ package provider | |
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/providerserver" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-go/tfprotov5" | ||
| "github.com/hashicorp/terraform-plugin-mux/tf5muxserver" | ||
|
|
@@ -10,14 +13,16 @@ import ( | |
| // ProtoV5ProviderServerFactory returns a muxed terraform-plugin-go protocol v5 provider factory function. | ||
| func ProtoV5ProviderServerFactory(ctx context.Context, version string) (func() tfprotov5.ProviderServer, error) { | ||
| sdkv2Provider := New(version) | ||
| fwProvider := providerserver.NewProtocol5(NewFrameworkProvider(version)) | ||
|
|
||
| servers := []func() tfprotov5.ProviderServer{ | ||
| fwProvider, | ||
| sdkv2Provider.GRPCProvider, | ||
| } | ||
|
|
||
| muxServer, err := tf5muxserver.NewMuxServer(ctx, servers...) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("initialize mux server: %w", err) | ||
| } | ||
|
|
||
| return muxServer.ProviderServer, nil | ||
|
|
||
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.
IMO it would be cleaner to have all functions which build a new client parse the relevant config into this struct and then call a single function which builds an
elasticsearch.Config{}instance from this struct.It would mean consolidating all the CA, TLS and debugging code. Given the different diagnostic types we'd have to return a plain error but I think that's ok.
WDYT?