client

Documentation

Index

• type Client
  • func NewClient(requestedBackend string) (*Client, error)
  • 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) 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

Types

type Client

type Client struct {
	Backend backend.Backend
	// contains filtered or unexported fields
}

Client uses a backend to implement the DeisCtlClient interface.

func NewClient

func NewClient(requestedBackend string) (*Client, error)

NewClient returns a Client using the requested backend. The only backend currently supported is "fleet".

func (*Client) Config

func (c *Client) 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 (*Client) Dock

func (c *Client) Dock(argv []string) error

func (*Client) Install

func (c *Client) Install(argv []string) error

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

func (*Client) Journal

func (c *Client) Journal(argv []string) error

Journal prints log output for the specified components.

func (*Client) List

func (c *Client) List(argv []string) error

List prints a summary of installed components.

func (*Client) RefreshUnits

func (c *Client) RefreshUnits(argv []string) error

RefreshUnits overwrites local unit files with those requested.

func (*Client) Restart

func (c *Client) Restart(argv []string) error

Restart stops and then starts components.

func (*Client) RollingRestart

func (c *Client) RollingRestart(argv []string) error

RollingRestart attempts a rolling restart of an instance unit

func (*Client) SSH

func (c *Client) SSH(argv []string) error

SSH opens an interactive shell with a machine in the cluster.

func (*Client) Scale

func (c *Client) Scale(argv []string) error

Scale grows or shrinks the number of running components.

func (*Client) Start

func (c *Client) Start(argv []string) error

Start activates the specified components.

func (*Client) Status

func (c *Client) Status(argv []string) error

Status prints the current status of components.

func (*Client) Stop

func (c *Client) Stop(argv []string) error

Stop deactivates the specified components.

func (*Client) Uninstall

func (c *Client) Uninstall(argv []string) error

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

func (*Client) UpgradePrep

func (c *Client) UpgradePrep(argv []string) error

UpgradePrep prepares a running cluster to be upgraded

func (*Client) UpgradeTakeover

func (c *Client) UpgradeTakeover(argv []string) error

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
	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.