ssh

Documentation

Index

• func CheckSSHHosts(userPassedHosts []session.Host, nodesNames []string, phase string, ...) (map[string]string, error)
• type Client
  • func NewClient(session *session.Session, privKeys []session.AgentPrivateKey) *Client
  • func NewClientFromFlags() *Client
  • func NewClientFromFlagsWithHosts() (*Client, error)
  • func NewInitClientFromFlags(askPassword bool) (*Client, error)
  • func NewInitClientFromFlagsWithHosts(askPassword bool) (*Client, error)
  • func (s *Client) Check() *frontend.Check
  • func (s *Client) Command(name string, arg ...string) *frontend.Command
  • func (s *Client) File() *frontend.File
  • func (s *Client) KubeProxy() *frontend.KubeProxy
  • func (s *Client) Loop(fn SSHLoopHandler) error
  • func (s *Client) ReverseTunnel(address string) *frontend.ReverseTunnel
  • func (s *Client) Start() (*Client, error)
  • func (s *Client) Stop()
  • func (s *Client) Tunnel(ttype, address string) *frontend.Tunnel
  • func (s *Client) UploadScript(scriptPath string, args ...string) *frontend.UploadScript
• type NodeInterfaceWrapper
  • func NewNodeInterfaceWrapper(sshClient *Client) *NodeInterfaceWrapper
  • func (n *NodeInterfaceWrapper) Client() *Client
  • func (n *NodeInterfaceWrapper) Command(name string, args ...string) node.Command
  • func (n *NodeInterfaceWrapper) File() node.File
  • func (n *NodeInterfaceWrapper) UploadScript(scriptPath string, args ...string) node.Script
• type RunScriptReverseTunnelChecker
  • func NewRunScriptReverseTunnelChecker(c *Client, scriptPath string) *RunScriptReverseTunnelChecker
  • func (s *RunScriptReverseTunnelChecker) CheckTunnel(ctx context.Context) (string, error)
• type RunScriptReverseTunnelKiller
  • func NewRunScriptReverseTunnelKiller(c *Client, scriptPath string) *RunScriptReverseTunnelKiller
  • func (s *RunScriptReverseTunnelKiller) KillTunnel(ctx context.Context) (string, error)
• type SSHLoopHandler

Functions

func CheckSSHHosts

func CheckSSHHosts(userPassedHosts []session.Host, nodesNames []string, phase string, runConfirm func(string) bool) (map[string]string, error)

Types

type Client

type Client struct {
	Settings *session.Session
	Agent    *frontend.Agent

	PrivateKeys        []session.AgentPrivateKey
	InitializeNewAgent bool
	// contains filtered or unexported fields
}

func NewClient

func NewClient(session *session.Session, privKeys []session.AgentPrivateKey) *Client

func NewClientFromFlags

func NewClientFromFlags() *Client

func NewClientFromFlagsWithHosts

func NewClientFromFlagsWithHosts() (*Client, error)

func NewInitClientFromFlags

func NewInitClientFromFlags(askPassword bool) (*Client, error)

func NewInitClientFromFlagsWithHosts

func NewInitClientFromFlagsWithHosts(askPassword bool) (*Client, error)

func (*Client) Check

func (s *Client) Check() *frontend.Check

UploadScript is used to upload script and execute it on remote server

func (*Client) Command

func (s *Client) Command(name string, arg ...string) *frontend.Command

Command is used to run commands on remote server

func (*Client) File

func (s *Client) File() *frontend.File

File is used to upload and download files and directories

func (*Client) KubeProxy

func (s *Client) KubeProxy() *frontend.KubeProxy

KubeProxy is used to start kubectl proxy and create a tunnel from local port to proxy port

func (*Client) Loop

func (s *Client) Loop(fn SSHLoopHandler) error

Loop Looping all available hosts

func (*Client) ReverseTunnel

func (s *Client) ReverseTunnel(address string) *frontend.ReverseTunnel

ReverseTunnel is used to open remote (R) tunnel

func (*Client) Start

func (s *Client) Start() (*Client, error)

func (*Client) Stop

func (s *Client) Stop()

Stop the client

func (*Client) Tunnel

func (s *Client) Tunnel(ttype, address string) *frontend.Tunnel

Tunnel is used to open local (L) and remote (R) tunnels

func (*Client) UploadScript

func (s *Client) UploadScript(scriptPath string, args ...string) *frontend.UploadScript

UploadScript is used to upload script and execute it on remote server

type NodeInterfaceWrapper

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

func NewNodeInterfaceWrapper

func NewNodeInterfaceWrapper(sshClient *Client) *NodeInterfaceWrapper

func (*NodeInterfaceWrapper) Client

func (n *NodeInterfaceWrapper) Client() *Client

func (*NodeInterfaceWrapper) Command

func (n *NodeInterfaceWrapper) Command(name string, args ...string) node.Command

func (*NodeInterfaceWrapper) File

func (n *NodeInterfaceWrapper) File() node.File

func (*NodeInterfaceWrapper) UploadScript

func (n *NodeInterfaceWrapper) UploadScript(scriptPath string, args ...string) node.Script

type RunScriptReverseTunnelChecker

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

func NewRunScriptReverseTunnelChecker

func NewRunScriptReverseTunnelChecker(c *Client, scriptPath string) *RunScriptReverseTunnelChecker

func (*RunScriptReverseTunnelChecker) CheckTunnel

func (s *RunScriptReverseTunnelChecker) CheckTunnel(ctx context.Context) (string, error)

type RunScriptReverseTunnelKiller

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

func NewRunScriptReverseTunnelKiller

func NewRunScriptReverseTunnelKiller(c *Client, scriptPath string) *RunScriptReverseTunnelKiller

func (*RunScriptReverseTunnelKiller) KillTunnel

func (s *RunScriptReverseTunnelKiller) KillTunnel(ctx context.Context) (string, error)

type SSHLoopHandler

type SSHLoopHandler func(s *Client) error