engine

Documentation

Index

• Constants
• func ContextWithEngine(ctx context.Context) context.Context
• func IsEngineEnabled() bool
• func Run(ctx context.Context, runOptions *ExecutionOptions) (*util.CmdOutput, error)
• func Shutdown(ctx context.Context) error
• type ExecutionOptions

Constants

const (
	EnableExperimentalEngineEnvName                  = "TG_EXPERIMENTAL_ENGINE"
	TerraformCommandContextKey      engineClientsKey = iota
)

Functions

func ContextWithEngine

func ContextWithEngine(ctx context.Context) context.Context

func IsEngineEnabled

func IsEngineEnabled() bool

IsEngineEnabled returns true if the experimental engine is enabled.

func Run

func Run(
	ctx context.Context,
	runOptions *ExecutionOptions,
) (*util.CmdOutput, error)

Run executes the given command with the experimental engine.

func Shutdown

func Shutdown(ctx context.Context) error

Shutdown shuts down the experimental engine.

Types

type ExecutionOptions

type ExecutionOptions struct {
	TerragruntOptions *options.TerragruntOptions
	CmdStdout         io.Writer
	CmdStderr         io.Writer
	WorkingDir        string
	SuppressStdout    bool
	AllocatePseudoTty bool
	Command           string
	Args              []string
}