tunnel

Documentation

Index

• Variables
• func Deboard(hostname string, conf Config) error
• func Onboard(hostname string, conf Config) error
• type Config

Variables

var InvalidConfigError = errors.New("tunnel: invalid config")

Functions

func Deboard

func Deboard(hostname string, conf Config) error

func Onboard

func Onboard(
	hostname string,
	conf Config,
) error

Onboard will copy over and start the satellite on a remote machine, via SSH.

- hostname must be an amd64 linux system - conf.User@hostname must have permissions to ssh, when signed in with signer - conf.User must have permissions to dataDir - conf.DataDir must be machine-local (IE not on NFS) - conf.HostKeyCallback will be used to verify the identity of the remote

Types

type Config

type Config struct {
	// The login to run the satellite on other machines as
	User string
	// The directory to store the satellite binary on remotes as
	DataDirTemplate string
	// The configuration to install on the remote.
	RemoteConf config.SatelliteConfiguration

	// SSH Options.
	Signer      ssh.Signer
	KeyCallback ssh.HostKeyCallback
}