ssh

Documentation

Index

• type Client
  • func NewClient(opts Options, logger *zap.SugaredLogger) (client *Client, err error)
  • func (c *Client) GetByHost(host string) (*HostExecutor, error)
• type HostExecutor
  • func (h *HostExecutor) Execute(ctx context.Context, cmd *exec.Cmd) ([]byte, error)
  • func (h *HostExecutor) ReadFile(ctx context.Context, path string) ([]byte, error)
  • func (h *HostExecutor) Run(ctx context.Context, cmd *exec.Cmd) error
  • func (h *HostExecutor) WriteFile(ctx context.Context, path string, data []byte) error
• type Options

Types

type Client

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

func NewClient

func NewClient(opts Options, logger *zap.SugaredLogger) (client *Client, err error)

func (*Client) GetByHost

func (c *Client) GetByHost(host string) (*HostExecutor, error)

GetByHost returns a shell command executor on a remote host. Attempts to only create SSH connections once, keeping them in a `sync.Map`.

type HostExecutor

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

HostExecutor implements a shell command executor on a remote machine over SSH

func (*HostExecutor) Execute

func (h *HostExecutor) Execute(ctx context.Context, cmd *exec.Cmd) ([]byte, error)

func (*HostExecutor) ReadFile

func (h *HostExecutor) ReadFile(ctx context.Context, path string) ([]byte, error)

func (*HostExecutor) Run

func (h *HostExecutor) Run(ctx context.Context, cmd *exec.Cmd) error

func (*HostExecutor) WriteFile

func (h *HostExecutor) WriteFile(ctx context.Context, path string, data []byte) error

type Options

type Options struct {
	Port        uint
	Username    string
	Password    string
	KeyFile     string `yaml:"keyFile"`
	KeyPassword string `yaml:"keyPassword"`
	Debug       bool
}