cfg

Documentation

Index

• Constants
• Variables
• type Configuration
  • func (c Configuration) GetGlobalDefaultResources() (res corev1.ResourceRequirements)
  • func (c Configuration) GetGlobalFailedJobsHistoryLimit() int
  • func (c Configuration) GetGlobalRepository() string
  • func (c Configuration) GetGlobalSuccessfulJobsHistoryLimit() int

Constants

const (
	RestoreS3EndpointEnvName        = "RESTORE_S3ENDPOINT"
	RestoreS3AccessKeyIDEnvName     = "RESTORE_ACCESSKEYID"
	RestoreS3SecretAccessKeyEnvName = "RESTORE_SECRETACCESSKEY"

	ResticRepositoryEnvName = "RESTIC_REPOSITORY"
	ResticPasswordEnvName   = "RESTIC_PASSWORD"
	ResticOptionsEnvName    = "RESTIC_OPTIONS"

	AwsAccessKeyIDEnvName     = "AWS_ACCESS_KEY_ID"
	AwsSecretAccessKeyEnvName = "AWS_SECRET_ACCESS_KEY"

	AzureAccountEnvName    = "AZURE_ACCOUNT_NAME"
	AzureAccountKeyEnvName = "AZURE_ACCOUNT_KEY"

	GcsProjectIDEnvName   = "GOOGLE_PROJECT_ID"
	GcsAccessTokenEnvName = "GOOGLE_ACCESS_TOKEN"

	B2AccountIDEnvName  = "B2_ACCOUNT_ID"
	B2AccountKeyEnvName = "B2_ACCOUNT_KEY"

	RestUserEnvName     = "USER"
	RestPasswordEnvName = "PASSWORD"
)

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 {
	MountPath                        string
	BackupAnnotation                 string
	BackupContainerAnnotation        string
	BackupCommandAnnotation          string
	FileExtensionAnnotation          string
	ServiceAccount                   string
	BackupCheckSchedule              string
	GlobalAccessKey                  string
	GlobalKeepJobs                   int
	GlobalFailedJobsHistoryLimit     int
	GlobalSuccessfulJobsHistoryLimit int
	GlobalRepoPassword               string
	GlobalRestoreS3AccessKey         string
	GlobalRestoreS3Bucket            string
	GlobalRestoreS3Endpoint          string
	GlobalRestoreS3SecretAccessKey   string
	GlobalS3Bucket                   string
	GlobalS3Endpoint                 string
	GlobalSecretAccessKey            string
	GlobalStatsURL                   string
	GlobalConcurrentArchiveJobsLimit int
	GlobalConcurrentBackupJobsLimit  int
	GlobalConcurrentCheckJobsLimit   int
	GlobalConcurrentPruneJobsLimit   int
	GlobalConcurrentRestoreJobsLimit int
	GlobalCPUResourceRequest         string
	GlobalCPUResourceLimit           string
	GlobalMemoryResourceRequest      string
	GlobalMemoryResourceLimit        string
	BackupImage                      string
	BackupCommandRestic              []string
	MetricsBindAddress               string
	PodExecRoleName                  string
	PodFilter                        string
	PromURL                          string
	RestartPolicy                    string

	// Enabling this will ensure there is only one active controller manager.
	EnableLeaderElection bool
	OperatorNamespace    string

	// Allows to pass options to restic, see https://restic.readthedocs.io/en/stable/manual_rest.html?highlight=--option#usage-help
	// Format: `key=value,key2=value2`
	ResticOptions string
}

Configuration holds a strongly-typed tree of the configuration

func (Configuration) GetGlobalDefaultResources

func (c Configuration) GetGlobalDefaultResources() (res corev1.ResourceRequirements)

func (Configuration) GetGlobalFailedJobsHistoryLimit

func (c Configuration) GetGlobalFailedJobsHistoryLimit() int

GetGlobalFailedJobsHistoryLimit returns the global failed jobs history limit. Returns global KeepJobs if unspecified.

func (Configuration) GetGlobalRepository

func (c Configuration) GetGlobalRepository() string

GetGlobalRepository is a shortcut for building an S3 string "s3:<endpoint>/<bucket>"

func (Configuration) GetGlobalSuccessfulJobsHistoryLimit

func (c Configuration) GetGlobalSuccessfulJobsHistoryLimit() int

GetGlobalSuccessfulJobsHistoryLimit returns the global successful jobs history limit. Returns global KeepJobs if unspecified.