cfg

Documentation

Index

• Constants
• Variables
• type Configuration
  • func (c *Configuration) Validate() error

Constants

const (
	// RestoreTypeS3 indicates that the restore shall be done to an S3 endpoint.
	RestoreTypeS3 = "s3"

	// RestoreTypeFolder indicates that the restore shall be done to a folder,
	// usually a RWX PVC mounted to the Pod of the restore process.
	RestoreTypeFolder = "folder"
)

Variables

var (
	// Config contains the values of the user-provided configuration of the operator module,
	// combined with the default values as defined in operator.Command.
	Config = &Configuration{}
)

Types

type Configuration

type Configuration struct {
	DoCheck   bool
	DoPrune   bool
	DoRestore bool
	DoArchive bool

	BackupCommandAnnotation       string
	BackupFileExtensionAnnotation string
	BackupContainerAnnotation     string
	BackupDir                     string

	SkipPreBackup bool

	PromURL    string
	WebhookURL string

	Hostname   string
	KubeConfig string

	ResticBin        string
	ResticRepository string
	ResticOptions    string

	RestoreDir         string
	RestoreS3Endpoint  string
	RestoreS3AccessKey string
	RestoreS3SecretKey string
	RestoreSnap        string
	RestoreType        string
	RestoreFilter      string
	RestoreCACert      string
	RestoreClientCert  string
	RestoreClientKey   string
	VerifyRestore      bool
	RestoreTrimPath    bool

	PruneKeepLast    int
	PruneKeepHourly  int
	PruneKeepDaily   int
	PruneKeepWeekly  int
	PruneKeepMonthly int
	PruneKeepYearly  int
	PruneKeepTags    bool

	PruneKeepWithin        string
	PruneKeepWithinHourly  string
	PruneKeepWithinDaily   string
	PruneKeepWithinWeekly  string
	PruneKeepWithinMonthly string
	PruneKeepWithinYearly  string

	Tags []string

	TargetPods []string

	SleepDuration time.Duration

	VarDir     string
	CACert     string
	ClientCert string
	ClientKey  string
}

Configuration holds a strongly-typed tree of the configuration

func (*Configuration) Validate

func (c *Configuration) Validate() error

Validate ensures a consistent configuration and returns an error should that not be the case