platform

Documentation

Index

• func CheckMachine(m Machine) error
• func EnableSelinux(m Machine) error
• func InstallFile(in io.Reader, m Machine, to string) error
• func Manhole(m Machine) error
• func ReadFile(m Machine, path string) (io.ReadCloser, error)
• func RebootMachine(m Machine, j *Journal) error
• func StartMachine(m Machine, j *Journal) error
• func StartReboot(m Machine) error
• func TransferFile(src Machine, srcPath string, dst Machine, dstPath string) error
• type BaseCluster
  • func NewBaseCluster(basename string, rconf *RuntimeConfig, platform Name, ctPlatform string) (*BaseCluster, error)
  • func NewBaseClusterWithDialer(basename string, rconf *RuntimeConfig, platform Name, ctPlatform string, ...) (*BaseCluster, error)
  • func (bc *BaseCluster) AddMach(m Machine)
  • func (bc *BaseCluster) ConsoleOutput() map[string]string
  • func (bc *BaseCluster) DelMach(m Machine)
  • func (bc *BaseCluster) Destroy()
  • func (bc *BaseCluster) GetDiscoveryURL(size int) (string, error)
  • func (bc *BaseCluster) Keys() ([]*agent.Key, error)
  • func (bc *BaseCluster) Machines() []Machine
  • func (bc *BaseCluster) Name() string
  • func (bc *BaseCluster) PasswordSSHClient(ip string, user string, password string) (*ssh.Client, error)
  • func (bc *BaseCluster) Platform() Name
  • func (bc *BaseCluster) RenderUserData(userdata *conf.UserData, ignitionVars map[string]string) (*conf.Conf, error)
  • func (bc *BaseCluster) RuntimeConf() RuntimeConfig
  • func (bc *BaseCluster) SSH(m Machine, cmd string) ([]byte, []byte, error)
  • func (bc *BaseCluster) SSHClient(ip string) (*ssh.Client, error)
  • func (bc *BaseCluster) UserSSHClient(ip, user string) (*ssh.Client, error)
• type Cluster
• type Journal
  • func NewJournal(dir string) (*Journal, error)
  • func (j *Journal) Destroy()
  • func (j *Journal) Start(ctx context.Context, m Machine) error
• type Machine
  • func NewMachines(c Cluster, userdata *conf.UserData, n int) ([]Machine, error)
• type Name
• type Options
• type RuntimeConfig

Functions

func CheckMachine

func CheckMachine(m Machine) error

CheckMachine tests a machine for various error conditions such as ssh being available and no systemd units failing at the time ssh is reachable. It also ensures the remote system is running Container Linux by CoreOS.

TODO(mischief): better error messages.

func EnableSelinux

func EnableSelinux(m Machine) error

Enable SELinux on a machine (skip on machines without SELinux support)

func InstallFile

func InstallFile(in io.Reader, m Machine, to string) error

InstallFile copies data from in to the path to on m.

func Manhole

func Manhole(m Machine) error

Manhole connects os.Stdin, os.Stdout, and os.Stderr to an interactive shell session on the Machine m. Manhole blocks until the shell session has ended. If os.Stdin does not refer to a TTY, Manhole returns immediately with a nil error.

func ReadFile

func ReadFile(m Machine, path string) (io.ReadCloser, error)

ReadFile returns a io.ReadCloser that streams the requested file. The caller should close the reader when finished.

func RebootMachine

func RebootMachine(m Machine, j *Journal) error

RebootMachine will reboot a given machine, provided the machine's journal.

func StartMachine

func StartMachine(m Machine, j *Journal) error

StartMachine will start a given machine, provided the machine's journal.

func StartReboot

func StartReboot(m Machine) error

Reboots a machine, stopping ssh first. Afterwards run CheckMachine to verify the system is back and operational.

func TransferFile

func TransferFile(src Machine, srcPath string, dst Machine, dstPath string) error

Copy a file between two machines in a cluster.

Types

type BaseCluster

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

func NewBaseCluster

func NewBaseCluster(basename string, rconf *RuntimeConfig, platform Name, ctPlatform string) (*BaseCluster, error)

func NewBaseClusterWithDialer

func NewBaseClusterWithDialer(basename string, rconf *RuntimeConfig, platform Name, ctPlatform string, dialer network.Dialer) (*BaseCluster, error)

func (*BaseCluster) AddMach

func (bc *BaseCluster) AddMach(m Machine)

func (*BaseCluster) ConsoleOutput

func (bc *BaseCluster) ConsoleOutput() map[string]string

func (*BaseCluster) DelMach

func (bc *BaseCluster) DelMach(m Machine)

func (*BaseCluster) Destroy

func (bc *BaseCluster) Destroy()

