engine

package

v0.99.0 Latest Latest Go to latest Published: Jan 26, 2026 License: MIT Imports: 32 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gruntwork-io/terragrunt

Links

Documentation ¶

Overview ¶

Package engine provides the pluggable IaC engine for Terragrunt.

Index ¶

Constants
Variables
func ConvertMetaToProtobuf(meta map[string]any) (map[string]*anypb.Any, error)
func DownloadEngine(ctx context.Context, l log.Logger, opts *options.TerragruntOptions) error
func ReadEngineOutput(runOptions *ExecutionOptions, forceStdErr bool, output outputFn) error
func Run(ctx context.Context, l log.Logger, runOptions *ExecutionOptions) (*util.CmdOutput, error)
func Shutdown(ctx context.Context, l log.Logger, opts *options.TerragruntOptions) error
func WithEngineValues(ctx context.Context) context.Context
type ExecutionOptions
type OutputLine

Constants ¶

View Source

const PublicKey = `` /* 2431-byte string literal not displayed */

Variables ¶

View Source

var ErrEngineInitFailed = errors.New("engine init failed")

View Source

var ErrEngineShutdownFailed = errors.New("engine shutdown failed")

Functions ¶

func ConvertMetaToProtobuf ¶

func ConvertMetaToProtobuf(meta map[string]any) (map[string]*anypb.Any, error)

ConvertMetaToProtobuf converts metadata map to protobuf map

func DownloadEngine ¶

func DownloadEngine(ctx context.Context, l log.Logger, opts *options.TerragruntOptions) error

DownloadEngine downloads the engine for the given options.

func ReadEngineOutput ¶

func ReadEngineOutput(runOptions *ExecutionOptions, forceStdErr bool, output outputFn) error

ReadEngineOutput reads the output from the engine, since grpc plugins don't have common type, use lambda function to read bytes from the stream

func Run ¶

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

Run executes the given command with the experimental engine.

func Shutdown ¶

func Shutdown(ctx context.Context, l log.Logger, opts *options.TerragruntOptions) error

Shutdown shuts down the experimental engine.

func WithEngineValues ¶

func WithEngineValues(ctx context.Context) context.Context

WithEngineValues add to context default values for engine.

Types ¶

type ExecutionOptions ¶

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

type OutputLine ¶

type OutputLine struct {
	Stdout string
	Stderr string
}

OutputLine represents the output from the engine

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL