args

package
v2.24.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 10, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbortOnErrorFlags

type AbortOnErrorFlags struct {
	AbortOnError bool `group:"misc" help:"Abort deploying when an error occurs instead of trying the remaining deployments"`
}

type ArgsFlags

type ArgsFlags struct {
	Arg          []string `` /* 472-byte string literal not displayed */
	ArgsFromFile []string `` /* 149-byte string literal not displayed */
}

func (*ArgsFlags) LoadArgs added in v2.22.0

func (a *ArgsFlags) LoadArgs() (*uo.UnstructuredObject, error)

type CommandResultFlags added in v2.20.0

type CommandResultFlags struct {
	CommandResultReadOnlyFlags
	CommandResultWriteFlags
}

type CommandResultReadOnlyFlags added in v2.22.0

type CommandResultReadOnlyFlags struct {
	CommandResultNamespace string `group:"results" help:"Override the namespace to be used when writing command results." default:"kluctl-results"`
}

type CommandResultWriteFlags added in v2.22.0

type CommandResultWriteFlags struct {
	WriteCommandResult       bool `group:"results" help:"Enable writing of command results into the cluster. This is enabled by default." default:"true"`
	ForceWriteCommandResult  bool `group:"results" help:"Force writing of command results, even if the command is run in dry-run mode."`
	KeepCommandResultsCount  int  `group:"results" help:"Configure how many old command results to keep." default:"5"`
	KeepValidateResultsCount int  `group:"results" help:"Configure how many old validate results to keep." default:"2"`
}

type DryRunFlags

type DryRunFlags struct {
	DryRun bool `group:"misc" help:"Performs all kubernetes API calls in dry-run mode."`
}

type ExistingDirType added in v2.20.0

type ExistingDirType string

func (*ExistingDirType) Set added in v2.20.0

func (s *ExistingDirType) Set(val string) error

func (*ExistingDirType) String added in v2.20.0

func (s *ExistingDirType) String() string

func (*ExistingDirType) Type added in v2.20.0

func (s *ExistingDirType) Type() string

type ExistingFileType added in v2.20.0

type ExistingFileType string

func (*ExistingFileType) Set added in v2.20.0

func (s *ExistingFileType) Set(val string) error

func (*ExistingFileType) String added in v2.20.0

func (s *ExistingFileType) String() string

func (*ExistingFileType) Type added in v2.20.0

func (s *ExistingFileType) Type() string

type ExistingPathType added in v2.20.0

type ExistingPathType string

func (*ExistingPathType) Set added in v2.20.0

func (s *ExistingPathType) Set(val string) error

func (*ExistingPathType) String added in v2.20.0

func (s *ExistingPathType) String() string

func (*ExistingPathType) Type added in v2.20.0

func (s *ExistingPathType) Type() string

type ForceApplyFlags

type ForceApplyFlags struct {
	ForceApply bool `group:"misc" help:"Force conflict resolution when applying. See documentation for details"`
}

type GitOpsArgs added in v2.22.0

type GitOpsArgs struct {
	ProjectDir
	CommandResultReadOnlyFlags

	Name          string `group:"gitops" help:"Specifies the name of the KluctlDeployment."`
	Namespace     string `` /* 144-byte string literal not displayed */
	LabelSelector string `group:"gitops" short:"l" help:"If specified, KluctlDeployments are searched and filtered by this label selector."`

	Kubeconfig          ExistingFileType `group:"gitops" help:"Overrides the kubeconfig to use."`
	Context             string           `group:"gitops" help:"Override the context to use."`
	ControllerNamespace string           `group:"gitops" help:"The namespace where the controller runs in." default:"kluctl-system"`

	LocalSourceOverridePort int `` /* 149-byte string literal not displayed */
}

type GitOpsLogArgs added in v2.22.0

type GitOpsLogArgs struct {
	LogSince        time.Duration `group:"logs" help:"Show logs since this time." default:"60s"`
	LogGroupingTime time.Duration `` /* 196-byte string literal not displayed */
	LogTime         bool          `group:"logs" help:"If enabled, adds timestamps to log lines"`
}

type GitOpsOverridableArgs added in v2.22.0

type GitOpsOverridableArgs struct {
	SourceOverrides
	TargetFlagsBase
	ArgsFlags
	ImageFlags
	InclusionFlags
	DryRunFlags
	ForceApplyFlags
	ReplaceOnErrorFlags
	AbortOnErrorFlags

	TargetContext string `` /* 210-byte string literal not displayed */
}

type HelmCredentials added in v2.11.0

type HelmCredentials struct {
	HelmUsername              []string `` /* 299-byte string literal not displayed */
	HelmPassword              []string `` /* 299-byte string literal not displayed */
	HelmKeyFile               []string `` /* 309-byte string literal not displayed */
	HelmCertFile              []string `` /* 296-byte string literal not displayed */
	HelmCAFile                []string `` /* 310-byte string literal not displayed */
	HelmInsecureSkipTlsVerify []string `` /* 288-byte string literal not displayed */
	HelmCreds                 []string `` /* 230-byte string literal not displayed */
}

func (*HelmCredentials) BuildAuthProvider added in v2.22.0

func (c *HelmCredentials) BuildAuthProvider(ctx context.Context) (helm_auth.HelmAuthProvider, error)

type HookFlags

type HookFlags struct {
	ReadinessTimeout time.Duration `` /* 214-byte string literal not displayed */
}

type IgnoreFlags

