client

Documentation

Index

• Constants
• func Create(c Options) (client.APIClient, error)
• type Factory
  • func NewDefaultFactory(opts Options) (Factory, error)
• type Options

Constants

const (
	// DefaultAPIVersion is the default docker API version set by libcompose
	DefaultAPIVersion = "v1.20"
)

Functions

func Create

func Create(c Options) (client.APIClient, error)

Create creates a docker client based on the specified options.

Types

type Factory

type Factory interface {
	// Create constructs a Docker client for the given service. The passed in
	// config may be nil in which case a generic client for the project should
	// be returned.
	Create(service project.Service) client.APIClient
}

Factory is a factory to create docker clients.

func NewDefaultFactory

func NewDefaultFactory(opts Options) (Factory, error)

NewDefaultFactory creates and returns the default client factory that uses github.com/docker/docker client.

type Options

type Options struct {
	TLS         bool
	TLSVerify   bool
	TLSCAFile   string
	TLSCertFile string
	TLSKeyFile  string
	TrustKey    string
	Host        string
	APIVersion  string
}

Options holds docker client options (host, tls, ..)