cfbackup

package
v2.0.27+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 18, 2016 License: Apache-2.0, Apache-2.0 Imports: 26 Imported by: 0

README

cfbackup

Cloud Foundry Backup Utilities

wercker status

GoDoc

this repo is meant to be included in other projects. It will provide method calls for backing up Ops Manager and Elastic Runtime.

Running tests / build pipeline locally (docker-machine)


# install the wercker cli
$ curl -L https://install.wercker.com | sh

# make sure a docker host is running
$ docker-machine start default && eval $(docker-machine env default)

# run the build pipeline locally, to test your code locally
$ ./testrunner

Running tests / build pipeline locally (boot2docker)


# install the wercker cli
$ curl -L https://install.wercker.com | sh

# make sure a docker host is running
$ boot2docker up && $(boot2docker shellinit)

# run the build pipeline locally, to test your code locally
$ ./testrunner

Documentation

Index

Constants

View Source 
const (
	//AccessKeyIDVarname - s3 key flag
	AccessKeyIDVarname = "S3_ACCESS_KEY_ID"
	//SecretAccessKeyVarname - s3 secret key
	SecretAccessKeyVarname = "S3_SECRET_ACCESS_KEY"
	//BucketNameVarname - bucket name var flag
	BucketNameVarname = "S3_BUCKET_NAME"
	//S3Domain - s3 domain value
	S3Domain = "S3_DOMAIN"
	//IsS3Varname - s3 persistence true|false
	IsS3Varname = "S3_ACTIVE"

	OpsMgrInstallationSettingsFilename    string = "installation.json"
	OpsMgrInstallationAssetsFileName      string = "installation.zip"
	OpsMgrInstallationAssetsPostFieldName string = "installation[file]"
	OpsMgrDeploymentsFileName             string = "deployments.tar.gz"
	OpsMgrEncryptionKeyFileName           string = "cc_db_encryption_key.txt"
	OpsMgrBackupDir                       string = "opsmanager"
	OpsMgrDeploymentsDir                  string = "deployments"
	OpsMgrDefaultSSHPort                  int    = 22
	OpsMgrInstallationSettingsURL         string = "https://%s/api/installation_settings"
	OpsMgrInstallationAssetsURL           string = "https://%s/api/installation_asset_collection"
	OpsMgrDeploymentsFile                 string = "/var/tempest/workspaces/default/deployments/bosh-deployments.yml"

	//NfsDirPath - this is where the nfs store lives
	NfsDirPath string = "/var/vcap/store"
	//NfsArchiveDir - this is the archive dir name
	NfsArchiveDir string = "shared"
	//NfsDefaultSSHUser - this is the default ssh user for nfs
	NfsDefaultSSHUser string = "vcap"

	//ERDefaultSystemUser - default user for system vms
	ERDefaultSystemUser = "vcap"
	//ERDirectorInfoURL - url format for a director info endpoint
	ERDirectorInfoURL = "https://%s:25555/info"
	//ERBackupDir - default er backup dir
	ERBackupDir = "elasticruntime"
	//ERVmsURL - url format for a vms url
	ERVmsURL = "https://%s:25555/deployments/%s/vms"
	//ERDirector -- key
	ERDirector = "DirectorInfo"
	//ERConsole -- key
	ERConsole = "ConsoledbInfo"
	//ERUaa -- key
	ERUaa = "UaadbInfo"
	//ERCc -- key
	ERCc = "CcdbInfo"
	//ERMySql -- key
	ERMySql = "MysqldbInfo"
	//ERNfs -- key
	ERNfs = "NfsInfo"
	//ERBackupFileFormat -- format of archive filename
	ERBackupFileFormat = "%s.backup"
	//ERInvalidDirectorCredsMsg -- error message for invalid creds on director
	ERInvalidDirectorCredsMsg = "invalid director credentials"
	//ERNoPersistenceArchives -- error message for persistence stores
	ERNoPersistenceArchives = "there are no persistence stores in the list"
	//ERFileDoesNotExist -- error message for file does not exist
	ERFileDoesNotExist = "file does not exist"
	//ErrERDBBackupFailure -- error message for backup failure
	ErrERDBBackupFailure = "failed to backup database"
	//ERVersionEnvFlag -- env flag from ER version toggle
	ERVersionEnvFlag = "ER_VERSION"
	//ERVersion16 -- value for 1.6 toggle
	ERVersion16 = "1.6"

	//BackupLoggerName --
	BackupLoggerName = "Backup"
	//RestoreLoggerName --
	RestoreLoggerName = "Restore"

	//SDProduct --
	SDProduct string = "Product"
	//SDComponent --
	SDComponent string = "Component"
	//SDIdentity --
	SDIdentity string = "Identity"
	//SDIP --
	SDIP string = "Ip"
	//SDUser --
	SDUser string = "User"
	//SDPass --
	SDPass string = "Pass"
	//SDVcapUser --
	SDVcapUser string = "VcapUser"
	//SDVcapPass --
	SDVcapPass string = "VcapPass"
)
View Source 
const (
	//ImportArchive --
	ImportArchive = iota
	//ExportArchive --
	ExportArchive
)

