docker

README

docker - Docker Executor

Arguments

The docker middleware enables the execution of pipedream commands within a Docker container, using docker-compose exec.

It takes a single string argument indicating the name of the Docker service in which the command should be run.

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

Inline Shell Command

private:
    some-pipe:
        # the service in which any shell commands should be run
        docker: service-name
        # this will be executed as `docker-compose exec service-name "command"`
        shell:
            run: "command"

Automatic Inheritance

private:
    some-pipe:
        # define the service in which any shell commands should be run
        docker: service-name
        # invoke a child pipe
        pipe:
            child-pipe

    child-pipe:
        # this will be executed as `docker-compose exec service-name "command"`
        # the argument inheritance does not need to be specified explicitly
        shell:
            run: "command"

Documentation

Overview

Package docker provides a middleware for execution within a Docker (Compose) container

Index

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

Types

type Middleware

type Middleware struct {
}

Middleware is a Docker (Compose) executor

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware create a new Middleware instance

func (Middleware) Apply

func (dockerMiddleware 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 (Middleware) String() string

String is a human-readable description