engine

Documentation

Overview

Package engine provides the pluggable IaC engine for Terragrunt.

Index

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

Constants

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

Functions

func ConvertMetaToProtobuf

func ConvertMetaToProtobuf(meta map[string]interface{}) (map[string]*anypb.Any, error)

ConvertMetaToProtobuf converts metadata map to protobuf map

func DownloadEngine

func DownloadEngine(ctx context.Context, 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,
	runOptions *ExecutionOptions,
) (*util.CmdOutput, error)

Run executes the given command with the experimental engine.

func Shutdown

func Shutdown(ctx context.Context, 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 {
	TerragruntOptions *options.TerragruntOptions
	CmdStdout         io.Writer
	CmdStderr         io.Writer
	WorkingDir        string
	SuppressStdout    bool
	AllocatePseudoTty bool
	Command           string
	Args              []string
}

type OutputLine

type OutputLine struct {
	Stdout string
	Stderr string
}

OutputLine represents the output from the engine