Documentation
¶
Overview ¶
Package sshexecutor provides an implementation of pool.Executor using a long-lived multiplexed SSH session.
Index ¶
- Variables
- type Executor
- func (exr *Executor) Close()
- func (exr *Executor) Execute(env map[string]string, cmd string, stdin io.Reader) ([]byte, []byte, error)
- func (exr *Executor) SetSigners(signers ...ssh.Signer)
- func (exr *Executor) SetTarget(t cloud.ExecutorTarget)
- func (exr *Executor) SetTargetPort(port string)
- func (exr *Executor) Target() cloud.ExecutorTarget
- func (exr *Executor) TargetHostPort() (string, string)
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Executor ¶
type Executor struct {
// contains filtered or unexported fields
}
An Executor uses a multiplexed SSH connection to execute shell commands on a remote target. It reconnects automatically after errors.
When setting up a connection, the Executor accepts whatever host key is provided by the remote server, then passes the received key and the SSH connection to the target's VerifyHostKey method before executing commands on the connection.
A zero Executor must not be used before calling SetTarget.
An Executor must not be copied.
func New ¶
func New(t cloud.ExecutorTarget) *Executor
New returns a new Executor, using the given target.
func (*Executor) Execute ¶
func (exr *Executor) Execute(env map[string]string, cmd string, stdin io.Reader) ([]byte, []byte, error)
Execute runs cmd on the target. If an existing connection is not usable, it sets up a new connection to the current target.
func (*Executor) SetSigners ¶
SetSigners updates the set of private keys that will be offered to the target next time the Executor sets up a new connection.
func (*Executor) SetTarget ¶
func (exr *Executor) SetTarget(t cloud.ExecutorTarget)
SetTarget sets the current target. The new target will be used next time a new connection is set up; until then, the Executor will continue to use the existing target.
The new target is assumed to represent the same host as the previous target, although its address and host key might differ.
func (*Executor) SetTargetPort ¶
SetTargetPort sets the default port (name or number) to connect to. This is used only when the address returned by the target's Address() method does not specify a port. If the given port is empty (or SetTargetPort is not called at all), the default port is "ssh".
func (*Executor) Target ¶
func (exr *Executor) Target() cloud.ExecutorTarget
Target returns the current target.
Source Files