ssh

Documentation

Index

• type Command
  • func NewCommand(value string, sensitive ...string) *Command
  • func (c *Command) Info() string
  • func (c *Command) Run(client *ssh.Client) (string, error)
  • func (c *Command) WithSudo(sudo bool) Runnable
• type RemoteExecutor
  • func (re *RemoteExecutor) Run() error
• type Runnable
• type Script
  • func NewScript(interpreter string, script string, sensitive ...string) *Script
  • func (s *Script) Info() string
  • func (s *Script) Run(client *ssh.Client) (string, error)
  • func (s *Script) WithSudo(sudo bool) Runnable

Types

type Command

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

func NewCommand

func NewCommand(value string, sensitive ...string) *Command

func (*Command) Info

func (c *Command) Info() string

func (*Command) Run

func (c *Command) Run(client *ssh.Client) (string, error)

func (*Command) WithSudo

func (c *Command) WithSudo(sudo bool) Runnable

type RemoteExecutor

type RemoteExecutor struct {
	Host       string
	User       string
	Port       uint32
	PrivateKey string
	Logger     logr.Logger
	CmdTimeout time.Duration
	Commands   []Runnable
}

func (*RemoteExecutor) Run

func (re *RemoteExecutor) Run() error

type Runnable

type Runnable interface {
	Run(*ssh.Client) (string, error)
	Info() string
	WithSudo(bool) Runnable
}

type Script

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

func NewScript

func NewScript(interpreter string, script string, sensitive ...string) *Script

func (*Script) Info

func (s *Script) Info() string

func (*Script) Run

func (s *Script) Run(client *ssh.Client) (string, error)

func (*Script) WithSudo

func (s *Script) WithSudo(sudo bool) Runnable