connector

Documentation

Index

• func Enabled() (a []string)
• type Connector
  • func NewDocker() (Connector, error)
  • func NewMock() (Connector, error)
  • func NewRunc() (Connector, error)
• type ConnectorFn
• type ConnectorSuper
  • func ByName(s string) (*ConnectorSuper, error)
  • func NewConnectorSuper(connFn ConnectorFn) *ConnectorSuper
  • func (cs *ConnectorSuper) Get() (Connector, error)
• type Docker
  • func (cm *Docker) All() (containers container.Containers)
  • func (cm *Docker) Get(id string) (*container.Container, bool)
  • func (cm *Docker) Loop()
  • func (cm *Docker) LoopStatuses()
  • func (cm *Docker) MustGet(id string) *container.Container
  • func (cm *Docker) Wait() struct{}
• type Mock
  • func (cs *Mock) All() container.Containers
  • func (cs *Mock) Get(id string) (*container.Container, bool)
  • func (cs *Mock) Init()
  • func (cs *Mock) Loop()
  • func (cs *Mock) Wait() struct{}
• type Runc
  • func (cm *Runc) All() (containers container.Containers)
  • func (cm *Runc) Get(id string) (*container.Container, bool)
  • func (cm *Runc) GetLibc(id string) libcontainer.Container
  • func (cm *Runc) Loop()
  • func (cm *Runc) MustGet(id string) *container.Container
  • func (cm *Runc) Wait() struct{}
• type RuncOpts
  • func NewRuncOpts() (RuncOpts, error)
• type StatusUpdate

Functions

func Enabled

func Enabled() (a []string)

Enabled returns names for all enabled connectors on the current platform

Types

type Connector

type Connector interface {
	// All returns a pre-sorted container.Containers of all discovered containers
	All() container.Containers
	// Get returns a single container.Container by ID
	Get(string) (*container.Container, bool)
	// Wait blocks until the underlying connection is lost
	Wait() struct{}
}

func NewDocker

func NewDocker() (Connector, error)

func NewMock

func NewMock() (Connector, error)

func NewRunc

func NewRunc() (Connector, error)

type ConnectorFn

type ConnectorFn func() (Connector, error)

type ConnectorSuper

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

ConnectorSuper provides initial connection and retry on failure for an undlerying Connector type

func ByName

func ByName(s string) (*ConnectorSuper, error)

ByName returns a ConnectorSuper for a given name, or error if the connector does not exists on the current platform

func NewConnectorSuper

func NewConnectorSuper(connFn ConnectorFn) *ConnectorSuper

func (*ConnectorSuper) Get

func (cs *ConnectorSuper) Get() (Connector, error)

Get returns the underlying Connector, or nil and an error if the Connector is not yet initialized or is disconnected.

type Docker

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

func (*Docker) All

func (cm *Docker) All() (containers container.Containers)

Docker implements Connector

func (*Docker) Get

func (cm *Docker) Get(id string) (*container.Container, bool)

Docker implements Connector

func (*Docker) Loop

func (cm *Docker) Loop()

func (*Docker) LoopStatuses

func (cm *Docker) LoopStatuses()

func (*Docker) MustGet

func (cm *Docker) MustGet(id string) *container.Container

MustGet gets a single container, creating one anew if not existing

func (*Docker) Wait

func (cm *Docker) Wait() struct{}

Docker implements Connector

type Mock

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

func (*Mock) All

func (cs *Mock) All() container.Containers

All returns array of all containers, sorted by field

func (*Mock) Get

func (cs *Mock) Get(id string) (*container.Container, bool)

Get a single container, by ID

func (*Mock) Init

func (cs *Mock) Init()

Create Mock containers

func (*Mock) Loop

func (cs *Mock) Loop()

func (*Mock) Wait

func (cs *Mock) Wait() struct{}

type Runc

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

func (*Runc) All

func (cm *Runc) All() (containers container.Containers)

Runc implements Connector

func (*Runc) Get

func (cm *Runc) Get(id string) (*container.Container, bool)

Runc implements Connector

func (*Runc) GetLibc

func (cm *Runc) GetLibc(id string) libcontainer.Container

func (*Runc) Loop

func (cm *Runc) Loop()

func (*Runc) MustGet

func (cm *Runc) MustGet(id string) *container.Container

MustGet gets a single ctop container in the map matching libc container, creating one anew if not existing

func (*Runc) Wait

func (cm *Runc) Wait() struct{}

Runc implements Connector

type RuncOpts

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

func NewRuncOpts

func NewRuncOpts() (RuncOpts, error)

type StatusUpdate

type StatusUpdate struct {
	Cid    string
	Field  string // "status" or "health"
	Status string
}