cmd

Documentation

Index

• Constants
• func Config(argv []string) error
• func Install(argv []string, b backend.Backend) error
• func InstallPlatform(b backend.Backend) error
• func Journal(argv []string, b backend.Backend) error
• func ListUnitFiles(argv []string, b backend.Backend) error
• func ListUnits(argv []string, b backend.Backend) error
• func RefreshUnits(argv []string) error
• func Restart(argv []string, b backend.Backend) error
• func Scale(argv []string, b backend.Backend) error
• func Start(argv []string, b backend.Backend) error
• func StartPlatform(b backend.Backend) error
• func Status(argv []string, b backend.Backend) error
• func Stop(argv []string, b backend.Backend) error
• func StopPlatform(b backend.Backend) error
• func Uninstall(argv []string, b backend.Backend) error
• func UninstallPlatform(b backend.Backend) error

Constants

const (
	// PlatformCommand is shorthand for "all the Deis components."
	PlatformCommand string = "platform"
)

Functions

func Config

func Config(argv []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(argv []string, b backend.Backend) 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) error

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

func Journal

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

Journal prints log output for the specified components.

func ListUnitFiles

func ListUnitFiles(argv []string, b backend.Backend) error

ListUnitFiles prints the contents of all defined unit files.

func ListUnits

func ListUnits(argv []string, b backend.Backend) error

ListUnits prints a list of installed units.

func RefreshUnits

func RefreshUnits(argv []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(argv []string, b backend.Backend) error

Restart stops and then starts the specified components.

func Scale

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

Scale grows or shrinks the number of running components. Currently "router" is the only type that can be scaled.

func Start

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

Start activates the specified components.

func StartPlatform

func StartPlatform(b backend.Backend) error

StartPlatform activates all components.

func Status

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

Status prints the current status of components.

func Stop

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

Stop deactivates the specified components.

func StopPlatform

func StopPlatform(b backend.Backend) error

StopPlatform deactivates all components.

func Uninstall

func Uninstall(argv []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) error

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