ssh

README

ssh - SSH Executor

Arguments

The ssh middleware enables the execution of pipedream commands on a remote server via SSH.

It takes a single string argument indicating the name of the SSH host on which the command should be run.

Note that for convenience, the ssh argument is inherited automatically. Child pipes without an ssh argument will look within their direct ancestors and apply the most recent definition, if any.

Inline Shell Command

private:
    some-pipe:
        # the name of the remote host on which any shell commands should be run
        # it will be resolved using your SSH configuration
        ssh: hostname
        # this will be executed as `ssh hostname "command"`
        shell:
            run: "command"

Automatic Inheritance

private:
    some-pipe:
        # the name of the remote host on which any shell commands should be run
        # it will be resolved using your SSH configuration
        ssh: hostname
        # invoke a child pipe
        pipe:
            child-pipe

    child-pipe:
        # this will be executed as `ssh hostname "command"`
        # the argument inheritance does not need to be specified explicitly
        shell:
            run: "command"

Documentation

Overview

Package ssh provides a middleware enabling remote command execution via SSH

Index

• type Middleware
  • func NewMiddleware() Middleware
  • func (sshMiddleware Middleware) Apply(run *pipeline.Run, next func(*pipeline.Run), _ *middleware.ExecutionContext)
  • func (sshMiddleware Middleware) String() string

Types

type Middleware

type Middleware struct {
}

Middleware is an SSH executor

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func (Middleware) Apply

func (sshMiddleware Middleware) Apply(
	run *pipeline.Run,
	next func(*pipeline.Run),
	_ *middleware.ExecutionContext,
)

Apply is where the middleware's logic resides

It adapts the run based on its slice of the run's arguments. It may also trigger side effects such as executing shell commands or full runs of other pipelines. When done, this function should call next in order to continue unwinding the stack.

func (Middleware) String

func (sshMiddleware Middleware) String() string

String is a human-readable description