mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-26 00:41:27 -06:00
e81162c4e1
This is part of a general effort to move all of Terraform's non-library package surface under internal in order to reinforce that these are for internal use within Terraform only. If you were previously importing packages under this prefix into an external codebase, you could pin to an earlier release tag as an interim solution until you've make a plan to achieve the same functionality some other way.
83 lines
2.7 KiB
Go
83 lines
2.7 KiB
Go
package provisioners
|
|
|
|
import (
|
|
"github.com/hashicorp/terraform/configs/configschema"
|
|
"github.com/hashicorp/terraform/internal/tfdiags"
|
|
"github.com/zclconf/go-cty/cty"
|
|
)
|
|
|
|
// Interface is the set of methods required for a resource provisioner plugin.
|
|
type Interface interface {
|
|
// GetSchema returns the schema for the provisioner configuration.
|
|
GetSchema() GetSchemaResponse
|
|
|
|
// ValidateProvisionerConfig allows the provisioner to validate the
|
|
// configuration values.
|
|
ValidateProvisionerConfig(ValidateProvisionerConfigRequest) ValidateProvisionerConfigResponse
|
|
|
|
// ProvisionResource runs the provisioner with provided configuration.
|
|
// ProvisionResource blocks until the execution is complete.
|
|
// If the returned diagnostics contain any errors, the resource will be
|
|
// left in a tainted state.
|
|
ProvisionResource(ProvisionResourceRequest) ProvisionResourceResponse
|
|
|
|
// Stop is called to interrupt the provisioner.
|
|
//
|
|
// Stop should not block waiting for in-flight actions to complete. It
|
|
// should take any action it wants and return immediately acknowledging it
|
|
// has received the stop request. Terraform will not make any further API
|
|
// calls to the provisioner after Stop is called.
|
|
//
|
|
// The error returned, if non-nil, is assumed to mean that signaling the
|
|
// stop somehow failed and that the user should expect potentially waiting
|
|
// a longer period of time.
|
|
Stop() error
|
|
|
|
// Close shuts down the plugin process if applicable.
|
|
Close() error
|
|
}
|
|
|
|
type GetSchemaResponse struct {
|
|
// Provisioner contains the schema for this provisioner.
|
|
Provisioner *configschema.Block
|
|
|
|
// Diagnostics contains any warnings or errors from the method call.
|
|
Diagnostics tfdiags.Diagnostics
|
|
}
|
|
|
|
// UIOutput provides the Output method for resource provisioner
|
|
// plugins to write any output to the UI.
|
|
//
|
|
// Provisioners may call the Output method multiple times while Apply is in
|
|
// progress. It is invalid to call Output after Apply returns.
|
|
type UIOutput interface {
|
|
Output(string)
|
|
}
|
|
|
|
type ValidateProvisionerConfigRequest struct {
|
|
// Config is the complete configuration to be used for the provisioner.
|
|
Config cty.Value
|
|
}
|
|
|
|
type ValidateProvisionerConfigResponse struct {
|
|
// Diagnostics contains any warnings or errors from the method call.
|
|
Diagnostics tfdiags.Diagnostics
|
|
}
|
|
|
|
type ProvisionResourceRequest struct {
|
|
// Config is the complete provisioner configuration.
|
|
Config cty.Value
|
|
|
|
// Connection contains any information required to access the resource
|
|
// instance.
|
|
Connection cty.Value
|
|
|
|
// UIOutput is used to return output during the Apply operation.
|
|
UIOutput UIOutput
|
|
}
|
|
|
|
type ProvisionResourceResponse struct {
|
|
// Diagnostics contains any warnings or errors from the method call.
|
|
Diagnostics tfdiags.Diagnostics
|
|
}
|