ssh

Documentation

Overview

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Index

• type SSH
  • func New(tarmak interfaces.Tarmak) *SSH
  • func (s *SSH) Cleanup()
  • func (s *SSH) Execute(host string, cmd []string, stdin io.Reader, stdout, stderr io.Writer) (int, error)
  • func (s *SSH) PassThrough(argsAdditional []string) error
  • func (s *SSH) Tunnel(dest, destPort, localPort string, daemonize bool) interfaces.Tunnel
  • func (s *SSH) Validate() error
  • func (s *SSH) WriteConfig(c interfaces.Cluster) error
• type Tunnel
  • func (t *Tunnel) BindAddress() string
  • func (t *Tunnel) Done() <-chan struct{}
  • func (t *Tunnel) Port() string
  • func (t *Tunnel) Start() error
  • func (t *Tunnel) Stop()

Types

type SSH

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

func New

func New(tarmak interfaces.Tarmak) *SSH

func (*SSH) Cleanup

func (s *SSH) Cleanup()

func (*SSH) Execute

func (s *SSH) Execute(host string, cmd []string, stdin io.Reader, stdout, stderr io.Writer) (int, error)

func (*SSH) PassThrough

func (s *SSH) PassThrough(argsAdditional []string) error

Pass through a local CLI session

func (*SSH) Tunnel

func (s *SSH) Tunnel(dest, destPort, localPort string, daemonize bool) interfaces.Tunnel

This opens a local tunnel through a SSH connection

func (*SSH) Validate

func (s *SSH) Validate() error

func (*SSH) WriteConfig

func (s *SSH) WriteConfig(c interfaces.Cluster) error

type Tunnel

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

func (*Tunnel) BindAddress

func (t *Tunnel) BindAddress() string

func (*Tunnel) Done

func (t *Tunnel) Done() <-chan struct{}

func (*Tunnel) Port

func (t *Tunnel) Port() string

func (*Tunnel) Start

func (t *Tunnel) Start() error

Start tunnel and wait till a tcp socket is reachable

func (*Tunnel) Stop

func (t *Tunnel) Stop()

prevent tarmak clean up from killing used daemons