Destroy destroys each machine in the cluster and closes the SSH agent.

func (*BaseCluster) GetDiscoveryURL

func (bc *BaseCluster) GetDiscoveryURL(size int) (string, error)

XXX(mischief): i don't really think this belongs here, but it completes the interface we've established.

func (*BaseCluster) Keys

func (bc *BaseCluster) Keys() ([]*agent.Key, error)

func (*BaseCluster) Machines

func (bc *BaseCluster) Machines() []Machine

func (*BaseCluster) Name

func (bc *BaseCluster) Name() string

func (*BaseCluster) PasswordSSHClient

func (bc *BaseCluster) PasswordSSHClient(ip string, user string, password string) (*ssh.Client, error)

func (*BaseCluster) Platform

func (bc *BaseCluster) Platform() Name

func (*BaseCluster) RenderUserData

func (bc *BaseCluster) RenderUserData(userdata *conf.UserData, ignitionVars map[string]string) (*conf.Conf, error)

func (*BaseCluster) RuntimeConf

func (bc *BaseCluster) RuntimeConf() RuntimeConfig

func (*BaseCluster) SSH

func (bc *BaseCluster) SSH(m Machine, cmd string) ([]byte, []byte, error)

SSH executes the given command, cmd, on the given Machine, m. It returns the stdout and stderr of the command and an error. Leading and trailing whitespace is trimmed from each.

func (*BaseCluster) SSHClient

func (bc *BaseCluster) SSHClient(ip string) (*ssh.Client, error)

func (*BaseCluster) UserSSHClient

func (bc *BaseCluster) UserSSHClient(ip, user string) (*ssh.Client, error)

type Cluster

type Cluster interface {
	// Platform returns the name of the platform.
	Platform() Name

	// NewMachine creates a new Container Linux machine.
	NewMachine(userdata *conf.UserData) (Machine, error)

	// Machines returns a slice of the active machines in the Cluster.
	Machines() []Machine

	// GetDiscoveryURL returns a new etcd discovery URL.
	GetDiscoveryURL(size int) (string, error)

	// Destroy terminates each machine in the cluster and frees any other
	// associated resources. It should log any failures; since they are not
	// actionable, it does not return an error
	Destroy()

	// ConsoleOutput returns a map of console output from destroyed
	// cluster machines.
	ConsoleOutput() map[string]string
}

Cluster represents a cluster of Container Linux machines within a single platform.

type Journal

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

Journal manages recording the journal of a Machine.

func NewJournal

func NewJournal(dir string) (*Journal, error)

NewJournal creates a Journal recorder that will log to "journal.txt" and "journal-raw.txt.gz" inside the given output directory.

func (*Journal) Destroy

func (j *Journal) Destroy()

func (*Journal) Start

func (j *Journal) Start(ctx context.Context, m Machine) error

Start begins/resumes streaming the system journal to journal.txt.

type Machine

type Machine interface {
	// ID returns the plaform-specific machine identifier.
	ID() string

	// IP returns the machine's public IP.
	IP() string

	// PrivateIP returns the machine's private IP.
	PrivateIP() string

	// RuntimeConf returns the cluster's runtime configuration.
	RuntimeConf() RuntimeConfig

	// SSHClient establishes a new SSH connection to the machine.
	SSHClient() (*ssh.Client, error)

	// PasswordSSHClient establishes a new SSH connection using the provided credentials.
	PasswordSSHClient(user string, password string) (*ssh.Client, error)

	// SSH runs a single command over a new SSH connection.
	SSH(cmd string) ([]byte, []byte, error)

	// Reboot restarts the machine and waits for it to come back.
	Reboot() error

	// Destroy terminates the machine and frees associated resources. It should log
	// any failures; since they are not actionable, it does not return an error.
	Destroy()

	// ConsoleOutput returns the machine's console output if available,
	// or an empty string.  Only expected to be valid after Destroy().
	ConsoleOutput() string
}

Machine represents a Container Linux instance.

func NewMachines

func NewMachines(c Cluster, userdata *conf.UserData, n int) ([]Machine, error)

NewMachines spawns n instances in cluster c, with each instance passed the same userdata.

type Name

type Name string

Name is a unique identifier for a platform.

type Options

type Options struct {
	BaseName string
}

Options contains the base options for all clusters.

type RuntimeConfig

type RuntimeConfig struct {
	OutputDir string

	NoSSHKeyInUserData bool // don't inject SSH key into Ignition/cloud-config
	NoSSHKeyInMetadata bool // don't add SSH key to platform metadata
	NoEnableSelinux    bool // don't enable selinux when starting or rebooting a machine
	AllowFailedUnits   bool // don't fail CheckMachine if a systemd unit has failed
}

RuntimeConfig contains cluster-specific configuration.