docker

package

v0.1.1 Latest Latest Go to latest Published: May 21, 2020 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Client is a container for a docker client

func NewClient() (Client, error)

NewClient returns a new Cli struct

func (client *Client) EnsureImage(dockerHost, image string) (string, error)

EnsureImage makes sure that the image we need is present and returns the correct name

func (client *Client) EnsureNetwork() error

EnsureNetwork checks to see if the stargate bridge network exists and creates it if it doesnt

func (client *Client) GetNameWithVersion(image string) (string, error)

GetNameWithVersion finds a full versioned name for an image

func (client *Client) Remove(container string) error

Remove stopped docker container

func (client *Client) StartCassandra(opts *StartCassandraOptions) error

StartCassandra running docker image

func (client *Client) StartService(opts *StartServiceOptions) error

StartService running docker image

func (client *Client) Started(containerID, trigger string) error

Started function waits for a docker image to start

func (client *Client) Stop(container string) error

Stop running docker image

type StartCassandraOptions struct {
	DockerImageHost string
	ImageName       string
	ExposedPorts    []string
}

StartCassandraOptions defines the input of Client.Start

type StartServiceOptions struct {
	CassandraURL    string
	ExposedPorts    []string
	DockerImageHost string
	ImageName       string
}

StartServiceOptions defines the input of Client.Start