render

Documentation

Overview

Package render provides the command to render the final terragrunt config in various formats.

Package render provides the command to render the final terragrunt config in various formats.

Index

• Constants
• func NewCommand(opts *options.TerragruntOptions) *cli.Command
• func NewFlags(opts *Options, prefix flags.Prefix) cli.Flags
• func Run(ctx context.Context, opts *Options) error
• type Options
  • func NewOptions(opts *options.TerragruntOptions) *Options
  • func (o *Options) Clone() *Options
  • func (o *Options) Validate() error

Constants

const (
	CommandName = "render"

	FormatFlagName                  = "format"
	JSONFlagName                    = "json"
	WriteFlagName                   = "write"
	WriteAliasFlagName              = "w"
	OutFlagName                     = "out"
	WithMetadataFlagName            = "with-metadata"
	DisableDependentModulesFlagName = "disable-dependent-modules"
)

const (
	// FormatHCL outputs the config in HCL format.
	FormatHCL = "hcl"

	// FormatJSON outputs the config in JSON format.
	FormatJSON = "json"
)

Functions

func NewCommand

func NewCommand(opts *options.TerragruntOptions) *cli.Command

func NewFlags

func NewFlags(opts *Options, prefix flags.Prefix) cli.Flags

func Run

func Run(ctx context.Context, opts *Options) error

Types

type Options

type Options struct {
	*options.TerragruntOptions

	// Format determines the format of the output.
	Format string

	// OutputPath is the path to the file to write the rendered config to.
	// This configuration is relative to the Terragrunt config path.
	OutputPath string

	// Write the rendered config to a file.
	Write bool

	// RenderMetadata adds metadata to the rendered config.
	RenderMetadata bool

	// DisableDependentModules disables the identification of dependent modules when rendering config.
	DisableDependentModules bool
}

func NewOptions

func NewOptions(opts *options.TerragruntOptions) *Options

func (*Options) Clone

func (o *Options) Clone() *Options

func (*Options) Validate

func (o *Options) Validate() error