backup

Documentation

Index

• Variables
• type Config
  • func NewConfig(optionalMappings ...providerMap) *Config
  • func (c *Config) AddToFlagSet(fs *pflag.FlagSet)
  • func (c *Config) CreateSelectedProvider(ctx context.Context) (backup.Provider, error)
  • func (c *Config) GetEnvVars(fs *pflag.FlagSet) (envvars []corev1.EnvVar)
  • func (c *Config) Validate(fs *pflag.FlagSet) error

Variables

var (

	// ErrInvalidConfig is wrapped within all errors from this pkg, and can be
	// used by downstream to identify errors
	ErrInvalidConfig = errors.New("invalid backup config")

	ErrInvalidProvider = fmt.Errorf("%w: invalid provider", ErrInvalidConfig)
)

Types

type Config

type Config struct {

	// Name of Selected provider
	Selected string
	// contains filtered or unexported fields
}

Config holds the flag configuration for all providers

func NewConfig

func NewConfig(optionalMappings ...providerMap) *Config

func (*Config) AddToFlagSet

func (c *Config) AddToFlagSet(fs *pflag.FlagSet)

AddToFlagSet adds config's (and its providers') flagsets to fs

func (*Config) CreateSelectedProvider

func (c *Config) CreateSelectedProvider(ctx context.Context) (backup.Provider, error)

func (*Config) GetEnvVars

func (c *Config) GetEnvVars(fs *pflag.FlagSet) (envvars []corev1.EnvVar)

GetEnvVars converts the complete flagset into a list of k8s environment variable objects. Assumes config's flagset is present within fs, and assumes fs has been parsed.

func (*Config) Validate

func (c *Config) Validate(fs *pflag.FlagSet) error

Validate all user-specified flags