func New(namestring, servetfprotov5.ProviderServer, opts ...ServeOpt)tfplugin5.ProviderServer

func Serve(namestring, serverFactory func()tfprotov5.ProviderServer, opts ...ServeOpt)error

type GRPCProviderPlugin struct {GRPCProvider func()tfprotov5.ProviderServerOpts         []ServeOptNamestring}

func (*GRPCProviderPlugin)Client¶

func (p *GRPCProviderPlugin) Client(*plugin.MuxBroker, *rpc.Client) (interface{},error)

Client always returns an error; we're only implementing the GRPCPlugininterface, not the Plugin interface.

func (*GRPCProviderPlugin)GRPCClient¶

func (p *GRPCProviderPlugin) GRPCClient(context.Context, *plugin.GRPCBroker, *grpc.ClientConn) (interface{},error)

GRPCClient always returns an error; we're only implementing the server halfof the interface.

func (*GRPCProviderPlugin)GRPCServer¶

func (p *GRPCProviderPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server)error

GRPCServer registers the gRPC provider server with the gRPC server thatgo-plugin is standing up.

func (*GRPCProviderPlugin)Server¶

func (p *GRPCProviderPlugin) Server(*plugin.MuxBroker) (interface{},error)

Server always returns an error; we're only implementing the GRPCPlugininterface, not the Plugin interface.

type ServeConfig struct {// contains filtered or unexported fields}

type ServeOpt interface {ApplyServeOpt(*ServeConfig)error}

funcWithDebug¶

func WithDebug(ctxcontext.Context, config chan *plugin.ReattachConfig, closeCh chan struct{})ServeOpt

WithDebug returns a ServeOpt that will set the server into debug mode, usingthe passed options to populate the go-plugin ServeTestConfig.

This is an advanced ServeOpt that assumes the caller will fully manage thereattach configuration and server lifecycle. Refer to WithManagedDebug for aServeOpt that handles common use cases, such as implementing provider mainfunctions.

funcWithGoPluginLogger¶

func WithGoPluginLogger(loggerhclog.Logger)ServeOpt

WithGoPluginLogger returns a ServeOpt that will set the logger thatgo-plugin should use to log messages.

funcWithLogEnvVarName¶added inv0.5.0

func WithLogEnvVarName(namestring)ServeOpt

WithLogEnvVarName sets the name of the provider for the purposes of thelogging environment variable that controls the provider's log level. It isthe part following TF_LOG_PROVIDER_ and defaults to the name part of theprovider's registry address, or disabled if it can't parse the provider'sregistry address. Name must only contain letters, numbers, and hyphens.

funcWithLoggingSink¶added inv0.5.0

func WithLoggingSink(ttesting.T)ServeOpt

WithLoggingSink returns a ServeOpt that will enable the logging sink, whichis used in test frameworks to control where terraform-plugin-log output iswritten and at what levels, mimicking Terraform's logging sink behaviors.

funcWithManagedDebug¶added inv0.6.0

func WithManagedDebug()ServeOpt

WithManagedDebug returns a ServeOpt that will start the server in debugmode, managing the reattach configuration handling and server lifecycle.Reattach configuration is output to stdout with human friendly instructions.By default, the server can be stopped with os.Interrupt (SIGINT; ctrl-c).

Refer to the optional WithManagedDebugStopSignals andWithManagedDebugReattachConfigTimeout ServeOpt for additional configuration.

The reattach configuration output of this handling is not protected bycompatibility guarantees. Use the WithDebug ServeOpt for advanced use cases.

funcWithManagedDebugEnvFilePath¶added inv0.27.0

func WithManagedDebugEnvFilePath(pathstring)ServeOpt

WithManagedDebugEnvFilePath returns a ServeOpt that will set the output pathfor the managed debug process to write the reattach configuration into.

funcWithManagedDebugReattachConfigTimeout¶added inv0.6.0

func WithManagedDebugReattachConfigTimeout(timeouttime.Duration)ServeOpt

WithManagedDebugReattachConfigTimeout returns a ServeOpt that will set the timeoutfor a debug managed process to start and return its reattach configuration.When not configured, 2 seconds is the default.

funcWithManagedDebugStopSignals¶added inv0.6.0

func WithManagedDebugStopSignals(signals []os.Signal)ServeOpt

WithManagedDebugStopSignals returns a ServeOpt that will set the stop signals for adebug managed process (WithManagedDebug). When not configured, os.Interrupt(SIGINT; Ctrl-c) will stop the process.

funcWithoutLogLocation¶added inv0.5.0

func WithoutLogLocation()ServeOpt

WithoutLogLocation returns a ServeOpt that will exclude file names and linenumbers from log output for the terraform-plugin-log logs generated by theSDKs and provider.

funcWithoutLogStderrOverride¶added inv0.5.0

func WithoutLogStderrOverride()ServeOpt

WithoutLogStderrOverride returns a ServeOpt that will disable theterraform-plugin-log behavior of logging to the stderr that existed atstartup, not the stderr that exists when the logging statement is called.