hosts

Documentation

Index

• type Config
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Host
  • func (h *Host) Connect() error
  • func (h *Host) CopyFile(file os.File, remotePath string, permissions string) error
  • func (h *Host) Disconnect() error
  • func (h *Host) Exec(cmd string) error
  • func (h *Host) ExecWithOutput(cmd string) (string, error)
  • func (h *Host) FullAddress() string
• type HostMetadata
• type Hosts
• type RemoteHost

Types

type Config

type Config struct {
	Address          string   `yaml:"address" validate:"required,hostname|ip"`
	User             string   `yaml:"user"`
	SSHPort          int      `yaml:"sshPort" validate:"gt=0,lte=65535"`
	SSHKeyPath       string   `yaml:"sshKeyPath" validate:"file"`
	Role             string   `yaml:"role" validate:"oneof=master worker"`
	ExtraArgs        []string `yaml:"extraArgs"`
	PrivateInterface string   `validate:"omitempty,gt=2"`
}

Config for host

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals yaml

type Host

type Host struct {
	Config

	Metadata *HostMetadata
	// contains filtered or unexported fields
}

Host describes connectable host

func (*Host) Connect

func (h *Host) Connect() error

Connect to the host

func (*Host) CopyFile

func (h *Host) CopyFile(file os.File, remotePath string, permissions string) error

CopyFile copies a local file to host

func (*Host) Disconnect

func (h *Host) Disconnect() error

Disconnect from the host

func (*Host) Exec

func (h *Host) Exec(cmd string) error

Exec a command on the host

func (*Host) ExecWithOutput

func (h *Host) ExecWithOutput(cmd string) (string, error)

ExecWithOutput execs a command on the host and return output

func (*Host) FullAddress

func (h *Host) FullAddress() string

FullAddress returns address and non-standard ssh port

type HostMetadata

type HostMetadata struct {
	Hostname        string
	InternalAddress string
}

HostMetadata resolved metadata for host

type Hosts

type Hosts []*Host

Hosts array of hosts

type RemoteHost

type RemoteHost interface {
	Connect() error
	Disconnect() error
}