Variables

View Source 
var (
	//ErrNoSSLKeyFound - error if there are no ssl keys found in the iaas config block of installationsettings
	ErrNoSSLKeyFound = errors.New("no ssl key found in iaas config")

	//NfsNewRemoteExecuter - this is a function which is able to execute a remote command against the nfs server
	NfsNewRemoteExecuter func(command.SshConfig) (command.Executer, error) = command.NewRemoteExecutor

	//ErrERDirectorCreds - error for director creds
	ErrERDirectorCreds = errors.New(ERInvalidDirectorCredsMsg)
	//ErrEREmptyDBList - error for db list empty
	ErrEREmptyDBList = errors.New(ERNoPersistenceArchives)
	//ErrERInvalidPath - invalid filepath error
	ErrERInvalidPath = &os.PathError{Err: errors.New(ERFileDoesNotExist)}
	//ErrERDBBackup - error for db backup failures
	ErrERDBBackup = errors.New(ErrERDBBackupFailure)

	//TileRestoreAction -- executes a restore action on the given tile
	TileRestoreAction = func(t Tile) func() error {
		return t.Restore
	}
	//TileBackupAction - executes a backup action on a given tile
	TileBackupAction = func(t Tile) func() error {
		return t.Backup
	}
)
View Source 
var GetInstallationSettings = func(tileSpec tileregistry.TileSpec) (settings io.Reader, err error) {
	var (
		opsManager *OpsManager
	)

	if opsManager, err = NewOpsManager(tileSpec.OpsManagerHost, tileSpec.AdminUser, tileSpec.AdminPass, tileSpec.OpsManagerUser, tileSpec.OpsManagerPass, tileSpec.ArchiveDirectory); err == nil {
		settings, err = opsManager.GetInstallationSettings()
	}
	return
}

GetInstallationSettings - makes a call to ops manager and returns a io.reader containing the contents of the installation settings file.

View Source 
var NewDirector = func(ip, username, password string, port int) bosh.Bosh {
	return bosh.NewBoshDirector(ip, username, password, port, NewHttpGateway())
}

NewDirector - a function representing a constructor for a director object

