runner

Documentation

Overview

package runner provides a simple interface for running docker containers.

Index

• Constants
• type RunOpts
• type Runner
  • func NewRunner(client *dockerutil.Client) *Runner
  • func (r *Runner) Run(ctx context.Context, opts RunOpts) error

Constants

const DefaultStopTimeout = 10

DefaultStopTimeout is the number of seconds to wait when stopping a container.

Types

type RunOpts

type RunOpts struct {
	// Image is the image to run.
	Image image.Image

	// Command is the command to run.
	Command string

	// Environment variables to set.
	Env map[string]string

	// Streams fo Stdout, Stderr and Stdin.
	Input  io.Reader
	Output io.Writer
}

RunOpts is used when running.

type Runner

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

Runner is a service for running containers.

func NewRunner

func NewRunner(client *dockerutil.Client) *Runner

NewRunner returns a new Runner instance using the docker.Client as the docker client.

func (*Runner) Run

func (r *Runner) Run(ctx context.Context, opts RunOpts) error