cli

Documentation

Index

• Constants
• Variables
• func DeprecatedCommands(opts *options.TerragruntOptions) cli.Commands
• func NewDeprecatedFlags(opts *options.TerragruntOptions) cli.Flags
• func OSExiter(exitCode int)
• func TerragruntCommands(opts *options.TerragruntOptions) cli.Commands
• func WrapWithTelemetry(opts *options.TerragruntOptions) func(ctx *cli.Context, action cli.ActionFunc) error
• type App
  • func NewApp(writer io.Writer, errWriter io.Writer) *App
  • func (app *App) Run(args []string) error
  • func (app *App) RunContext(ctx context.Context, args []string) error
• type NotFoundWellKnownURL
  • func (err NotFoundWellKnownURL) Error() string
• type ProviderCache
  • func InitProviderCacheServer(opts *options.TerragruntOptions) (*ProviderCache, error)
  • func (cache *ProviderCache) TerraformCommandHook(ctx context.Context, opts *options.TerragruntOptions, args []string) (*util.CmdOutput, error)
• type RegistryURLs
  • func DiscoveryURL(ctx context.Context, registryName string) (*RegistryURLs, error)
  • func (urls *RegistryURLs) String() string

Constants

const (
	CommandNameSpinUp      = "spin-up"
	CommandNameTearDown    = "tear-down"
	CommandNamePlanAll     = "plan-all"
	CommandNameApplyAll    = "apply-all"
	CommandNameDestroyAll  = "destroy-all"
	CommandNameOutputAll   = "output-all"
	CommandNameValidateAll = "validate-all"
)

The following commands are DEPRECATED

const (
	TerragruntIncludeModulePrefixFlagName = "terragrunt-include-module-prefix"
	TerragruntIncludeModulePrefixEnvName  = "TERRAGRUNT_INCLUDE_MODULE_PREFIX"
)

The following flags are DEPRECATED

const (

	// The status returned when making a request to the caching provider.
	// It is needed to prevent further loading of providers by terraform, and at the same time make sure that the request was processed successfully.
	CACHE_PROVIDER_HTTP_STATUS_CODE = http.StatusLocked

	// Authentication type on the Terragrunt Provider Cache server.
	API_KEY_AUTH = "x-api-key"
)

const AppHelpTemplate = `` /* 832-byte string literal not displayed */

const AppVersionTemplate = `terragrunt version {{.App.Version}}
`

const CommandHelpTemplate = `` /* 975-byte string literal not displayed */

Variables

var (
	DefaultRegistryURLs = &RegistryURLs{
		ModulesV1:   "/v1/modules",
		ProvidersV1: "/v1/providers",
	}
)

Functions

func DeprecatedCommands

func DeprecatedCommands(opts *options.TerragruntOptions) cli.Commands

func NewDeprecatedFlags

func NewDeprecatedFlags(opts *options.TerragruntOptions) cli.Flags

NewDeprecatedFlags creates and returns deprecated flags.

func OSExiter

func OSExiter(exitCode int)

func TerragruntCommands

func TerragruntCommands(opts *options.TerragruntOptions) cli.Commands

This set of commands is also used in unit tests

func WrapWithTelemetry

func WrapWithTelemetry(opts *options.TerragruntOptions) func(ctx *cli.Context, action cli.ActionFunc) error

Wrap CLI command execution with setting of telemetry context and labels, if telemetry is disabled, just runAction the command.

Types

type App

type App struct {
	*cli.App
}

func NewApp

func NewApp(writer io.Writer, errWriter io.Writer) *App

NewApp creates the Terragrunt CLI App.

func (*App) Run

func (app *App) Run(args []string) error

func (*App) RunContext

func (app *App) RunContext(ctx context.Context, args []string) error

type NotFoundWellKnownURL

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

func (NotFoundWellKnownURL) Error

func (err NotFoundWellKnownURL) Error() string

type ProviderCache

type ProviderCache struct {
	*cache.Server
	// contains filtered or unexported fields
}

func InitProviderCacheServer

func InitProviderCacheServer(opts *options.TerragruntOptions) (*ProviderCache, error)

func (*ProviderCache) TerraformCommandHook

func (cache *ProviderCache) TerraformCommandHook(ctx context.Context, opts *options.TerragruntOptions, args []string) (*util.CmdOutput, error)

type RegistryURLs

type RegistryURLs struct {
	ModulesV1   string `json:"modules.v1"`
	ProvidersV1 string `json:"providers.v1"`
}

func DiscoveryURL

func DiscoveryURL(ctx context.Context, registryName string) (*RegistryURLs, error)

func (*RegistryURLs) String

func (urls *RegistryURLs) String() string