cmd

Documentation

Index

• Constants
• func CheckRequiredKeys() error
• func Config(target string, action string, key []string) error
• func Install(targets []string, b backend.Backend, checkKeys func() error) error
• func InstallPlatform(b backend.Backend, checkKeys func() error, stateless bool) error
• func InstallSwarm(b backend.Backend) error
• func Journal(targets []string, b backend.Backend) error
• func ListUnitFiles(b backend.Backend) error
• func ListUnits(b backend.Backend) error
• func RefreshUnits(dir, tag, url string) error
• func Restart(targets []string, b backend.Backend) error
• func SSH(target 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 StartSwarm(b backend.Backend) 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 StopSwarm(b backend.Backend) error
• func UnInstallSwarm(b backend.Backend) error
• func Uninstall(targets []string, b backend.Backend) error
• func UninstallPlatform(b backend.Backend, stateless bool) error

Constants

const (
	// PlatformCommand is shorthand for "all the Deis components."
	PlatformCommand string = "platform"
	// StatelessPlatformCommand is shorthand for the components except store-*, database, and logger.
	StatelessPlatformCommand string = "stateless-platform"
)

Functions

func CheckRequiredKeys

func CheckRequiredKeys() error

CheckRequiredKeys exist in etcd

func Config

func Config(target string, action string, key []string) error

Config gets or sets a configuration value from the cluster.

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

func Install

func Install(targets []string, b backend.Backend, checkKeys func() 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, checkKeys func() error, stateless bool) error

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

func InstallSwarm

func InstallSwarm(b backend.Backend) error

InstallSwarm Installs swarm

func Journal

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

Journal prints log output for the specified components.

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(dir, tag, url 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 SSH

func SSH(target 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 StartSwarm

func StartSwarm(b backend.Backend) error

StartSwarm starts Swarm Schduler

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 StopSwarm

func StopSwarm(b backend.Backend) error

StopSwarm stops swarm

func UnInstallSwarm

func UnInstallSwarm(b backend.Backend) error

UnInstallSwarm uninstall Swarm

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.