docker

Documentation

Index

• Constants
• Variables
• func Clients() map[string]*SharedClient
• func IsErrConnectionFailed(err error) bool
• func ListContainers(clientHost string) ([]container.SummaryTrimmed, error)
• type Container
  • func FromDocker(c *container.SummaryTrimmed, dockerHost string) (res *Container)
  • func (c *Container) IsBlacklisted() bool
• type ContainerImage
  • func (image *ContainerImage) IsBlacklisted() bool
• type LabelMap
  • func ParseLabels(labels map[string]string) (LabelMap, gperr.Error)
• type PortMapping
• type SharedClient
  • func NewClient(host string) (*SharedClient, error)
  • func (c *SharedClient) Address() string
  • func (c *SharedClient) CheckConnection(ctx context.Context) error
  • func (c *SharedClient) Close()
  • func (c *SharedClient) Key() string

Constants

const (
	WildcardAlias = "*"

	NSProxy = "proxy"

	LabelAliases       = NSProxy + ".aliases"
	LabelExclude       = NSProxy + ".exclude"
	LabelIdleTimeout   = NSProxy + ".idle_timeout"
	LabelWakeTimeout   = NSProxy + ".wake_timeout"
	LabelStopMethod    = NSProxy + ".stop_method"
	LabelStopTimeout   = NSProxy + ".stop_timeout"
	LabelStopSignal    = NSProxy + ".stop_signal"
	LabelStartEndpoint = NSProxy + ".start_endpoint"
)

Variables

var DummyContainer = new(Container)

var ErrInvalidLabel = gperr.New("invalid label")

Functions

func Clients

func Clients() map[string]*SharedClient

func IsErrConnectionFailed

func IsErrConnectionFailed(err error) bool

func ListContainers

func ListContainers(clientHost string) ([]container.SummaryTrimmed, error)

Types

type Container

type Container struct {
	DockerHost    string          `json:"docker_host"`
	Image         *ContainerImage `json:"image"`
	ContainerName string          `json:"container_name"`
	ContainerID   string          `json:"container_id"`

	Agent *agent.AgentConfig `json:"agent"`

	Labels            map[string]string   `json:"-"`
	IdlewatcherConfig *idlewatcher.Config `json:"idlewatcher_config"`

	Mounts []string `json:"mounts"`

	PublicPortMapping  PortMapping `json:"public_ports"`  // non-zero publicPort:types.Port
	PrivatePortMapping PortMapping `json:"private_ports"` // privatePort:types.Port
	PublicHostname     string      `json:"public_hostname"`
	PrivateHostname    string      `json:"private_hostname"`

	Aliases    []string `json:"aliases"`
	IsExcluded bool     `json:"is_excluded"`
	IsExplicit bool     `json:"is_explicit"`
	Running    bool     `json:"running"`
	// contains filtered or unexported fields
}

func FromDocker

func FromDocker(c *container.SummaryTrimmed, dockerHost string) (res *Container)

func (*Container) IsBlacklisted

func (c *Container) IsBlacklisted() bool

type ContainerImage

type ContainerImage struct {
	Author string `json:"author,omitempty"`
	Name   string `json:"name"`
	Tag    string `json:"tag,omitempty"`
}

func (*ContainerImage) IsBlacklisted

func (image *ContainerImage) IsBlacklisted() bool

type LabelMap

type LabelMap = map[string]any

func ParseLabels

func ParseLabels(labels map[string]string) (LabelMap, gperr.Error)

type PortMapping

type PortMapping = map[int]container.Port

type SharedClient

type SharedClient struct {
	*client.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(host string) (*SharedClient, error)

NewClient creates a new Docker client connection to the specified host.

Returns existing client if available.

Parameters:

• host: the host to connect to (either a URL or common.DockerHostFromEnv).

Returns:

• Client: the Docker client connection.
• error: an error if the connection failed.

func (*SharedClient) Address

func (c *SharedClient) Address() string

func (*SharedClient) CheckConnection

func (c *SharedClient) CheckConnection(ctx context.Context) error

func (*SharedClient) Close

func (c *SharedClient) Close()

if the client is still referenced, this is no-op.

func (*SharedClient) Key

func (c *SharedClient) Key() string