Documentation
¶
Index ¶
- type Client
- type ClientConnectRetryStrategy
- type ClientFactory
- type ClientImpl
- type ClientOpts
- type ComboRunner
- type ConnectionOpts
- type InstanceWriter
- type InteractiveRunner
- type NonInteractiveRunner
- type Provider
- type ResultsWriter
- type Runner
- type SCPArgs
- type SCPRunner
- type SCPRunnerImpl
- type Session
- type SessionImpl
- type SessionImplOpts
- type StreamingWriter
- type Writer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.0.146
type Client interface {
Start() error
Stop() error
Dial(net, addr string) (net.Conn, error)
Listen(net, addr string) (net.Listener, error)
}
type ClientConnectRetryStrategy ¶ added in v0.0.146
type ClientConnectRetryStrategy struct {
ConnectionRefusedTimeout time.Duration
AuthFailureTimeout time.Duration
TimeService clock.Clock
// contains filtered or unexported fields
}
func (*ClientConnectRetryStrategy) IsRetryable ¶ added in v0.0.146
func (s *ClientConnectRetryStrategy) IsRetryable(err error) bool
type ClientFactory ¶ added in v0.0.146
type ClientFactory struct {
// contains filtered or unexported fields
}
func NewClientFactory ¶ added in v0.0.146
func NewClientFactory(logger boshlog.Logger) ClientFactory
type ClientImpl ¶ added in v0.0.146
type ClientImpl struct {
// contains filtered or unexported fields
}
func (*ClientImpl) Dial ¶ added in v0.0.146
func (s *ClientImpl) Dial(n, addr string) (net.Conn, error)
type ClientOpts ¶ added in v0.0.146
type ClientOpts struct {
Host string
Port int
User string
Password string
PrivateKey string
DisableSOCKS bool
}
type ComboRunner ¶
type ComboRunner struct {
// contains filtered or unexported fields
}
func NewComboRunner ¶
func NewComboRunner(
cmdRunner boshsys.CmdRunner,
sessionFactory func(ConnectionOpts, boshdir.SSHResult) Session,
signalNotifyFunc func(chan<- os.Signal, ...os.Signal),
writer Writer,
fs boshsys.FileSystem,
ui boshui.UI,
logger boshlog.Logger,
) ComboRunner
type ConnectionOpts ¶
type ConnectionOpts struct {
PrivateKey string
GatewayDisable bool
GatewayUsername string
GatewayHost string
GatewayPrivateKeyPath string
SOCKS5Proxy string
RawOpts []string
}
type InstanceWriter ¶
type InstanceWriter interface {
Stdout() io.Writer
Stderr() io.Writer
End(exitStatus int, err error)
}
type InteractiveRunner ¶
type InteractiveRunner struct {
// contains filtered or unexported fields
}
func NewInteractiveRunner ¶
func NewInteractiveRunner(comboRunner ComboRunner) InteractiveRunner
type NonInteractiveRunner ¶
type NonInteractiveRunner struct {
// contains filtered or unexported fields
}
func NewNonInteractiveRunner ¶
func NewNonInteractiveRunner(comboRunner ComboRunner) NonInteractiveRunner
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
func NewProvider ¶
func NewProvider(cmdRunner boshsys.CmdRunner, fs boshsys.FileSystem, ui boshui.UI, logger boshlog.Logger) Provider
func (Provider) NewResultsSSHRunner ¶
func (p Provider) NewResultsSSHRunner(interactive bool) Runner
func (Provider) NewSCPRunner ¶
func (p Provider) NewSCPRunner() SCPRunner
func (Provider) NewSSHRunner ¶
func (p Provider) NewSSHRunner(interactive bool) Runner
type ResultsWriter ¶
type ResultsWriter struct {
// contains filtered or unexported fields
}
func NewResultsWriter ¶
func NewResultsWriter(ui boshui.UI) *ResultsWriter
func (*ResultsWriter) ForInstance ¶
func (w *ResultsWriter) ForInstance(jobName, indexOrID string) InstanceWriter
type SCPArgs ¶
type SCPArgs struct {
// contains filtered or unexported fields
}
func NewSCPArgs ¶
func NewSCPArgs(rawArgs []string, recursive bool) SCPArgs
func (SCPArgs) AllOrInstanceGroupOrInstanceSlug ¶ added in v0.0.102
func (a SCPArgs) AllOrInstanceGroupOrInstanceSlug() (boshdir.AllOrInstanceGroupOrInstanceSlug, error)
type SCPRunnerImpl ¶
type SCPRunnerImpl struct {
// contains filtered or unexported fields
}
func NewSCPRunner ¶
func NewSCPRunner(comboRunner ComboRunner) SCPRunnerImpl
type SessionImpl ¶
type SessionImpl struct {
// contains filtered or unexported fields
}
func NewSessionImpl ¶
func NewSessionImpl(
connOpts ConnectionOpts,
sessOpts SessionImplOpts,
result boshdir.SSHResult,
fs boshsys.FileSystem,
) *SessionImpl
type SessionImplOpts ¶
type SessionImplOpts struct {
ForceTTY bool
}
type StreamingWriter ¶
type StreamingWriter struct {
// contains filtered or unexported fields
}
func NewStreamingWriter ¶
func NewStreamingWriter(comboWriter *boshui.ComboWriter) *StreamingWriter
func (StreamingWriter) ForInstance ¶
func (w StreamingWriter) ForInstance(jobName, indexOrID string) InstanceWriter
Source Files
¶
Click to show internal directories.
Click to hide internal directories.