View Source 
var NewElasticRuntime = func(jsonFile string, target string, sshKey string) *ElasticRuntime {
	var (
		uaadbInfo *PgInfo = &PgInfo{
			SystemInfo: SystemInfo{
				Product:       "cf",
				Component:     "uaadb",
				Identity:      "root",
				SSHPrivateKey: sshKey,
			},
			Database: "uaa",
		}
		consoledbInfo *PgInfo = &PgInfo{
			SystemInfo: SystemInfo{
				Product:       "cf",
				Component:     "consoledb",
				Identity:      "root",
				SSHPrivateKey: sshKey,
			},
			Database: "console",
		}
		ccdbInfo *PgInfo = &PgInfo{
			SystemInfo: SystemInfo{
				Product:       "cf",
				Component:     "ccdb",
				Identity:      "admin",
				SSHPrivateKey: sshKey,
			},
			Database: "ccdb",
		}
		mysqldbInfo *MysqlInfo = &MysqlInfo{
			SystemInfo: SystemInfo{
				Product:       "cf",
				Component:     "mysql",
				Identity:      "root",
				SSHPrivateKey: sshKey,
			},
			Database: "mysql",
		}
		directorInfo *SystemInfo = &SystemInfo{
			Product:       BoshName(),
			Component:     "director",
			Identity:      "director",
			SSHPrivateKey: sshKey,
		}
		nfsInfo *NfsInfo = &NfsInfo{
			SystemInfo: SystemInfo{
				Product:       "cf",
				Component:     "nfs_server",
				Identity:      "vcap",
				SSHPrivateKey: sshKey,
			},
		}
	)

	context := &ElasticRuntime{
		SSHPrivateKey: sshKey,
		JSONFile:      jsonFile,
		BackupContext: NewBackupContext(target, cfenv.CurrentEnv()),
		SystemsInfo: map[string]SystemDump{
			ERDirector: directorInfo,
			ERConsole:  consoledbInfo,
			ERUaa:      uaadbInfo,
			ERCc:       ccdbInfo,
			ERMySql:    mysqldbInfo,
			ERNfs:      nfsInfo,
		},
		PersistentSystems: []SystemDump{
			consoledbInfo,
			uaadbInfo,
			ccdbInfo,
			nfsInfo,
			mysqldbInfo,
		},
	}
	return context
}

NewElasticRuntime initializes an ElasticRuntime intance

View Source 
var NewOpsManager = func(opsManagerHostname string, adminUsername string, adminPassword string, opsManagerUsername string, opsManagerPassword string, target string) (context *OpsManager, err error) {
	backupContext := NewBackupContext(target, cfenv.CurrentEnv())
	settingsHTTPRequestor := ghttp.NewHttpGateway()
	settingsMultiHTTPRequestor := GetUploader(backupContext)
	assetsHTTPRequestor := ghttp.NewHttpGateway()
	assetsMultiHTTPRequestor := GetUploader(backupContext)

	context = &OpsManager{
		SettingsUploader:    settingsMultiHTTPRequestor,
		AssetsUploader:      assetsMultiHTTPRequestor,
		SettingsRequestor:   settingsHTTPRequestor,
		AssetsRequestor:     assetsHTTPRequestor,
		DeploymentDir:       path.Join(target, OpsMgrBackupDir, OpsMgrDeploymentsDir),
		Hostname:            opsManagerHostname,
		Username:            adminUsername,
		Password:            adminPassword,
		BackupContext:       backupContext,
		LocalExecuter:       command.NewLocalExecuter(),
		OpsmanagerBackupDir: OpsMgrBackupDir,
		SSHUsername:         opsManagerUsername,
		SSHPassword:         opsManagerPassword,
		SSHPort:             OpsMgrDefaultSSHPort,
	}
	err = context.createExecuter()
	return
}

NewOpsManager initializes an OpsManager instance

View Source 
var TaskPingFreq = 1000 * time.Millisecond

Not ping server so frequently and exausted the resources

Functions

func BoshName added in v1.1.18 

func BoshName() (bosh string)

BoshName - function which returns proper bosh component name for given version

func ExtractEncryptionKey 

func ExtractEncryptionKey(dest io.Writer, deploymentDir string) (err error)

ExtractEncryptionKey - extract the encryptionKey from a deployment archive

func GetDeploymentName 

func GetDeploymentName(jsonObj InstallationCompareObject) (deploymentName string, err error)

GetDeploymentName - returns the name of the deployment

func GetPasswordAndIP 

func GetPasswordAndIP(jsonObj InstallationCompareObject, product, component, username string) (ip, password string, err error)

GetPasswordAndIP - returns password and ip from the installation settings from a given component

func GetUploader 

func GetUploader(backupContext BackupContext) (uploader httpUploader)

GetUploader - returns an uploader from a given backup context

func SetPGDumpUtilVersions added in v1.1.19 

func SetPGDumpUtilVersions()

SetPGDumpUtilVersions -- set version paths for pgdump/pgrestore utils

Types

type BackupContext 

