docker

Documentation

Index

• type Docker
  • func GetInstance() (*Docker, error)
  • func (d *Docker) CheckImagesExist(requiredImages ...string) error
  • func (d *Docker) Cleanup(networkID string, matchName func(name string) bool) error
  • func (d *Docker) CreateNetwork(networkID string) error
  • func (d *Docker) LocalIP(networkID string) (string, error)

Types

type Docker

type Docker struct {
	Client *docker.Client
}

Docker is a helper to manage container related actions within nwo.

func GetInstance

func GetInstance() (*Docker, error)

GetInstance a Docker instance, returns nil and an error in case of a failure.

func (*Docker) CheckImagesExist

func (d *Docker) CheckImagesExist(requiredImages ...string) error

CheckImagesExist returns an error if a given container images is not available, returns an error in case of a failure. It receives a list of container image names that are checked.

func (*Docker) Cleanup

func (d *Docker) Cleanup(networkID string, matchName func(name string) bool) error

Cleanup is a helper function to release all container associated with `networkID`, returns an error in case of a failure. It removes all container that meet the condition of the `matchName` predicate function, removes the attached volumes, container images, the network.

func (*Docker) CreateNetwork

func (d *Docker) CreateNetwork(networkID string) error

CreateNetwork starts a docker network with the provided `networkID` as name, returns an error in case of a failure.

func (*Docker) LocalIP

func (d *Docker) LocalIP(networkID string) (string, error)