ssh

Documentation

Index

• Constants
• func BringUpAgent(ctx context.Context, client *api.Client, app *api.AppCompact, quiet bool) (*agent.Client, agent.Dialer, error)
• func Connect(p *ConnectParams, addr string) (*ssh.Client, error)
• func Console(ctx context.Context, sshClient *ssh.Client, cmd string, allocPTY bool) error
• func MarshalED25519PrivateKey(key ed25519.PrivateKey, comment string) []byte
• func New() *cobra.Command
• func NewSFTP() *cobra.Command
• func RunSSHCommand(ctx context.Context, app *api.AppCompact, dialer agent.Dialer, addr string, ...) ([]byte, error)
• func SSHConnect(p *SSHParams, addr string) error
• type ConnectParams
• type SSHParams
• Bugs

Constants

const DefaultSshUsername = "root"

Functions

func BringUpAgent

func BringUpAgent(ctx context.Context, client *api.Client, app *api.AppCompact, quiet bool) (*agent.Client, agent.Dialer, error)

func Connect

func Connect(p *ConnectParams, addr string) (*ssh.Client, error)

func Console

func Console(ctx context.Context, sshClient *ssh.Client, cmd string, allocPTY bool) error

func MarshalED25519PrivateKey

func MarshalED25519PrivateKey(key ed25519.PrivateKey, comment string) []byte

stolen from `mikesmitty`, thanks, you are a mikesmitty and a scholar

func New

func New() *cobra.Command

New initializes and returns a new apps Command.

func NewSFTP

func NewSFTP() *cobra.Command

func RunSSHCommand

func RunSSHCommand(ctx context.Context, app *api.AppCompact, dialer agent.Dialer, addr string, cmd string, username string) ([]byte, error)

func SSHConnect

func SSHConnect(p *SSHParams, addr string) error

Types

type ConnectParams

type ConnectParams struct {
	Ctx            context.Context
	Org            api.OrganizationImpl
	Username       string
	Dialer         agent.Dialer
	DisableSpinner bool
	AppNames       []string
}

type SSHParams

type SSHParams struct {
	Ctx            context.Context
	Org            api.OrganizationImpl
	App            string
	Username       string
	Dialer         agent.Dialer
	Cmd            string
	Stdin          io.Reader
	Stdout         io.WriteCloser
	Stderr         io.WriteCloser
	DisableSpinner bool
}

Notes

Bugs

• do better

• these return `error` because in theory an error might be bad enough that we want to kill the session, but nothing does that right now.