type BackupContext struct {
	TargetDir string
	IsS3      bool
	StorageProvider
}

BackupContext - stores the base context information for a backup/restore

func NewBackupContext 

func NewBackupContext(targetDir string, env map[string]string) (backupContext BackupContext)

NewBackupContext initializes a BackupContext

type CCJob 

type CCJob struct {
	Job   string
	Index int
}

CCJob - a cloud controller job object

func GetCCVMs 

func GetCCVMs(jsonObj []VMObject) ([]CCJob, error)

GetCCVMs - a function to get a list of ccjobs

type CloudController 

type CloudController struct {
	// contains filtered or unexported fields
}

CloudController - a struct representing a cloud controller

func NewCloudController 

func NewCloudController(ip, username, password, deploymentName, manifest string, cloudControllers CloudControllerJobs) *CloudController

NewCloudController - a function representing a constructor for a cloud controller

func (*CloudController) Start 

func (c *CloudController) Start() error

Start - a method to execute a start event on a cloud controller

func (*CloudController) Stop 

func (c *CloudController) Stop() error

Stop - a method which executes a stop against a cloud controller

type CloudControllerDeploymentParser 

type CloudControllerDeploymentParser struct {
	// contains filtered or unexported fields
}

CloudControllerDeploymentParser - a struct which will handle the parsing of deployments

func (*CloudControllerDeploymentParser) Parse 

func (s *CloudControllerDeploymentParser) Parse(jsonObj []VMObject) ([]CCJob, error)

Parse - a method which will parse a given vmobject array

type CloudControllerJobs 

type CloudControllerJobs []CCJob

CloudControllerJobs - array storing a list of CCJobs

type ConfigurationParser 

type ConfigurationParser struct {
	// contains filtered or unexported fields
}

ConfigurationParser - the parser to handle installation settings file parsing

func NewConfigurationParser 

func NewConfigurationParser(installationFilePath string) *ConfigurationParser

NewConfigurationParser - constructor for a ConfigurationParser from a json installationsettings file

func NewConfigurationParserFromReader 

func NewConfigurationParserFromReader(settings io.Reader) *ConfigurationParser

NewConfigurationParserFromReader - constructor for a ConfigurationParser from a json installationsettings file

func (*ConfigurationParser) GetIaaS 

func (s *ConfigurationParser) GetIaaS() (config IaaSConfiguration, err error)

GetIaaS - get the iaas elements from the installation settings

type DiskProvider 

type DiskProvider struct {
	Directory string
}

DiskProvider is a storage provider that stores your Docker images on local disk.

func (*DiskProvider) Reader 

func (d *DiskProvider) Reader(path ...string) (io.ReadCloser, error)

Reader returns an io.ReadCloser for the specified path

func (*DiskProvider) Writer 

func (d *DiskProvider) Writer(path ...string) (io.WriteCloser, error)

Writer returns an io.WriteCloser for the specified path

type ElasticRuntime 

type ElasticRuntime struct {
	BackupContext
	JSONFile          string
	SystemsInfo       map[string]SystemDump
	PersistentSystems []SystemDump
	HTTPGateway       ghttp.HttpGateway
	InstallationName  string
	SSHPrivateKey     string
}

ElasticRuntime contains information about a Pivotal Elastic Runtime deployment

func (*ElasticRuntime) Backup 

func (context *ElasticRuntime) Backup() (err error)

Backup performs a backup of a Pivotal Elastic Runtime deployment

func (*ElasticRuntime) ReadAllUserCredentials 

func (context *ElasticRuntime) ReadAllUserCredentials() (err error)

ReadAllUserCredentials - get all user creds from the installation json

func (*ElasticRuntime) Restore 

func (context *ElasticRuntime) Restore() (err error)

Restore performs a restore of a Pivotal Elastic Runtime deployment

func (*ElasticRuntime) RunDbAction 

func (context *ElasticRuntime) RunDbAction(dbInfoList []SystemDump, action int) (err error)

RunDbAction - run a db action dump/import against a list of systemdump types

type ElasticRuntimeBuilder added in v1.1.13 

type ElasticRuntimeBuilder struct{}

