cfops

package module
v1.1.2 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2015 License: Apache-2.0 Imports: 5 Imported by: 0

README

cfops wercker status GoDoc

Version Compatibility

(as of release v1.1.0+)

IAAS This utility is only designed to work for PivotalCF on VSphere

BACKUP tested and known to work for Ops Manager v1.5 tested and known to work for ER v1.5

RESTORE tested and known to work for Ops Manager v1.5 !! Partially working for ER v1.5

  • Note: Mysql automatic restore failing. (ccdb, uaadb, consoledb & nfs all working)
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:
   --tilelist, --tl 		a csv list of the tiles you would like to run the operation on [$CFOPS_TILE_LIST]
   --opsmanagerhost, --omh 	hostname for Ops Manager [$CFOPS_HOST]
   --adminuser, --du 		username for Ops Mgr admin (Ops Manager WebConsole Credentials) [$CFOPS_ADMIN_USER]
   --adminpass, --dp 		password for Ops Mgr admin (Ops Manager WebConsole Credentials) [$CFOPS_ADMIN_PASS]
   --opsmanageruser, --omu 	username for Ops Manager VM Access (used for ssh connections) [$CFOPS_OM_USER]
   --opsmanagerpass, --omp 	password for Ops Manager VM Access (used for ssh connections) [$CFOPS_OM_PASS]
   --destination, -d 		path of the Cloud Foundry backup archive [$CFOPS_BACKUP_PATH]






   
$ ./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:
   --tilelist, --tl 		a csv list of the tiles you would like to run the operation on [$CFOPS_TILE_LIST]
   --opsmanagerhost, --omh 	hostname for Ops Manager [$CFOPS_HOST]
   --adminuser, --du 		username for Ops Mgr admin (Ops Manager WebConsole Credentials) [$CFOPS_ADMIN_USER]
   --adminpass, --dp 		password for Ops Mgr admin (Ops Manager WebConsole Credentials) [$CFOPS_ADMIN_PASS]
   --opsmanageruser, --omu 	username for Ops Manager VM Access (used for ssh connections) [$CFOPS_OM_USER]
   --opsmanagerpass, --omp 	password for Ops Manager VM Access (used for ssh connections) [$CFOPS_OM_PASS]
   --destination, -d 		path of the Cloud Foundry backup archive [$CFOPS_BACKUP_PATH]

Documentation

Index

Constants

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

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

Variables

View Source 
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 SetupSupportedTiles 

func SetupSupportedTiles(fs flagSet)

Types

type Tile 

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

Source Files

View all Source files

Directories

Path Synopsis
Godeps
_workspace/src/github.com/codegangsta/cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
 Package cli provides a minimal framework for creating and organizing command line Go applications.
_workspace/src/github.com/kr/fs
Package fs provides filesystem-related functions.
 Package fs provides filesystem-related functions.
_workspace/src/github.com/onsi/ginkgo
Ginkgo is a BDD-style testing framework for Golang The godoc documentation describes Ginkgo's API.
 Ginkgo is a BDD-style testing framework for Golang The godoc documentation describes Ginkgo's API.
_workspace/src/github.com/onsi/ginkgo/config
Ginkgo accepts a number of configuration options.
 Ginkgo accepts a number of configuration options.
