Documentation
¶
Overview ¶
Package secret implements the `atmos secret` command group for declarative secrets CRUD.
Index ¶
- Variables
- type SecretCommandProvider
- func (p *SecretCommandProvider) GetAliases() []internal.CommandAlias
- func (p *SecretCommandProvider) GetCommand() *cobra.Command
- func (p *SecretCommandProvider) GetCompatibilityFlags() map[string]compat.CompatibilityFlag
- func (p *SecretCommandProvider) GetFlagsBuilder() flags.Builder
- func (p *SecretCommandProvider) GetGroup() string
- func (p *SecretCommandProvider) GetName() string
- func (p *SecretCommandProvider) GetPositionalArgsBuilder() *flags.PositionalArgsBuilder
- func (p *SecretCommandProvider) IsExperimental() bool
Constants ¶
This section is empty.
Variables ¶
var ErrAmbiguousVault = errors.New("multiple vaults configured; name one")
ErrAmbiguousVault indicates a vault must be named because several are configured.
var ErrNoVault = errors.New("no secrets vault is configured")
ErrNoVault indicates no secrets vault is configured (or the named one is absent).
var ErrRawFormatConflict = errors.New("--raw is text-only and cannot be combined with --format=json or --format=env")
ErrRawFormatConflict indicates --raw was combined with a non-text --format.
var ErrSecretNameRequired = errors.New("a secret NAME is required (or use --all to delete every declared secret)")
ErrSecretNameRequired indicates a secret NAME argument is required (and --all was not given).
var ErrUnsupportedFormat = errors.New("unsupported format (use env or json)")
ErrUnsupportedFormat indicates an unsupported file format was requested.
Functions ¶
This section is empty.
Types ¶
type SecretCommandProvider ¶
type SecretCommandProvider struct{}
SecretCommandProvider implements the CommandProvider interface.
func (*SecretCommandProvider) GetAliases ¶
func (p *SecretCommandProvider) GetAliases() []internal.CommandAlias
GetAliases returns command aliases.
func (*SecretCommandProvider) GetCommand ¶
func (p *SecretCommandProvider) GetCommand() *cobra.Command
GetCommand returns the secret command.
func (*SecretCommandProvider) GetCompatibilityFlags ¶
func (p *SecretCommandProvider) GetCompatibilityFlags() map[string]compat.CompatibilityFlag
GetCompatibilityFlags returns compatibility flags for this command.
func (*SecretCommandProvider) GetFlagsBuilder ¶
func (p *SecretCommandProvider) GetFlagsBuilder() flags.Builder
GetFlagsBuilder returns the flags builder for this command.
func (*SecretCommandProvider) GetGroup ¶
func (p *SecretCommandProvider) GetGroup() string
GetGroup returns the command group for help organization.
func (*SecretCommandProvider) GetName ¶
func (p *SecretCommandProvider) GetName() string
GetName returns the command name.
func (*SecretCommandProvider) GetPositionalArgsBuilder ¶
func (p *SecretCommandProvider) GetPositionalArgsBuilder() *flags.PositionalArgsBuilder
GetPositionalArgsBuilder returns the positional args builder for this command.
func (*SecretCommandProvider) IsExperimental ¶
func (p *SecretCommandProvider) IsExperimental() bool
IsExperimental returns whether this command is experimental.