volume

Documentation

Overview

Package volume provides methods to deal with docker volumes.

Index

• type Volume
  • func New(name string, r runner.Runner) *Volume
  • func (v *Volume) Close(ctx context.Context) error
  • func (v *Volume) Copy(ctx context.Context, dir string) error
  • func (v *Volume) Export(ctx context.Context, dir string) error
  • func (v *Volume) Setup(ctx context.Context) error

Types

type Volume

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

Volume is responsible for managing the docker volume.

func New

func New(name string, r runner.Runner) *Volume

New creates a new Volume.

func (*Volume) Close

func (v *Volume) Close(ctx context.Context) error

Close cleans up the helper container and the docker volume.

func (*Volume) Copy

func (v *Volume) Copy(ctx context.Context, dir string) error

Copy copies files from a directory dir to the docker volume.

func (*Volume) Export

func (v *Volume) Export(ctx context.Context, dir string) error

Export copies files from a the docker volume to a directory.

func (*Volume) Setup

func (v *Volume) Setup(ctx context.Context) error

Setup creates a docker volume and a helper container that can be used to copy data to the volume.