frontend

Documentation

Index

• Constants
• Variables
• func CheckLocalPath(path string) (string, error)
• func CreateEmptyTmpFile() (string, error)
• type Agent
  • func NewAgent(sess *session.AgentSettings) *Agent
  • func (a *Agent) AddKeys(keys []session.AgentPrivateKey) error
  • func (a *Agent) Start() error
  • func (a *Agent) Stop()
• type Check
  • func NewCheck(sess *session.Session) *Check
  • func (c *Check) AwaitAvailability(ctx context.Context) error
  • func (c *Check) CheckAvailability(ctx context.Context) error
  • func (c *Check) ExpectAvailable(ctx context.Context) ([]byte, error)
  • func (c *Check) String() string
  • func (c *Check) WithDelaySeconds(seconds int) *Check
• type Command
  • func NewCommand(sess *session.Session, name string, arg ...string) *Command
  • func (c *Command) Cmd(ctx context.Context)
  • func (c *Command) CombinedOutput(ctx context.Context) ([]byte, error)
  • func (c *Command) OnCommandStart(fn func())
  • func (c *Command) Output(ctx context.Context) ([]byte, []byte, error)
  • func (c *Command) Sudo(ctx context.Context)
  • func (c *Command) WithEnv(env map[string]string)
  • func (c *Command) WithSSHArgs(args ...string)
  • func (c *Command) WithTimeout(timeout time.Duration)
• type File
  • func NewFile(sess *session.Session) *File
  • func (f *File) Download(ctx context.Context, remotePath, dstPath string) error
  • func (f *File) DownloadBytes(ctx context.Context, remotePath string) ([]byte, error)
  • func (f *File) Upload(ctx context.Context, srcPath, remotePath string) error
  • func (f *File) UploadBytes(ctx context.Context, data []byte, remotePath string) error
• type KubeProxy
  • func NewKubeProxy(sess *session.Session) *KubeProxy
  • func (k *KubeProxy) Start(useLocalPort int) (port string, err error)
  • func (k *KubeProxy) Stop(startID int)
  • func (k *KubeProxy) StopAll()
• type ReverseTunnel
  • func NewReverseTunnel(sess *session.Session, address string) *ReverseTunnel
  • func (t *ReverseTunnel) StartHealthMonitor(ctx context.Context, checker ReverseTunnelChecker, killer ReverseTunnelKiller)
  • func (t *ReverseTunnel) Stop()
  • func (t *ReverseTunnel) String() string
  • func (t *ReverseTunnel) Up() error
• type ReverseTunnelChecker
• type ReverseTunnelKiller
• type Tunnel
  • func NewTunnel(sess *session.Session, ttype, address string) *Tunnel
  • func (t *Tunnel) ConsumeLines(r io.Reader, fn func(l string))
  • func (t *Tunnel) HealthMonitor(errorOutCh chan<- error)
  • func (t *Tunnel) Stop()
  • func (t *Tunnel) String() string
  • func (t *Tunnel) Up() error
• type UploadScript
  • func NewUploadScript(sess *session.Session, scriptPath string, args ...string) *UploadScript
  • func (u *UploadScript) Execute(ctx context.Context) (stdout []byte, err error)
  • func (u *UploadScript) ExecuteBundle(ctx context.Context, parentDir, bundleDir string) (stdout []byte, err error)
  • func (u *UploadScript) Sudo()
  • func (u *UploadScript) WithCleanupAfterExec(doCleanup bool)
  • func (u *UploadScript) WithEnvs(envs map[string]string)
  • func (u *UploadScript) WithStdoutHandler(handler func(string))
  • func (u *UploadScript) WithTimeout(timeout time.Duration)

Constants

const DefaultLocalAPIPort = 22322

Variables

var ErrBashibleTimeout = errors.New("Timeout bashible step running")

Functions

func CheckLocalPath

func CheckLocalPath(path string) (string, error)

CheckLocalPath see if file exists and determine if it is a directory. Error is returned if file is not exists.

func CreateEmptyTmpFile

func CreateEmptyTmpFile() (string, error)

Types

type Agent

type Agent struct {
	AgentSettings *session.AgentSettings

	Agent *cmd.SSHAgent
}

func NewAgent

func NewAgent(sess *session.AgentSettings) *Agent

func (*Agent) AddKeys

func (a *Agent) AddKeys(keys []session.AgentPrivateKey) error

TODO replace with x/crypto/ssh/agent ?

func (*Agent) Start

func (a *Agent) Start() error

func (*Agent) Stop

func (a *Agent) Stop()

type Check

type Check struct {
	Session *session.Session
	// contains filtered or unexported fields
}

func NewCheck

func NewCheck(sess *session.Session) *Check

func (*Check) AwaitAvailability

func (c *Check) AwaitAvailability(ctx context.Context) error

func (*Check) CheckAvailability

func (c *Check) CheckAvailability(ctx context.Context) error

func (*Check) ExpectAvailable

func (c *Check) ExpectAvailable(ctx context.Context) ([]byte, error)

func (*Check) String

func (c *Check) String() string

func (*Check) WithDelaySeconds

