engine

Documentation

Index

• type Konnect
  • func Init(filename string) (*Konnect, error)
  • func New() *Konnect
  • func (k *Konnect) CheckHosts(hosts []string) error
  • func (k *Konnect) GetHost(name string) (*proxy.SSHProxy, error)
  • func (k *Konnect) GetHostNames() []string
  • func (k *Konnect) GetTask(name string) (*task.SSHTask, error)
  • func (k *Konnect) GetTaskNames() []string
  • func (k *Konnect) LoadFromFile(filename string) error
  • func (k *Konnect) MarshalHosts() ([]byte, error)
  • func (k *Konnect) MarshalTasks() ([]byte, error)
  • func (k *Konnect) Status(hosts []string)
  • func (k *Konnect) TestConnection(host string)
  • func (k *Konnect) UnmarshalGlobal(byteStr []byte) error
  • func (k *Konnect) UnmarshalHosts(byteStr []byte) error
  • func (k *Konnect) UnmarshalTasks(byteStr []byte) error

Types

type Konnect

type Konnect struct {
	Global        *proxy.SSHProxy `yaml:"-"`
	ProxyChan     chan bool       `yaml:"-"`
	CompletedChan chan bool       `yaml:"-"`
	Hosts         map[string]*proxy.SSHProxy
	Tasks         map[string]*task.SSHTask
}

Konnect is a collection of SSHProxy objects.

func Init

func Init(filename string) (*Konnect, error)

Init - Create a new Konnect object.

func New

func New() *Konnect

New - Create a new Konnect object.

func (*Konnect) CheckHosts

func (k *Konnect) CheckHosts(hosts []string) error

CheckHosts - Ensure that the given host names exist.

func (*Konnect) GetHost

func (k *Konnect) GetHost(name string) (*proxy.SSHProxy, error)

GetHost - Get an SSHProxy object by name.

func (*Konnect) GetHostNames

func (k *Konnect) GetHostNames() []string

GetHostNames - Get host names in sorted order (asc).

func (*Konnect) GetTask

func (k *Konnect) GetTask(name string) (*task.SSHTask, error)

GetTask - Get an SSHTask object by name.

func (*Konnect) GetTaskNames

func (k *Konnect) GetTaskNames() []string

GetTaskNames - Get task names in sorted order (asc).

func (*Konnect) LoadFromFile

func (k *Konnect) LoadFromFile(filename string) error

LoadFromFile - Load and validate SSHProxy objects from a yaml config file.

func (*Konnect) MarshalHosts

func (k *Konnect) MarshalHosts() ([]byte, error)

MarshalHosts - Marshal SSHProxy objects to a byte string.

func (*Konnect) MarshalTasks

func (k *Konnect) MarshalTasks() ([]byte, error)

MarshalTasks - Marshal SSHTask objects to a byte string.

func (*Konnect) Status

func (k *Konnect) Status(hosts []string)

Status - Check the status of one or more hosts.

func (*Konnect) TestConnection

func (k *Konnect) TestConnection(host string)

TestConnection - Test proxy ssh connection.

func (*Konnect) UnmarshalGlobal

func (k *Konnect) UnmarshalGlobal(byteStr []byte) error

UnmarshalGlobal - Unmarshal global proxy config from a byte string.

func (*Konnect) UnmarshalHosts

func (k *Konnect) UnmarshalHosts(byteStr []byte) error

UnmarshalHosts - Unmarshal SSHProxy objects from a byte string.

func (*Konnect) UnmarshalTasks

func (k *Konnect) UnmarshalTasks(byteStr []byte) error

UnmarshalTasks - Unmarshal SSHTask objects from a byte string.