octopus

Documentation

Overview

Package octopus defines an octopus config struct, and a method to run the octopus command defined with the configs provided.

Index

• type Octopus
  • func New(c remote.Connector, hostGroups []string, groupsFile string) *Octopus
  • func (o *Octopus) Do(action remote.Action) (numHostErrors int, err error)
• type Result
  • func (r *Result) Print()

Types

type Octopus

type Octopus struct {
	// contains filtered or unexported fields
}

Octopus is a metaphorical octopus which can run commands on remote hosts in parallel with its many arms.

func New

func New(c remote.Connector, hostGroups []string, groupsFile string) *Octopus

New finds an octopus and trains it about how its environment is configured and what host groups it should operate on.

func (*Octopus) Do

func (o *Octopus) Do(action remote.Action) (numHostErrors int, err error)

Do sends out tentacles to all hosts in the host group(s) in individual goroutines and collects the results of all the tentacles at the end. Returns the number of hosts that report errors if the tentacles are able to be sent out.

type Result

type Result struct {
	Hostname string
	Stdout   *bytes.Buffer
	Stderr   *bytes.Buffer
	Err      error
}

Result is the result of an action. The result includes the hostname of the target to better help the user identify in human-readable format which host the result is from. The result also includes information needed to report success and failure conditions.

func (*Result) Print

func (r *Result) Print()

Print outputs a result in a nice human readable format, printing main output to stdout and error output to stderr.