Documentation
¶
Index ¶
- func ShowStruct(w io.Writer, orig interface{}) error
- type BackupSection
- type Config
- func (c *Config) AllSettings() map[string]interface{}
- func (c *Config) Get(key string) interface{}
- func (c *Config) GetConfigFile() string
- func (c *Config) GetGlobalSection() (*Global, error)
- func (c *Config) GetProfile(profileKey string) (*Profile, error)
- func (c *Config) GetProfileGroup(groupKey string) ([]string, error)
- func (c *Config) GetProfileGroups() map[string][]string
- func (c *Config) GetProfileSections() map[string][]string
- func (c *Config) HasProfile(profileKey string) bool
- func (c *Config) HasProfileGroup(groupKey string) bool
- func (c *Config) IsSet(key string) bool
- type Global
- type Profile
- func (p *Profile) GetBackupSource() []string
- func (p *Profile) GetCommandFlags(command string) map[string][]string
- func (p *Profile) GetCommonFlags() map[string][]string
- func (p *Profile) GetRetentionFlags() map[string][]string
- func (p *Profile) SetHost(hostname string)
- func (p *Profile) SetRootPath(rootPath string)
- type RetentionSection
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ShowStruct ¶ added in v0.8.1
Types ¶
type BackupSection ¶
type BackupSection struct {
CheckBefore bool `mapstructure:"check-before"`
CheckAfter bool `mapstructure:"check-after"`
RunBefore []string `mapstructure:"run-before"`
RunAfter []string `mapstructure:"run-after"`
UseStdin bool `mapstructure:"stdin" argument:"stdin"`
Source []string `mapstructure:"source"`
ExcludeFile []string `mapstructure:"exclude-file" argument:"exclude-file"`
FilesFrom []string `mapstructure:"files-from" argument:"files-from"`
OtherFlags map[string]interface{} `mapstructure:",remain"`
}
BackupSection contains the specific configuration to the 'backup' command
type Config ¶ added in v0.8.0
type Config struct {
// contains filtered or unexported fields
}
Config wraps up a viper configuration object
func LoadFile ¶ added in v0.8.0
LoadFile loads configuration from file Leave format blank for auto-detection from the file extension
func (*Config) AllSettings ¶ added in v0.8.0
AllSettings merges all settings and returns them as a map[string]interface{}.
func (*Config) GetConfigFile ¶ added in v0.8.0
GetConfigFile returns the config file used
func (*Config) GetGlobalSection ¶ added in v0.8.0
GetGlobalSection returns the global configuration
func (*Config) GetProfile ¶ added in v0.8.0
GetProfile from configuration
func (*Config) GetProfileGroup ¶ added in v0.8.0
GetProfileGroup returns the list of profiles in a group
func (*Config) GetProfileGroups ¶ added in v0.8.0
GetProfileGroups returns all groups from the configuration
If the groups section does not exist, it returns an empty map
func (*Config) GetProfileSections ¶ added in v0.8.0
GetProfileSections returns a list of profiles with all the sections defined inside each
func (*Config) HasProfile ¶ added in v0.8.0
HasProfile returns true if the profile exists in the configuration
func (*Config) HasProfileGroup ¶ added in v0.8.0
HasProfileGroup returns true if the group of profiles exists in the configuration
type Global ¶
type Global struct {
IONice bool `mapstructure:"ionice"`
IONiceClass int `mapstructure:"ionice-class"`
IONiceLevel int `mapstructure:"ionice-level"`
Nice int `mapstructure:"nice"`
Priority string `mapstructure:"priority"`
DefaultCommand string `mapstructure:"default-command"`
Initialize bool `mapstructure:"initialize"`
ResticBinary string `mapstructure:"restic-binary"`
MinMemory uint64 `mapstructure:"min-memory"`
}
Global holds the configuration from the global section
type Profile ¶
type Profile struct {
Name string
Quiet bool `mapstructure:"quiet" argument:"quiet"`
Verbose bool `mapstructure:"verbose" argument:"verbose"`
Repository string `mapstructure:"repository" argument:"repo"`
PasswordFile string `mapstructure:"password-file" argument:"password-file"`
CacheDir string `mapstructure:"cache-dir" argument:"cache-dir"`
CACert string `mapstructure:"cacert" argument:"cacert"`
TLSClientCert string `mapstructure:"tls-client-cert" argument:"tls-client-cert"`
Initialize bool `mapstructure:"initialize"`
Inherit string `mapstructure:"inherit"`
Lock string `mapstructure:"lock"`
RunBefore []string `mapstructure:"run-before"`
RunAfter []string `mapstructure:"run-after"`
RunAfterFail []string `mapstructure:"run-after-fail"`
Environment map[string]string `mapstructure:"env"`
Backup *BackupSection `mapstructure:"backup"`
Retention *RetentionSection `mapstructure:"retention"`
Snapshots map[string]interface{} `mapstructure:"snapshots"`
Forget map[string]interface{} `mapstructure:"forget"`
Check map[string]interface{} `mapstructure:"check"`
Mount map[string]interface{} `mapstructure:"mount"`
OtherFlags map[string]interface{} `mapstructure:",remain"`
// contains filtered or unexported fields
}
Profile contains the whole profile configuration
func NewProfile ¶
NewProfile instantiates a new blank profile
func (*Profile) GetBackupSource ¶
GetBackupSource returns the directories to backup
func (*Profile) GetCommandFlags ¶
GetCommandFlags returns the flags specific to the command (backup, snapshots, etc.)
func (*Profile) GetCommonFlags ¶
GetCommonFlags returns the flags common to all commands
func (*Profile) GetRetentionFlags ¶
GetRetentionFlags returns the flags specific to the "forget" command being run as part of a backup
func (*Profile) SetRootPath ¶
SetRootPath changes the path of all the relative paths and files in the configuration
type RetentionSection ¶
type RetentionSection struct {
BeforeBackup bool `mapstructure:"before-backup"`
AfterBackup bool `mapstructure:"after-backup"`
OtherFlags map[string]interface{} `mapstructure:",remain"`
}
RetentionSection contains the specific configuration to the 'forget' command run as part of a backup
Source Files