type IgnoreFlags struct {
	IgnoreTags           bool `group:"misc" help:"Ignores changes in tags when diffing"`
	IgnoreLabels         bool `group:"misc" help:"Ignores changes in labels when diffing"`
	IgnoreAnnotations    bool `group:"misc" help:"Ignores changes in annotations when diffing"`
	IgnoreKluctlMetadata bool `group:"misc" help:"Ignores changes in Kluctl related metadata (e.g. tags, discriminators, ...)"`
}

type ImageFlags

type ImageFlags struct {
	FixedImage      []string         `` /* 134-byte string literal not displayed */
	FixedImagesFile ExistingFileType `` /* 175-byte string literal not displayed */
}

func (*ImageFlags) LoadFixedImagesFromArgs

func (args *ImageFlags) LoadFixedImagesFromArgs() ([]types.FixedImage, error)

type InclusionFlags

type InclusionFlags struct {
	IncludeTag           []string `group:"inclusion" short:"I" help:"Include deployments with given tag."`
	ExcludeTag           []string `` /* 239-byte string literal not displayed */
	IncludeDeploymentDir []string `group:"inclusion" help:"Include deployment dir. The path must be relative to the root deployment project."`
	ExcludeDeploymentDir []string `` /* 172-byte string literal not displayed */
}

func (*InclusionFlags) ParseInclusionFromArgs

func (args *InclusionFlags) ParseInclusionFromArgs() (*utils.Inclusion, error)

type KubeconfigFlags added in v2.23.0

type KubeconfigFlags struct {
	Kubeconfig ExistingFileType `group:"project" help:"Overrides the kubeconfig to use."`
}

type OfflineKubernetesFlags added in v2.18.0

type OfflineKubernetesFlags struct {
	OfflineKubernetes bool   `group:"misc" help:"Run command in offline mode, meaning that it will not try to connect the target cluster"`
	KubernetesVersion string `` /* 145-byte string literal not displayed */
}

type OutputFlags

type OutputFlags struct {
	Output []string `group:"misc" short:"o" help:"Specify output target file. Can be specified multiple times"`
}

type OutputFormatFlags

type OutputFormatFlags struct {
	OutputFormat []string `` /* 247-byte string literal not displayed */
	NoObfuscate  bool     `group:"misc" help:"Disable obfuscation of sensitive/secret data"`
	ShortOutput  bool     `` /* 151-byte string literal not displayed */
}

type ProjectDir added in v2.18.0

type ProjectDir struct {
	ProjectDir ExistingDirType `group:"project" help:"Specify the project directory. Defaults to the current working directory."`
}

func (ProjectDir) GetProjectDir added in v2.18.0

func (a ProjectDir) GetProjectDir() (string, error)

type ProjectFlags

type ProjectFlags struct {
	ProjectDir
	SourceOverrides

	ProjectConfig ExistingFileType `group:"project" short:"c" help:"Location of the .kluctl.yaml config file. Defaults to $PROJECT/.kluctl.yaml" exts:"yml,yaml"`

	Timeout                time.Duration `` /* 156-byte string literal not displayed */
	GitCacheUpdateInterval time.Duration `` /* 130-byte string literal not displayed */
}

type RegistryCredentials added in v2.22.0

type RegistryCredentials struct {
	RegistryUsername      []string `` /* 156-byte string literal not displayed */
	RegistryPassword      []string `` /* 156-byte string literal not displayed */
	RegistryIdentityToken []string `` /* 174-byte string literal not displayed */
	RegistryToken         []string `` /* 156-byte string literal not displayed */
	RegistryCreds         []string `` /* 426-byte string literal not displayed */

	RegistryKeyFile  []string `` /* 151-byte string literal not displayed */
	RegistryCertFile []string `` /* 160-byte string literal not displayed */
	RegistryCAFile   []string `` /* 156-byte string literal not displayed */

	RegistryPlainHttp             []string `` /* 132-byte string literal not displayed */
	RegistryInsecureSkipTlsVerify []string `` /* 152-byte string literal not displayed */
}

func (*RegistryCredentials) BuildAuthProvider added in v2.22.0

type RenderOutputDirFlags

type RenderOutputDirFlags struct {
	RenderOutputDir string `group:"misc" help:"Specifies the target directory to render the project into. If omitted, a temporary directory is used."`
}

type ReplaceOnErrorFlags

type ReplaceOnErrorFlags struct {
	ReplaceOnError      bool `group:"misc" help:"When patching an object fails, try to replace it. See documentation for more details."`
	ForceReplaceOnError bool `` /* 129-byte string literal not displayed */
}

type SourceOverrides added in v2.22.0

type SourceOverrides struct {
	LocalGitOverride      []string `` /* 353-byte string literal not displayed */
	LocalGitGroupOverride []string `` /* 584-byte string literal not displayed */
	LocalOciOverride      []string `group:"project" help:"Same as --local-git-override, but for OCI repositories."`
	LocalOciGroupOverride []string `group:"project" help:"Same as --local-git-group-override, but for OCI repositories."`
}

func (*SourceOverrides) ParseOverrides added in v2.22.0

func (a *SourceOverrides) ParseOverrides(ctx context.Context) (*sourceoverride.Manager, error)

type TargetFlags

type TargetFlags struct {
	TargetFlagsBase
	Context string `` /* 209-byte string literal not displayed */
}

type TargetFlagsBase added in v2.22.0

type TargetFlagsBase struct {
	Target             string `group:"project" short:"t" help:"Target name to run command for. Target must exist in .kluctl.yaml."`
	TargetNameOverride string `` /* 270-byte string literal not displayed */
}

type YesFlags

type YesFlags struct {
	Yes bool `group:"misc" short:"y" help:"Suppresses 'Are you sure?' questions and proceeds as if you would answer 'yes'."`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL