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 ¶ added in v1.8.0
CheckRequiredKeys exist in config backend
func Config ¶
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 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 ListMachines ¶ added in v1.12.0
ListMachines prints a list of current hosts.
func ListUnitFiles ¶
ListUnitFiles prints the contents of all defined unit files.
func RefreshUnits ¶
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 RollingRestart ¶ added in v1.9.0
RollingRestart restart instance unit in a rolling manner
func Scale ¶
Scale grows or shrinks the number of running components. Currently "router", "registry" and "store-gateway" are the only types that can be scaled.
func StartPlatform ¶
StartPlatform activates all components.
func StopPlatform ¶
StopPlatform deactivates all components.
func Uninstall ¶
Uninstall unloads the definitions of the specified components. After Uninstall, the components will be unavailable until Install is called.
func UninstallPlatform ¶ added in v0.14.0
UninstallPlatform unloads all components' definitions. After UninstallPlatform, all components will be unavailable.
func UpgradePrep ¶ added in v1.9.0
UpgradePrep stops and uninstalls all components except router and publisher
Types ¶
This section is empty.
Source Files