cmd

Documentation

Index

• Constants
• Variables
• func CheckRequiredKeys(cb config.Backend) error
• func Config(target string, action string, key []string, cb config.Backend) error
• func Dock(target string, cmd []string, b backend.Backend) error
• func Install(targets []string, b backend.Backend, cb config.Backend, ...) error
• func InstallPlatform(b backend.Backend, cb config.Backend, checkKeys func(config.Backend) error, ...) error
• func Journal(targets []string, b backend.Backend) error
• func ListMachines(b backend.Backend) error
• func ListUnitFiles(b backend.Backend) error
• func ListUnits(b backend.Backend) error
• func RefreshUnits(unitDir, tag, rootURL string) error
• func Restart(targets []string, b backend.Backend) error
• func RollingRestart(target string, b backend.Backend) error
• func SSH(target string, cmd []string, b backend.Backend) error
• func Scale(targets []string, b backend.Backend) error
• func Start(targets []string, b backend.Backend) error
• func StartPlatform(b backend.Backend, stateless bool) error
• func Status(targets []string, b backend.Backend) error
• func Stop(targets []string, b backend.Backend) error
• func StopPlatform(b backend.Backend, stateless bool) error
• func Uninstall(targets []string, b backend.Backend) error
• func UninstallPlatform(b backend.Backend, stateless bool) error
• func UpgradePrep(stateless bool, b backend.Backend) error
• func UpgradeTakeover(stateless bool, b backend.Backend, cb config.Backend) error

Constants

const (
	// PlatformCommand is shorthand for "all the Deis components."
	PlatformCommand string = "platform"
	// StatelessPlatformCommand is shorthand for the components except store-* and database.
	StatelessPlatformCommand string = "stateless-platform"
	// DefaultRouterMeshSize defines the default number of routers to be loaded when installing the platform.
	DefaultRouterMeshSize uint8 = 3
)

Variables

var RouterMeshSize = DefaultRouterMeshSize

Number of routers to be installed. By default, it's DefaultRouterMeshSize.

var Stderr io.Writer = os.Stderr

Location to write standard error information. By default, this is the os.Stderr.

var Stdout io.Writer = os.Stdout

Location to write standard output. By default, this is the os.Stdout.

Functions

func CheckRequiredKeys

func CheckRequiredKeys(cb config.Backend) error

CheckRequiredKeys exist in config backend

func Config

func Config(target string, action string, key []string, cb config.Backend) error

Config gets or sets a configuration value from the cluster.

A configuration value is stored and retrieved from a key/value store at /deis/<component>/<config>. Configuration values are typically used for component-level configuration, such as enabling TLS for the routers.

func Dock

func Dock(target string, cmd []string, b backend.Backend) error

Dock connects to the appropriate host and runs 'docker exec -it'.

func Install

func Install(targets []string, b backend.Backend, cb config.Backend, checkKeys func(config.Backend) error) error

Install loads the definitions of components from local unit files. After Install, the components will be available to Start.

func InstallPlatform

func InstallPlatform(b backend.Backend, cb config.Backend, checkKeys func(config.Backend) error, stateless bool) error

InstallPlatform loads all components' definitions from local unit files. After InstallPlatform, all components will be available for StartPlatform.

func Journal

func Journal(targets []string, b backend.Backend) error

Journal prints log output for the specified components.

func ListMachines

func ListMachines(b backend.Backend) error

ListMachines prints a list of current hosts.

func ListUnitFiles

func ListUnitFiles(b backend.Backend) error

ListUnitFiles prints the contents of all defined unit files.

func ListUnits

func ListUnits(b backend.Backend) error

ListUnits prints a list of installed units.

func RefreshUnits

func RefreshUnits(unitDir, tag, rootURL string) error

RefreshUnits overwrites local unit files with those requested. Downloading from the Deis project GitHub URL by tag or SHA is the only mechanism currently supported.

func Restart

func Restart(targets []string, b backend.Backend) error

Restart stops and then starts the specified components.

func RollingRestart

func RollingRestart(target string, b backend.Backend) error

RollingRestart restart instance unit in a rolling manner

func SSH

func SSH(target string, cmd []string, b backend.Backend) error

SSH opens an interactive shell on a machine in the cluster

func Scale

func Scale(targets []string, b backend.Backend) error

Scale grows or shrinks the number of running components. Currently "router", "registry" and "store-gateway" are the only types that can be scaled.

func Start

func Start(targets []string, b backend.Backend) error

Start activates the specified components.

func StartPlatform

func StartPlatform(b backend.Backend, stateless bool) error

StartPlatform activates all components.

func Status

func Status(targets []string, b backend.Backend) error

Status prints the current status of components.

func Stop

func Stop(targets []string, b backend.Backend) error

Stop deactivates the specified components.

func StopPlatform

func StopPlatform(b backend.Backend, stateless bool) error

StopPlatform deactivates all components.

func Uninstall

func Uninstall(targets []string, b backend.Backend) error

Uninstall unloads the definitions of the specified components. After Uninstall, the components will be unavailable until Install is called.

func UninstallPlatform

func UninstallPlatform(b backend.Backend, stateless bool) error

UninstallPlatform unloads all components' definitions. After UninstallPlatform, all components will be unavailable.

func UpgradePrep

func UpgradePrep(stateless bool, b backend.Backend) error

UpgradePrep stops and uninstalls all components except router and publisher

func UpgradeTakeover

func UpgradeTakeover(stateless bool, b backend.Backend, cb config.Backend) error

UpgradeTakeover gracefully starts a platform stopped with UpgradePrep