Documentation
¶
Index ¶
- type Client
- func (c *Client) Config(argv []string) error
- func (c *Client) Dock(argv []string) error
- func (c *Client) Install(argv []string) error
- func (c *Client) Journal(argv []string) error
- func (c *Client) List(argv []string) error
- func (c *Client) Machines(argv []string) error
- func (c *Client) RefreshUnits(argv []string) error
- func (c *Client) Restart(argv []string) error
- func (c *Client) RollingRestart(argv []string) error
- func (c *Client) SSH(argv []string) error
- func (c *Client) Scale(argv []string) error
- func (c *Client) Start(argv []string) error
- func (c *Client) Status(argv []string) error
- func (c *Client) Stop(argv []string) error
- func (c *Client) Uninstall(argv []string) error
- func (c *Client) UpgradePrep(argv []string) error
- func (c *Client) UpgradeTakeover(argv []string) error
- type DeisCtlClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client uses a backend to implement the DeisCtlClient interface.
func NewClient ¶
NewClient returns a Client using the requested backend. The only backend currently supported is "fleet".
func (*Client) Config ¶
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 (*Client) Install ¶
Install loads the definitions of components from local unit files. After Install, the components will be available to Start.
func (*Client) RefreshUnits ¶
RefreshUnits overwrites local unit files with those requested.
func (*Client) RollingRestart ¶ added in v1.9.0
RollingRestart attempts a rolling restart of an instance unit
func (*Client) Uninstall ¶
Uninstall unloads the definitions of the specified components. After Uninstall, the components will be unavailable until Install is called.
func (*Client) UpgradePrep ¶ added in v1.9.0
UpgradePrep prepares a running cluster to be upgraded
func (*Client) UpgradeTakeover ¶ added in v1.9.0
UpgradeTakeover gracefully restarts a cluster prepared with upgrade-prep
type DeisCtlClient ¶
type DeisCtlClient interface {
Config(argv []string) error
Install(argv []string) error
Journal(argv []string) error
List(argv []string) error
Machines(argv []string) error
RefreshUnits(argv []string) error
Restart(argv []string) error
Scale(argv []string) error
SSH(argv []string) error
Start(argv []string) error
Status(argv []string) error
Stop(argv []string) error
Uninstall(argv []string) error
UpgradePrep(argv []string) error
UpgradeTakeover(argv []string) error
RollingRestart(argv []string) error
}
DeisCtlClient manages Deis components, configuration, and related tasks.
Source Files