func (c *Check) WithDelaySeconds(seconds int) *Check

type Command

type Command struct {
	*process.Executor

	Session *session.Session

	Name string
	Args []string
	Env  []string

	SSHArgs []string
	// contains filtered or unexported fields
}

func NewCommand

func NewCommand(sess *session.Session, name string, arg ...string) *Command

func (*Command) Cmd

func (c *Command) Cmd(ctx context.Context)

func (*Command) CombinedOutput

func (c *Command) CombinedOutput(ctx context.Context) ([]byte, error)

func (*Command) OnCommandStart

func (c *Command) OnCommandStart(fn func())

func (*Command) Output

func (c *Command) Output(ctx context.Context) ([]byte, []byte, error)

func (*Command) Sudo

func (c *Command) Sudo(ctx context.Context)

func (*Command) WithEnv

func (c *Command) WithEnv(env map[string]string)

func (*Command) WithSSHArgs

func (c *Command) WithSSHArgs(args ...string)

func (*Command) WithTimeout

func (c *Command) WithTimeout(timeout time.Duration)

type File

type File struct {
	Session *session.Session
}

func NewFile

func NewFile(sess *session.Session) *File

func (*File) Download

func (f *File) Download(ctx context.Context, remotePath, dstPath string) error

func (*File) DownloadBytes

func (f *File) DownloadBytes(ctx context.Context, remotePath string) ([]byte, error)

Download remote file and returns its content as an array of bytes.

func (*File) Upload

func (f *File) Upload(ctx context.Context, srcPath, remotePath string) error

func (*File) UploadBytes

func (f *File) UploadBytes(ctx context.Context, data []byte, remotePath string) error

UploadBytes creates a tmp file and upload it to remote dstPath

type KubeProxy

type KubeProxy struct {
	Session *session.Session

	KubeProxyPort string
	LocalPort     string
	// contains filtered or unexported fields
}

func NewKubeProxy

func NewKubeProxy(sess *session.Session) *KubeProxy

func (*KubeProxy) Start

func (k *KubeProxy) Start(useLocalPort int) (port string, err error)

func (*KubeProxy) Stop

func (k *KubeProxy) Stop(startID int)

func (*KubeProxy) StopAll

func (k *KubeProxy) StopAll()

type ReverseTunnel

type ReverseTunnel struct {
	Session *session.Session
	Address string
	// contains filtered or unexported fields
}

func NewReverseTunnel

func NewReverseTunnel(sess *session.Session, address string) *ReverseTunnel

func (*ReverseTunnel) StartHealthMonitor

func (t *ReverseTunnel) StartHealthMonitor(ctx context.Context, checker ReverseTunnelChecker, killer ReverseTunnelKiller)

func (*ReverseTunnel) Stop

func (t *ReverseTunnel) Stop()

func (*ReverseTunnel) String

func (t *ReverseTunnel) String() string

func (*ReverseTunnel) Up

func (t *ReverseTunnel) Up() error

type ReverseTunnelChecker

type ReverseTunnelChecker interface {
	CheckTunnel(ctx context.Context) (string, error)
}

type ReverseTunnelKiller

type ReverseTunnelKiller interface {
	KillTunnel(ctx context.Context) (string, error)
}

type Tunnel

type Tunnel struct {
	Session *session.Session
	Type    string // Remote or Local
	Address string
	// contains filtered or unexported fields
}

func NewTunnel

func NewTunnel(sess *session.Session, ttype, address string) *Tunnel

func (*Tunnel) ConsumeLines

func (t *Tunnel) ConsumeLines(r io.Reader, fn func(l string))

func (*Tunnel) HealthMonitor

func (t *Tunnel) HealthMonitor(errorOutCh chan<- error)

func (*Tunnel) Stop

func (t *Tunnel) Stop()

func (*Tunnel) String

func (t *Tunnel) String() string

func (*Tunnel) Up

func (t *Tunnel) Up() error

type UploadScript

type UploadScript struct {
	Session *session.Session

	ScriptPath string
	Args       []string
	// contains filtered or unexported fields
}

func NewUploadScript

func NewUploadScript(sess *session.Session, scriptPath string, args ...string) *UploadScript

func (*UploadScript) Execute

func (u *UploadScript) Execute(ctx context.Context) (stdout []byte, err error)

func (*UploadScript) ExecuteBundle

func (u *UploadScript) ExecuteBundle(ctx context.Context, parentDir, bundleDir string) (stdout []byte, err error)

func (*UploadScript) Sudo

func (u *UploadScript) Sudo()

func (*UploadScript) WithCleanupAfterExec

func (u *UploadScript) WithCleanupAfterExec(doCleanup bool)

WithCleanupAfterExec option tells if ssh executor should delete uploaded script after execution was attempted or not. It does not care if script was executed successfully of failed.

func (*UploadScript) WithEnvs

func (u *UploadScript) WithEnvs(envs map[string]string)

func (*UploadScript) WithStdoutHandler

func (u *UploadScript) WithStdoutHandler(handler func(string))

func (*UploadScript) WithTimeout

func (u *UploadScript) WithTimeout(timeout time.Duration)