cfops

README

cfops

Version Compatibility

(as of release v1.0.0+)

This is tested and known to work for Ops Manager v1.5

This is tested and known to work for ER v1.5

(!!! NOTE: Automated restore not working for ER 1.5 !!!)

Overview

This is simply an automation that is based on the supported way to back up Pivotal Cloud Foundry (http://docs.pivotal.io/pivotalcf/customizing/backup-settings.html).

It may be extended in the future to support greater breadth of functionality.

Install

Download the latest version here: https://github.com/pivotalservices/cfops/releases

Contributing

PRs welcome.

Usage

For example you can try the various commands, args and flags (and --help documentation) that are currently proposed, such as:

$ ./cfops -help

$ ./cfops backup

$ ./cfops restore

etc.

Sample help output:

$ ./cfops help backup
NAME:
   backup - backup --opsmanagerhost <host> --adminuser <usr> --adminpass <pass> --opsmanageruser <opsuser> --opsmanagerpass <opspass> -d <dir> --tl 'opsmanager, er'

USAGE:
   command backup [command options] [arguments...]

DESCRIPTION:
   backup a Cloud Foundry deployment, including Ops Manager configuration, databases, and blob store

OPTIONS:
   --adminuser, --du 		username for Ops Mgr admin VM
   --adminpass, --dp 		password for Ops Mgr admin VM
   --opsmanageruser, --omu 	username for Ops Manager
   --opsmanagerpass, --omp 	password for Ops Manager
   --destination, -d 		admin of the Cloud Foundry backup archive
   --tilelist, --tl 		a csv list of the tiles you would like to run the operation on
   --opsmanagerhost, --omh 	hostname for Ops Manager






   
$ ./cfops help restore
NAME:
   restore - restore --opsmanagerhost <host> --adminuser <usr> --adminpass <pass> --opsmanageruser <opsuser> --opsmanagerpass <opspass> -d <dir> --tl 'opsmanager, er'

USAGE:
   command restore [command options] [arguments...]

DESCRIPTION:
   Restore a Cloud Foundry deployment, including Ops Manager configuration, databases, and blob store

OPTIONS:
   --opsmanagerhost, --omh 	hostname for Ops Manager
   --adminuser, --du 		username for Ops Mgr admin VM
   --adminpass, --dp 		password for Ops Mgr admin VM
   --opsmanageruser, --omu 	username for Ops Manager
   --opsmanagerpass, --omp 	password for Ops Manager
   --destination, -d 		admin of the Cloud Foundry backup archive
   --tilelist, --tl 		a csv list of the tiles you would like to run the operation on

Documentation

Index

• Constants
• Variables
• func ErrUnsupportedTile(errString string) error
• func RunPipeline(fs flagSet, action string) (err error)
• func SetLogger(logger log.Logger)
• func SetupSupportedTiles(fs flagSet)
• type Tile

Constants

const (
	ErrUnsupportedTileFormat = "you have a unsupported tile in your list: %s"

	Restore = "restore"
	Backup  = "backup"
	OpsMgr  = "OPSMANAGER"
	ER      = "ER"
)

Variables

var (
	BuiltinPipelineExecution = map[string]func(string, string, string, string, string, string) error{
		Restore: cfbackup.RunRestorePipeline,
		Backup:  cfbackup.RunBackupPipeline,
	}
	SupportedTiles map[string]func() (Tile, error)
)

Functions

func ErrUnsupportedTile

func ErrUnsupportedTile(errString string) error

func RunPipeline

func RunPipeline(fs flagSet, action string) (err error)

func SetLogger

func SetLogger(logger log.Logger)

func SetupSupportedTiles

func SetupSupportedTiles(fs flagSet)

Types

type Tile

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