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
- Variables
- func NewAllFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewAuthProviderCmdFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewBackendFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags
- func NewCASCloneDepthFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewConfigFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewDownloadDirFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewFailFastFlag(opts *options.TerragruntOptions) *flags.Flag
- func NewFeatureFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags
- func NewFilterFlags(l log.Logger, opts *options.TerragruntOptions) clihelper.Flags
- func NewGraphFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewIAMAssumeRoleFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags
- func NewInputsDebugFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewNoCASFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewNoDiscoveryAuthProviderCmdFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
- func NewParallelismFlag(opts *options.TerragruntOptions) *flags.Flag
- func NewQueueFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags
- func NewScaffoldingFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags
- func NewTFPathFlag(opts *options.TerragruntOptions) *flags.Flag
- type AllGraphFlagsError
Constants ¶
const ( AllFlagName = "all" AllFlagAlias = "a" )
const ( AuthProviderCmdFlagName = "auth-provider-cmd" NoDiscoveryAuthProviderCmdFlagName = "no-discovery-auth-provider-cmd" )
const ( BackendBootstrapFlagName = "backend-bootstrap" BackendRequireBootstrapFlagName = "backend-require-bootstrap" DisableBucketUpdateFlagName = "disable-bucket-update" )
const ( NoCASFlagName = "no-cas" CASCloneDepthFlagName = "cas-clone-depth" )
const ( FilterFlagName = "filter" FilterAffectedFlagName = "filter-affected" FilterAllowDestroyFlagName = "filter-allow-destroy" FilterFileFlagName = "filters-file" NoFilterFileFlagName = "no-filters-file" )
const ( IAMAssumeRoleFlagName = "iam-assume-role" IAMAssumeRoleDurationFlagName = "iam-assume-role-duration" IAMAssumeRoleSessionNameFlagName = "iam-assume-role-session-name" IAMAssumeRoleWebIdentityTokenFlagName = "iam-assume-role-web-identity-token" )
const ( 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" )
const ( RootFileNameFlagName = "root-file-name" NoIncludeRootFlagName = "no-include-root" NoShellFlagName = "no-shell" NoHooksFlagName = "no-hooks" )
const (
ConfigFlagName = "config"
)
const (
DownloadDirFlagName = "download-dir"
)
const (
FailFastFlagName = "fail-fast"
)
const (
FeatureFlagName = "feature"
)
const (
GraphFlagName = "graph"
)
const (
InputsDebugFlagName = "inputs-debug"
)
const (
ParallelismFlagName = "parallelism"
)
const (
TFPathFlagName = "tf-path"
)
Variables ¶
var ErrNoDiscoveryAuthProviderCmdRequiresExperiment = errors.New(
"--no-discovery-auth-provider-cmd requires the 'opt-out-auth' experiment to be enabled (e.g., --experiment=opt-out-auth)",
)
Functions ¶
func NewAllFlag ¶
NewAllFlag creates the --all flag for running commands across all units in a stack.
func NewAuthProviderCmdFlag ¶
NewAuthProviderCmdFlag creates a flag for specifying the auth provider command.
func NewBackendFlags ¶
NewBackendFlags defines backend-related flags that should be available to both `run` and `backend` commands.
func NewCASCloneDepthFlag ¶ added in v1.0.3
NewCASCloneDepthFlag creates the --cas-clone-depth flag for CAS git clone depth.
func NewConfigFlag ¶
NewConfigFlag creates a flag for specifying the Terragrunt config file path.
func NewDownloadDirFlag ¶
NewDownloadDirFlag creates a flag for specifying the download directory path.
func NewFailFastFlag ¶
func NewFailFastFlag(opts *options.TerragruntOptions) *flags.Flag
NewFailFastFlag creates the --fail-fast flag for stopping execution on the first error.
func NewFeatureFlags ¶
NewFeatureFlags defines the feature flag map that should be available to both `run` and `backend` commands.
func NewFilterFlags ¶
NewFilterFlags creates flags for specifying filter queries.
func NewGraphFlag ¶
NewGraphFlag creates the --graph flag for running commands following the DAG.
func NewIAMAssumeRoleFlags ¶
NewIAMAssumeRoleFlags creates flags for IAM assume role configuration.
func NewInputsDebugFlag ¶
NewInputsDebugFlag creates a flag for enabling inputs debug output.
func NewNoCASFlag ¶ added in v1.0.3
NewNoCASFlag creates the --no-cas flag for disabling CAS even when the experiment is enabled.
func NewNoDiscoveryAuthProviderCmdFlag ¶ added in v1.0.6
func NewNoDiscoveryAuthProviderCmdFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag
NewNoDiscoveryAuthProviderCmdFlag opts out of running --auth-provider-cmd during the discovery parse phase. Setting it without the opt-out-auth experiment returns ErrNoDiscoveryAuthProviderCmdRequiresExperiment.
func NewParallelismFlag ¶
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 ¶
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 ¶
type AllGraphFlagsError ¶
type AllGraphFlagsError byte
AllGraphFlagsError is returned when both --all and --graph flags are used simultaneously.
func (*AllGraphFlagsError) Error ¶
func (err *AllGraphFlagsError) Error() string
Source Files