ssh

package

v2.1.1+incompatible Latest Latest Go to latest Published: May 21, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/supergiant/supergiant

Documentation ¶

Index ¶

Constants
Variables
func NewRunner(config Config) (runner.Runner, error)
type Config
type Runner
- func (r *Runner) Run(cmd *runner.Command) (err error)

Constants ¶

View Source

const (
	DefaultPort = "22"
)

Variables ¶

View Source

var (
	ErrUserNotSpecified = errors.New("user not specified")
	ErrHostNotSpecified = errors.New("host not specified")
)

Functions ¶

func NewRunner ¶

func NewRunner(config Config) (runner.Runner, error)

NewRunner creates ssh runner object. It requires two io.Writer to send output of ssh session and config for ssh client. TODO: Does it safe to pass Config as a pointer?

Types ¶

type Config ¶

type Config struct {
	Host    string `json:"host"`
	Port    string `json:"port"`
	User    string `json:"user"`
	Timeout int    `json:"timeout"`
	Key     []byte `json:"key"`
}

Config is a set of params needed to create valid ssh.ClientConfig

type Runner ¶

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

Runner is implementation of runner interface for ssh

func (*Runner) Run ¶

func (r *Runner) Run(cmd *runner.Command) (err error)

TODO(stgleb): Add more context like env variables? Run executes a single command on ssh session.

The returned error is nil if the command runs, has no problems copying stdin, stdout, and stderr, and exits with a zero exit status.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL