ssh

Documentation

Index

• type Config
• type Driver
  • func NewDriver(c Config) *Driver
  • func (d *Driver) Create() error
  • func (d *Driver) DriverName() string
  • func (d *Driver) GetSSHHostname() (string, error)
  • func (d *Driver) GetSSHKeyPath() string
  • func (d *Driver) GetSSHUsername() string
  • func (d *Driver) GetState() (state.State, error)
  • func (d *Driver) GetURL() (string, error)
  • func (d *Driver) Kill() error
  • func (d *Driver) PreCreateCheck() error
  • func (d *Driver) Remove() error
  • func (d *Driver) Restart() error
  • func (d *Driver) Start() error
  • func (d *Driver) Stop() error

Types

type Config

type Config struct {
	MachineName      string
	StorePath        string
	ContainerRuntime string
}

Config is configuration for the SSH driver

type Driver

type Driver struct {
	*drivers.BaseDriver
	*pkgdrivers.CommonDriver
	EnginePort int
	SSHKey     string
	// contains filtered or unexported fields
}

Driver is a driver designed to run kubeadm w/o VM management. https://minikube.sigs.k8s.io/docs/reference/drivers/ssh/

func NewDriver

func NewDriver(c Config) *Driver

NewDriver creates and returns a new instance of the driver

func (*Driver) Create

func (d *Driver) Create() error

Create a host using the driver's config

func (*Driver) DriverName

func (d *Driver) DriverName() string

DriverName returns the name of the driver

func (*Driver) GetSSHHostname

func (d *Driver) GetSSHHostname() (string, error)

GetSSHHostname returns hostname for use with ssh

func (*Driver) GetSSHKeyPath

func (d *Driver) GetSSHKeyPath() string

GetSSHKeyPath returns the key path for SSH

func (*Driver) GetSSHUsername

func (d *Driver) GetSSHUsername() string

GetSSHUsername returns username for use with ssh

func (*Driver) GetState

func (d *Driver) GetState() (state.State, error)

GetState returns the state that the host is in (running, stopped, etc)

func (*Driver) GetURL

func (d *Driver) GetURL() (string, error)

GetURL returns a Docker URL inside this host

func (*Driver) Kill

func (d *Driver) Kill() error

Kill stops a host forcefully, including any containers that we are managing.

func (*Driver) PreCreateCheck

func (d *Driver) PreCreateCheck() error

PreCreateCheck checks for correct privileges and dependencies

func (*Driver) Remove

func (d *Driver) Remove() error

Remove a host, including any data which may have been written by it.

func (*Driver) Restart

func (d *Driver) Restart() error

Restart a host

func (*Driver) Start

func (d *Driver) Start() error

Start a host

func (*Driver) Stop

func (d *Driver) Stop() error

Stop a host gracefully, including any containers that we are managing.