Documentation
¶
Overview ¶
Package shared provides flags that are shared by multiple commands.
This package is underutilized right now, as some more serious refactoring is needed to make sure all shared flags use this package instead of reusing flags from other commands.
Index ¶
- Constants
- func NewAuthProviderCmdFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
- func NewBackendFlags(opts *options.TerragruntOptions, prefix flags.Prefix) cli.Flags
- func NewConfigFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
- func NewDownloadDirFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
- func NewFeatureFlags(opts *options.TerragruntOptions, prefix flags.Prefix) cli.Flags
- func NewFilterFlags(l log.Logger, opts *options.TerragruntOptions) cli.Flags
- func NewIAMAssumeRoleFlags(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) cli.Flags
- func NewInputsDebugFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
- func NewParallelismFlag(opts *options.TerragruntOptions) *flags.Flag
- func NewQueueFlags(opts *options.TerragruntOptions, prefix flags.Prefix) cli.Flags
- func NewScaffoldingFlags(opts *options.TerragruntOptions, prefix flags.Prefix) cli.Flags
- func NewTFPathFlag(opts *options.TerragruntOptions) *flags.Flag
Constants ¶
const ( // General related flags. TFPathFlagName = "tf-path" // Queue related flags. QueueIgnoreErrorsFlagName = "queue-ignore-errors" QueueIgnoreDAGOrderFlagName = "queue-ignore-dag-order" QueueExcludeExternalFlagName = "queue-exclude-external" QueueExcludeDirFlagName = "queue-exclude-dir" QueueExcludesFileFlagName = "queue-excludes-file" QueueIncludeDirFlagName = "queue-include-dir" QueueIncludeExternalFlagName = "queue-include-external" QueueStrictIncludeFlagName = "queue-strict-include" QueueIncludeUnitsReadingFlagName = "queue-include-units-reading" // Filter related flags. FilterFlagName = "filter" FilterAffectedFlagName = "filter-affected" FilterAllowDestroyFlagName = "filter-allow-destroy" FilterFileFlagName = "filters-file" NoFilterFileFlagName = "no-filters-file" // Scaffolding related flags. RootFileNameFlagName = "root-file-name" NoIncludeRootFlagName = "no-include-root" NoShellFlagName = "no-shell" NoHooksFlagName = "no-hooks" // Concurrency control flags. ParallelismFlagName = "parallelism" // Backend flags BackendBootstrapFlagName = "backend-bootstrap" BackendRequireBootstrapFlagName = "backend-require-bootstrap" DisableBucketUpdateFlagName = "disable-bucket-update" // Feature flags FeatureFlagName = "feature" // Config and download flags ConfigFlagName = "config" DownloadDirFlagName = "download-dir" // Auth and IAM flags AuthProviderCmdFlagName = "auth-provider-cmd" InputsDebugFlagName = "inputs-debug" IAMAssumeRoleFlagName = "iam-assume-role" IAMAssumeRoleDurationFlagName = "iam-assume-role-duration" IAMAssumeRoleSessionNameFlagName = "iam-assume-role-session-name" IAMAssumeRoleWebIdentityTokenFlagName = "iam-assume-role-web-identity-token" )
Variables ¶
This section is empty.
Functions ¶
func NewAuthProviderCmdFlag ¶ added in v0.93.4
func NewAuthProviderCmdFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
NewAuthProviderCmdFlag creates a flag for specifying the auth provider command.
func NewBackendFlags ¶ added in v0.93.4
NewBackendFlags defines backend-related flags that should be available to both `run` and `backend` commands.
func NewConfigFlag ¶ added in v0.93.4
func NewConfigFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
NewConfigFlag creates a flag for specifying the Terragrunt config file path.
func NewDownloadDirFlag ¶ added in v0.93.4
func NewDownloadDirFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
NewDownloadDirFlag creates a flag for specifying the download directory path.
func NewFeatureFlags ¶ added in v0.93.4
NewFeatureFlags defines the feature flag map that should be available to both `run` and `backend` commands.
func NewFilterFlags ¶ added in v0.95.0
NewFilterFlags creates flags for specifying filter queries.
func NewIAMAssumeRoleFlags ¶ added in v0.93.4
func NewIAMAssumeRoleFlags(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) cli.Flags
NewIAMAssumeRoleFlags creates flags for IAM assume role configuration.
func NewInputsDebugFlag ¶ added in v0.93.4
func NewInputsDebugFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag
NewInputsDebugFlag creates a flag for enabling inputs debug output.
func NewParallelismFlag ¶ added in v0.92.1
func NewParallelismFlag(opts *options.TerragruntOptions) *flags.Flag
NewParallelismFlag creates a flag for specifying parallelism level.
func NewQueueFlags ¶
NewQueueFlags creates the flags used for queue control
func NewScaffoldingFlags ¶ added in v0.92.0
NewScaffoldingFlags creates the flags shared between catalog and scaffold commands.
func NewTFPathFlag ¶
func NewTFPathFlag(opts *options.TerragruntOptions) *flags.Flag
NewTFPathFlag creates a flag for specifying the OpenTofu/Terraform binary path.
Types ¶
This section is empty.
Source Files