network

Documentation

Index

• Constants
• Variables
• type Dialer
• type NsDialer
  • func NewNsDialer(ns netns.NsHandle) *NsDialer
  • func (d *NsDialer) Dial(network, address string) (net.Conn, error)
• type RetryDialer
  • func NewRetryDialer() *RetryDialer
  • func (d *RetryDialer) Dial(network, address string) (c net.Conn, err error)
• type SSHAgent
  • func NewSSHAgent(dialer Dialer) (*SSHAgent, error)
  • func (a *SSHAgent) Close() error
  • func (a *SSHAgent) NewClient(host string) (*ssh.Client, error)
  • func (a *SSHAgent) NewPasswordClient(host string, user string, password string) (*ssh.Client, error)
  • func (a *SSHAgent) NewUserClient(host string, user string) (*ssh.Client, error)

Constants

const (
	// DefaultTimeout sets the default timeout for RetryDialer.
	DefaultTimeout = 5 * time.Second

	// DefaultKeepAlive sets the default keepalive for RetryDialer.
	DefaultKeepAlive = 30 * time.Second

	// DefaultRetries sets the default number of retries for RetryDialer.
	DefaultRetries = 7
)

Variables

var DefaultSSHDir string

DefaultSSHDir is a process-global path that can be set, and currently is by kola.

Types

type Dialer

type Dialer interface {
	Dial(network, address string) (net.Conn, error)
}

Dialer is an interface for anything compatible with net.Dialer

type NsDialer

type NsDialer struct {
	RetryDialer
	NsHandle netns.NsHandle
}

NsDialer is a RetryDialer that can enter any network namespace.

func NewNsDialer

func NewNsDialer(ns netns.NsHandle) *NsDialer

func (*NsDialer) Dial

func (d *NsDialer) Dial(network, address string) (net.Conn, error)

type RetryDialer

type RetryDialer struct {
	net.Dialer
	Retries int
}

RetryDialer is intended to timeout quickly and retry connecting instead of just failing. Particularly useful for waiting on a booting machine.

func NewRetryDialer

func NewRetryDialer() *RetryDialer

NewRetryDialer initializes a RetryDialer with reasonable default settings.

func (*RetryDialer) Dial

func (d *RetryDialer) Dial(network, address string) (c net.Conn, err error)

Dial connects to a remote address, retrying on failure.

type SSHAgent

type SSHAgent struct {
	agent.ExtendedAgent
	Dialer
	User   string
	Socket string
	// contains filtered or unexported fields
}

SSHAgent can manage keys, updates cloud config, and loves ponies. The embedded dialer is used for establishing new SSH connections.

func NewSSHAgent

func NewSSHAgent(dialer Dialer) (*SSHAgent, error)

NewSSHAgent constructs a new SSHAgent using dialer to create ssh connections.

func (*SSHAgent) Close

func (a *SSHAgent) Close() error

Close closes the unix socket of the agent.

func (*SSHAgent) NewClient

func (a *SSHAgent) NewClient(host string) (*ssh.Client, error)

NewClient connects to the given host via SSH, the client will support agent forwarding but it must also be enabled per-session.

func (*SSHAgent) NewPasswordClient

func (a *SSHAgent) NewPasswordClient(host string, user string, password string) (*ssh.Client, error)

NewPasswordClient connects to the given host via SSH using the provided username and password

func (*SSHAgent) NewUserClient

func (a *SSHAgent) NewUserClient(host string, user string) (*ssh.Client, error)

NewUserClient connects to the given host via SSH using the provided username. The client will support agent forwarding but it must also be enabled per-session.