config

Documentation

Overview

Package config defines functions and types related to configuration of comeback backup jobs. It is an implementation detail and should not be used directly.

Index

• func Validate(c *Config) error
• type Config
  • func Parse(data []byte) (*Config, error)
• type Job

Functions

func Validate

func Validate(c *Config) error

Return an error if the supplied config data is invalid in some way.

Types

type Config

type Config struct {
	// A set of named jobs. The names must be valid UTF-8.
	Jobs map[string]Job

	// Path to the key file to be used for signing requests to GCS.
	KeyFile string

	// The name of the GCS bucket to use for storing blobs and registry
	// information.
	BucketName string

	// A file on the local machine where state can be saved between runs.
	StateFile string
}

func Parse

func Parse(data []byte) (*Config, error)

Parse the supplied JSON configuration data.

type Job

type Job struct {
	// The path on the file system that should be backed up.
	BasePath string

	// A set of regexps to be matched against relative paths within the base
	// path, excluding the base path itself. If a relative path matches any of
	// these, it will be excluded from the backup. If the path represents a
	// directory, its contents will also be excluded.
	Excludes []*regexp.Regexp
}