Affected by 
Documentation
¶
Index ¶
Constants ¶
const ( // FilenamePrefix is the prefix used for backup archive files. FilenamePrefix = "juju-backup-" // FilenameTemplate is used with time.Time.Format to generate a filename. FilenameTemplate = FilenamePrefix + "20060102-150405.tar.gz" )
const UnknownString = "<unknown>"
UnknownString is a marker value for string fields with unknown values.
Variables ¶
var UnknownInt64 = int64(math.MaxInt64)
UnknownInt64 is a marker value for int64 fields with unknown values.
var UnknownVersion = version.MustParse("9999.9999.9999")
UnknownVersion is a marker value for version fields with unknown values.
Functions ¶
This section is empty.
Types ¶
type ArchiveData ¶
type ArchiveData struct {
ArchivePaths
// contains filtered or unexported fields
}
ArchiveData is a wrapper around a the uncompressed data in a backup archive file. It provides access to the content of the archive. While ArchiveData provides useful functionality, it may not be appropriate for large archives. The contents of the archive are kept in-memory, so large archives could be too taxing on the host. In that case consider using ArchiveWorkspace instead.
func NewArchiveData ¶
func NewArchiveData(data []byte) *ArchiveData
NewArchiveData builds a new archive data wrapper for the given uncompressed data.
func NewArchiveDataReader ¶
func NewArchiveDataReader(r io.Reader) (*ArchiveData, error)
NewArchiveDataReader returns a new archive data wrapper for the data in the provided reader. Note that the entire archive will be read into memory and kept there. So for relatively large archives it will often be more appropriate to use ArchiveWorkspace instead.
func (*ArchiveData) Metadata ¶
func (ad *ArchiveData) Metadata() (*Metadata, error)
Metadata returns the metadata stored in the backup archive. If no metadata is there, errors.NotFound is returned.
func (*ArchiveData) NewBuffer ¶
func (ad *ArchiveData) NewBuffer() *bytes.Buffer
NewBuffer wraps the archive data in a Buffer.
func (*ArchiveData) Version ¶
func (ad *ArchiveData) Version() (*version.Number, error)
Version returns the juju version under which the backup archive was created. If no version is found in the archive, it must come from before backup archives included the version. In that case we return version 1.20.
type ArchivePaths ¶
type ArchivePaths struct {
// ContentDir is the path to the directory within the archive
// containing all the contents. It is the only file or directory at
// the top-level of the archive and everything else in the archive
// is contained in the content directory.
ContentDir string
// FilesBundle is the path to the tar file inside the archive
// containing all the database related files (with the exception of the
// DB dump files) gathered in by the backup machinery.
FilesBundle string
// DBDumpDir is the path to the directory within the archive
// contents that contains all the files dumped from the juju
// database.
DBDumpDir string
// MetadataFile is the path to the metadata file.
MetadataFile string
}
ArchivePaths holds the paths to the files and directories in a backup archive.
func NewCanonicalArchivePaths ¶
func NewCanonicalArchivePaths() ArchivePaths
NewCanonicalArchivePaths composes a new ArchivePaths with default values set. These values are relative (un-rooted) and the canonical slash ("/") is the path separator. Thus the paths are suitable for resolving the paths in a backup archive file (which is a tar file).
func NewNonCanonicalArchivePaths ¶
func NewNonCanonicalArchivePaths(rootDir string) ArchivePaths
NewNonCanonicalArchivePaths builds a new ArchivePaths using default values, rooted at the provided rootDir. The path separator used is platform-dependent. The resulting paths are suitable for locating backup archive contents in a directory into which an archive has been unpacked.
type ArchiveWorkspace ¶
type ArchiveWorkspace struct {
ArchivePaths
RootDir string
}
ArchiveWorkspace is a wrapper around backup archive info that has a concrete root directory and an archive unpacked in it.
func NewArchiveWorkspaceReader ¶
func NewArchiveWorkspaceReader(archive io.Reader) (*ArchiveWorkspace, error)
NewArchiveWorkspaceReader returns a new archive workspace with a new workspace dir populated from the archive. Note that this involves unpacking the entire archive into a directory under the host's "temporary" directory. For relatively large archives this could have adverse effects on hosts with little disk space.
func (*ArchiveWorkspace) Close ¶
func (ws *ArchiveWorkspace) Close() error
Close cleans up the workspace dir.
func (*ArchiveWorkspace) Metadata ¶
func (ws *ArchiveWorkspace) Metadata() (*Metadata, error)
Metadata returns the metadata derived from the JSON file in the archive.
func (*ArchiveWorkspace) OpenBundledFile ¶
func (ws *ArchiveWorkspace) OpenBundledFile(filename string) (io.Reader, error)
OpenBundledFile returns an open ReadCloser for the corresponding file in the archived files bundle.
func (*ArchiveWorkspace) UnpackFilesBundle ¶
func (ws *ArchiveWorkspace) UnpackFilesBundle(targetRoot string) error
UnpackFilesBundle unpacks the archived files bundle into the targeted dir.
type ControllerMetadata ¶
type ControllerMetadata struct {
// UUID contains the controller UUID.
UUID string
// MachineID contains controller machine id from which this backup is taken.
MachineID string
// MachineInstanceID contains controller machine's instance id from which this backup is taken.
MachineInstanceID string
// HANodes contains the number of nodes in this controller's HA configuration.
HANodes int64
}
ControllerMetadata contains controller specific metadata.
func UnknownController ¶
func UnknownController() ControllerMetadata
UnknownController returns a new backups origin with unknown values.
type Metadata ¶
type Metadata struct {
*filestorage.FileMetadata
// Started records when the backup was started.
Started time.Time
// Finished records when the backup was complete.
Finished *time.Time
// Origin identifies where the backup was created.
Origin Origin
// Notes is an optional user-supplied annotation.
Notes string
// FormatVersion stores format version of these metadata.
FormatVersion int64
// Controller contains metadata about the controller where the backup was taken.
Controller ControllerMetadata
}
Metadata contains the metadata for a single backup archive.
func BuildMetadata ¶
BuildMetadata generates the metadata for a backup archive file.
func NewMetadata ¶
func NewMetadata() *Metadata
NewMetadata returns a new Metadata for a backup archive, in the most current format.
func NewMetadataJSONReader ¶
NewMetadataJSONReader extracts a new metadata from the JSON file.
func (*Metadata) AsJSONBuffer ¶
AsJSONBuffer returns a bytes.Buffer containing the JSON-ified metadata. This will always produce latest known format.
type Origin ¶
type Origin struct {
Model string
Machine string
Hostname string
Version version.Number
Base string
}
Origin identifies where a backup archive came from. While it is more about where and Metadata about what and when, that distinction does not merit special consideration. Instead, Origin exists separately from Metadata due to its use as an argument when requesting the creation of a new backup.
func UnknownOrigin ¶
func UnknownOrigin() Origin
UnknownOrigin returns a new backups origin with unknown values.
Source Files
Directories