_workspace/src/github.com/onsi/ginkgo/extensions/table
_workspace/src/github.com/onsi/ginkgo/ginkgo
The Ginkgo CLI The Ginkgo CLI is fully documented [here](http://onsi.github.io/ginkgo/#the_ginkgo_cli) You can also learn more by running: ginkgo help Here are some of the more commonly used commands: To install: go install github.com/onsi/ginkgo/ginkgo To run tests: ginkgo To run tests in all subdirectories: ginkgo -r To run tests in particular packages: ginkgo <flags> /path/to/package /path/to/another/package To pass arguments/flags to your tests: ginkgo <flags> <packages> -- <pass-throughs> To run tests in parallel ginkgo -p this will automatically detect the optimal number of nodes to use.
 The Ginkgo CLI The Ginkgo CLI is fully documented [here](http://onsi.github.io/ginkgo/#the_ginkgo_cli) You can also learn more by running: ginkgo help Here are some of the more commonly used commands: To install: go install github.com/onsi/ginkgo/ginkgo To run tests: ginkgo To run tests in all subdirectories: ginkgo -r To run tests in particular packages: ginkgo <flags> /path/to/package /path/to/another/package To pass arguments/flags to your tests: ginkgo <flags> <packages> -- <pass-throughs> To run tests in parallel ginkgo -p this will automatically detect the optimal number of nodes to use.
_workspace/src/github.com/onsi/ginkgo/ginkgo/convert
_workspace/src/github.com/onsi/ginkgo/ginkgo/interrupthandler
_workspace/src/github.com/onsi/ginkgo/ginkgo/nodot
_workspace/src/github.com/onsi/ginkgo/ginkgo/testrunner
_workspace/src/github.com/onsi/ginkgo/ginkgo/testsuite
_workspace/src/github.com/onsi/ginkgo/ginkgo/watch
_workspace/src/github.com/onsi/ginkgo/integration
_workspace/src/github.com/onsi/ginkgo/internal/codelocation
_workspace/src/github.com/onsi/ginkgo/internal/containernode
_workspace/src/github.com/onsi/ginkgo/internal/failer
_workspace/src/github.com/onsi/ginkgo/internal/leafnodes
_workspace/src/github.com/onsi/ginkgo/internal/remote
Aggregator is a reporter used by the Ginkgo CLI to aggregate and present parallel test output coherently as tests complete.
 Aggregator is a reporter used by the Ginkgo CLI to aggregate and present parallel test output coherently as tests complete.
_workspace/src/github.com/onsi/ginkgo/internal/spec
_workspace/src/github.com/onsi/ginkgo/internal/specrunner
_workspace/src/github.com/onsi/ginkgo/internal/suite
_workspace/src/github.com/onsi/ginkgo/internal/testingtproxy
_workspace/src/github.com/onsi/ginkgo/internal/writer
_workspace/src/github.com/onsi/ginkgo/reporters
Ginkgo's Default Reporter A number of command line flags are available to tweak Ginkgo's default output.
 Ginkgo's Default Reporter A number of command line flags are available to tweak Ginkgo's default output.
_workspace/src/github.com/onsi/ginkgo/reporters/stenographer
_workspace/src/github.com/onsi/ginkgo/types
_workspace/src/github.com/onsi/gomega
Gomega is the Ginkgo BDD-style testing framework's preferred matcher library.
 Gomega is the Ginkgo BDD-style testing framework's preferred matcher library.
_workspace/src/github.com/onsi/gomega/format
Gomega's format package pretty-prints objects.
 Gomega's format package pretty-prints objects.
_workspace/src/github.com/onsi/gomega/gbytes
Package gbytes provides a buffer that supports incrementally detecting input.
 Package gbytes provides a buffer that supports incrementally detecting input.
_workspace/src/github.com/onsi/gomega/gexec
Package gexec provides support for testing external processes.
 Package gexec provides support for testing external processes.
_workspace/src/github.com/onsi/gomega/ghttp
Package ghttp supports testing HTTP clients by providing a test server (simply a thin wrapper around httptest's server) that supports registering multiple handlers.
 Package ghttp supports testing HTTP clients by providing a test server (simply a thin wrapper around httptest's server) that supports registering multiple handlers.
_workspace/src/github.com/onsi/gomega/ghttp/protobuf
Package protobuf is a generated protocol buffer package.
 Package protobuf is a generated protocol buffer package.
_workspace/src/github.com/onsi/gomega/internal/assertion
_workspace/src/github.com/onsi/gomega/internal/asyncassertion
_workspace/src/github.com/onsi/gomega/internal/fakematcher
_workspace/src/github.com/onsi/gomega/internal/oraclematcher
_workspace/src/github.com/onsi/gomega/internal/testingtsupport
_workspace/src/github.com/onsi/gomega/matchers
Gomega matchers This package implements the Gomega matchers and does not typically need to be imported.
 Gomega matchers This package implements the Gomega matchers and does not typically need to be imported.
_workspace/src/github.com/onsi/gomega/matchers/support/goraph/bipartitegraph
_workspace/src/github.com/onsi/gomega/matchers/support/goraph/edge
_workspace/src/github.com/onsi/gomega/matchers/support/goraph/node
_workspace/src/github.com/onsi/gomega/matchers/support/goraph/util
_workspace/src/github.com/onsi/gomega/types
_workspace/src/github.com/op/go-logging
Package logging implements a logging infrastructure for Go.
 Package logging implements a logging infrastructure for Go.
_workspace/src/github.com/op/go-logging/examples
_workspace/src/github.com/pivotal-golang/lager
_workspace/src/github.com/pivotal-golang/lager/chug
_workspace/src/github.com/pivotal-golang/lager/ginkgoreporter
_workspace/src/github.com/pivotal-golang/lager/lagertest
_workspace/src/github.com/pivotalservices/cfbackup
_workspace/src/github.com/pivotalservices/gtils/bosh
_workspace/src/github.com/pivotalservices/gtils/command
_workspace/src/github.com/pivotalservices/gtils/http
_workspace/src/github.com/pivotalservices/gtils/http/httptest
_workspace/src/github.com/pivotalservices/gtils/log
_workspace/src/github.com/pivotalservices/gtils/osutils
_workspace/src/github.com/pivotalservices/gtils/persistence
_workspace/src/github.com/pkg/sftp
Package sftp implements the SSH File Transfer Protocol as described in https://filezilla-project.org/specs/draft-ietf-secsh-filexfer-02.txt
 Package sftp implements the SSH File Transfer Protocol as described in https://filezilla-project.org/specs/draft-ietf-secsh-filexfer-02.txt
_workspace/src/github.com/pkg/sftp/examples/buffered-read-benchmark
buffered-read-benchmark benchmarks the peformance of reading from /dev/zero on the server to a []byte on the client via io.Copy.
 buffered-read-benchmark benchmarks the peformance of reading from /dev/zero on the server to a []byte on the client via io.Copy.
_workspace/src/github.com/pkg/sftp/examples/buffered-write-benchmark
buffered-write-benchmark benchmarks the peformance of writing a single large []byte on the client to /dev/null on the server via io.Copy.
 buffered-write-benchmark benchmarks the peformance of writing a single large []byte on the client to /dev/null on the server via io.Copy.
_workspace/src/github.com/pkg/sftp/examples/streaming-read-benchmark
streaming-read-benchmark benchmarks the peformance of reading from /dev/zero on the server to /dev/null on the client via io.Copy.
 streaming-read-benchmark benchmarks the peformance of reading from /dev/zero on the server to /dev/null on the client via io.Copy.
_workspace/src/github.com/pkg/sftp/examples/streaming-write-benchmark
streaming-write-benchmark benchmarks the peformance of writing from /dev/zero on the client to /dev/null on the server via io.Copy.
 streaming-write-benchmark benchmarks the peformance of writing from /dev/zero on the client to /dev/null on the server via io.Copy.
_workspace/src/github.com/pkg/sftp/server_standalone
_workspace/src/github.com/xchapter7x/goutil
_workspace/src/github.com/xchapter7x/goutil/itertools
_workspace/src/github.com/xchapter7x/goutil/samples
_workspace/src/github.com/xchapter7x/lo
_workspace/src/golang.org/x/crypto/ssh
Package ssh implements an SSH client and server.
 Package ssh implements an SSH client and server.
_workspace/src/golang.org/x/crypto/ssh/agent
Package agent implements a client to an ssh-agent daemon.
 Package agent implements a client to an ssh-agent daemon.
_workspace/src/golang.org/x/crypto/ssh/terminal
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
 Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
_workspace/src/golang.org/x/crypto/ssh/test
This package contains integration tests for the code.google.com/p/go.crypto/ssh package.
 This package contains integration tests for the code.google.com/p/go.crypto/ssh package.
_workspace/src/gopkg.in/yaml.v1
Package yaml implements YAML support for the Go language.
 Package yaml implements YAML support for the Go language.
cmd
cfops

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.