docker

Documentation

Index

• Constants
• type Endpoint
  • func WithTLSData(s store.Store, contextName string, m EndpointMeta) (Endpoint, error)
  • func (c *Endpoint) ClientOpts() ([]func(*client.Client) error, error)
• type EndpointMeta
  • func EndpointFromContext(metadata store.ContextMetadata) (EndpointMeta, error)

Constants

const (
	// DockerEndpoint is the name of the docker endpoint in a stored context
	DockerEndpoint = "docker"
)

Types

type Endpoint

type Endpoint struct {
	EndpointMeta
	TLSData     *context.TLSData
	TLSPassword string
}

Endpoint is a typed wrapper around a context-store generic endpoint describing a Docker Engine endpoint, with its tls data

func WithTLSData

func WithTLSData(s store.Store, contextName string, m EndpointMeta) (Endpoint, error)

WithTLSData loads TLS materials for the endpoint

func (*Endpoint) ClientOpts

func (c *Endpoint) ClientOpts() ([]func(*client.Client) error, error)

ClientOpts returns a slice of Client options to configure an API client with this endpoint

type EndpointMeta

type EndpointMeta = context.EndpointMetaBase

EndpointMeta is a typed wrapper around a context-store generic endpoint describing a Docker Engine endpoint, without its tls config

func EndpointFromContext

func EndpointFromContext(metadata store.ContextMetadata) (EndpointMeta, error)

EndpointFromContext parses a context docker endpoint metadata into a typed EndpointMeta structure