ssh

Documentation

Overview

Package ssh transports etcd traffic over SSH to provide a special World API.

Index

• type World
  • func (obj *World) Cleanup() error
  • func (obj *World) Connect(ctx context.Context, init *engine.WorldInit) error

Types

type World

type World struct {
	// URL is the ssh server to connect to. Use the format, james@server:22
	// or similar. From there, we connect to each of the etcd Seeds, so the
	// ip's should be relative to this server. If you pass in a ?hostkey=
	// query string parameter, you can specify a base64, known_hosts key to
	// use for confirmation that you're connecting to the right host.
	// Without this, it will look in your ~/.ssh/known_hosts file which may
	// not necessarily exist yet, and without it connection is impossible.
	// You can find the key by running the ssh-keyscan command. It can also
	// be read from the HostKey parameter, which avoids you needing to
	// urlencode it here.
	URL string

	// HostKey is the key part (which is already base64 encoded) from a
	// known_hosts file, representing the host we're connecting to. If this
	// is specified, then it overrides looking for it in the URL.
	HostKey string

	// SSHID is the path to the ~/.ssh/id_??? key to use for auth. If you
	// omit this then this will look for your private key in all possible
	// paths. If you specific a specific path, then only that will be used.
	// This will expand the ~/ and ~user/ style path expansions.
	SSHID string

	// Seeds are the list of etcd endpoints to connect to.
	Seeds []string

	// NS is the etcd namespace to use.
	NS string

	MetadataPrefix string    // expected metadata prefix
	StoragePrefix  string    // storage prefix for etcdfs storage
	StandaloneFs   engine.Fs // store an fs here for local usage
	GetURI         func() string

	*etcd.World
	// contains filtered or unexported fields
}

World is an implementation of the world API for etcd over SSH.

func (*World) Cleanup

func (obj *World) Cleanup() error

Cleanup runs last.

func (*World) Connect

func (obj *World) Connect(ctx context.Context, init *engine.WorldInit) error

Connect runs first.