ElasticRuntimeBuilder -- an object that can build an elastic runtime pre-initialized

func (*ElasticRuntimeBuilder) New added in v1.1.13 

func (s *ElasticRuntimeBuilder) New(tileSpec tileregistry.TileSpec) (elasticRuntime tileregistry.Tile, err error)

New -- method to generate an initialized elastic runtime

type IPPasswordParser 

type IPPasswordParser struct {
	Product   string
	Component string
	Username  string
	// contains filtered or unexported fields
}

IPPasswordParser - parses the passwords out of a installation settings

func (*IPPasswordParser) Parse 

func (s *IPPasswordParser) Parse(jsonObj InstallationCompareObject) (ip, password string, err error)

Parse - parse a given installation compare object

type IaaSConfiguration 

type IaaSConfiguration struct {
	SSHPrivateKey string `json:"ssh_private_key"`
}

IaaSConfiguration - a struct to house the IaaSConfiguration block elements from the json

type Infrastructure 

type Infrastructure struct {
	IaaSConfig IaaSConfiguration `json:"iaas_configuration"`
}

Infrastructure - a struct to house Infrastructure block elements from the json

type InstallationCompareObject 

type InstallationCompareObject struct {
	Guid                string
	InstallationVersion string `json:"installation_version"`
	Products            []productCompareObject
	Infrastructure      infrastructure
}

InstallationCompareObject --

func ReadAndUnmarshal 

func ReadAndUnmarshal(src io.Reader) (jsonObj InstallationCompareObject, err error)

ReadAndUnmarshal - takes an io.reader and unmarshals its contents into a compare object

type InstallationSettings 

type InstallationSettings struct {
	Infrastructure Infrastructure
}

InstallationSettings - an object to house installationsettings elements from the json

type MysqlInfo 

type MysqlInfo struct {
	SystemInfo
	Database string
}

MysqlInfo - a struct representing a mysql systemdump implementation

func (*MysqlInfo) GetPersistanceBackup 

func (s *MysqlInfo) GetPersistanceBackup() (dumper PersistanceBackup, err error)

GetPersistanceBackup - the constructor for a new mysqlinfo object

type NFSBackup 

type NFSBackup struct {
	Caller    command.Executer
	RemoteOps remoteOpsInterface
}

NFSBackup - this is a nfs backup object

func NewNFSBackup 

func NewNFSBackup(password, ip string, sslKey string) (nfs *NFSBackup, err error)

NewNFSBackup - constructor for an nfsbackup object

func (*NFSBackup) Dump 

func (s *NFSBackup) Dump(dest io.Writer) (err error)

Dump - will dump the output of a executed command to the given writer

func (*NFSBackup) Import 

func (s *NFSBackup) Import(lfile io.Reader) (err error)

Import - will upload the contents of the given io.reader to the remote execution target and execute the restore command against the uploaded file.

type NfsInfo 

type NfsInfo struct {
	SystemInfo
}

NfsInfo - a struct representing a nfs systemdump implementation

func (*NfsInfo) GetPersistanceBackup 

func (s *NfsInfo) GetPersistanceBackup() (dumper PersistanceBackup, err error)

GetPersistanceBackup - the constructor for a new nfsinfo object

type OpsManager 

type OpsManager struct {
	BackupContext
	Hostname            string
	Username            string
	Password            string
	TempestPassword     string
	DbEncryptionKey     string
	Executer            command.Executer
	LocalExecuter       command.Executer
	SettingsUploader    httpUploader
	AssetsUploader      httpUploader
	SettingsRequestor   httpRequestor
	AssetsRequestor     httpRequestor
	DeploymentDir       string
	OpsmanagerBackupDir string
	SSHPrivateKey       string
	SSHUsername         string
	SSHPassword         string
	SSHPort             int
}

OpsManager contains the location and credentials of a Pivotal Ops Manager instance

func (*OpsManager) Backup 

func (context *OpsManager) Backup() (err error)

Backup performs a backup of a Pivotal Ops Manager instance

func (*OpsManager) GetInstallationSettings added in v1.1.13 

func (context *OpsManager) GetInstallationSettings() (settings io.Reader, err error)

GetInstallationSettings retrieves all the installation settings from OpsMan and returns them in a buffered reader

func (*OpsManager) Restore 

func (context *OpsManager) Restore() (err error)

Restore performs a restore of a Pivotal Ops Manager instance

func (*OpsManager) SetSSHPrivateKey 

func (context *OpsManager) SetSSHPrivateKey(key string)

SetSSHPrivateKey - sets the private key in the ops manager object and rebuilds the remote executer associated with the opsmanager

type OpsManagerBuilder added in v1.1.13 

type OpsManagerBuilder struct{}

OpsManagerBuilder - an object that can build ops manager objects

func (*OpsManagerBuilder) New added in v1.1.13 

func (s *OpsManagerBuilder) New(tileSpec tileregistry.TileSpec) (opsManagerTile tileregistry.Tile, err error)

New -- builds a new ops manager object pre initialized

type PersistanceBackup 

type PersistanceBackup interface {
	Dump(io.Writer) error
	Import(io.Reader) error
}

PersistanceBackup - a struct representing a persistence backup

type PgInfo 

type PgInfo struct {
	SystemInfo
	Database string
}

PgInfo - a struct representing a pgres systemdump implementation

func (*PgInfo) GetPersistanceBackup 

func (s *PgInfo) GetPersistanceBackup() (dumper PersistanceBackup, err error)

GetPersistanceBackup - the constructor for a new pginfo object

type S3Provider 

type S3Provider struct {
	S3Domain        string
	BucketName      string
	AccessKeyID     string
	SecretAccessKey string
}

S3Provider is a storage provider that allows backups to be stored to an S3 compatible blobstore

func (*S3Provider) Reader 

func (s *S3Provider) Reader(path ...string) (io.ReadCloser, error)

Reader for reading from an S3 bucket

func (*S3Provider) Writer 

func (s *S3Provider) Writer(path ...string) (io.WriteCloser, error)

Writer for writing to an S3 bucket

type StorageProvider 

type StorageProvider interface {
	Reader(path ...string) (io.ReadCloser, error)
	Writer(path ...string) (io.WriteCloser, error)
}

StorageProvider is responsible for obtaining/managing a reader/writer to a storage type (eg disk/s3)

func NewDiskProvider 

func NewDiskProvider() StorageProvider

NewDiskProvider creates a new disk storage provider instance

func NewS3Provider 

func NewS3Provider(domain, key, secret, bucket string) StorageProvider

NewS3Provider creates a new instance of the S3 storage provider

type SystemDump 

type SystemDump interface {
	Error() error
	GetPersistanceBackup() (dumper PersistanceBackup, err error)
	// contains filtered or unexported methods
}

SystemDump - definition for a SystemDump interface

type SystemInfo 

type SystemInfo struct {
	goutil.GetSet
	Product       string
	Component     string
	Identity      string
	Ip            string
	User          string
	Pass          string
	VcapUser      string
	VcapPass      string
	SSHPrivateKey string
}

SystemInfo - a struct representing a base systemdump implementation

func (*SystemInfo) Error 

func (s *SystemInfo) Error() (err error)

Error - method making systeminfo implement the error interface

func (*SystemInfo) Get 

func (s *SystemInfo) Get(name string) string

Get - a getter for a systeminfo object

func (*SystemInfo) GetPersistanceBackup 

func (s *SystemInfo) GetPersistanceBackup() (dumper PersistanceBackup, err error)

GetPersistanceBackup - the constructor for a systeminfo object

func (*SystemInfo) Set 

func (s *SystemInfo) Set(name string, val string)

Set - a setter for a systeminfo object

type Tile 

type Tile interface {
	Backup() error
	Restore() error
}

Tile is a deployable component that can be backed up

type VMObject 

type VMObject struct {
	Job   string
	Index int
}

VMObject - a struct representing a vm

func ReadAndUnmarshalVMObjects 

func ReadAndUnmarshalVMObjects(src io.Reader) (jsonObj []VMObject, err error)

ReadAndUnmarshalVMObjects - read the io.reader and unmarshal its contents into an vmobject array

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.