ishmael

README

Ishmael

A library for getting docker information in JSON.

Documentation

Index

• type Client
  • func NewClient() (*Client, error)
  • func (c *Client) Containers() ([]*Container, error)
  • func (c *Client) Images() ([]*Image, error)
  • func (c *Client) Networks() ([]*Network, error)
  • func (c *Client) Swarm() (*Swarm, error)
  • func (c *Client) Volumes() ([]*Volume, []string, error)
• type Container
  • func Containers() ([]*Container, error)
• type Image
  • func Images() ([]*Image, error)
• type Network
  • func Networks() ([]*Network, error)
• type Swarm
  • func GetSwarm() (*Swarm, error)
• type Volume
  • func Volumes() ([]*Volume, []string, error)

Types

type Client

type Client struct {
	*client.Client
}

A Client handles connections to the docker API

var DefaultClient *Client

DefaultClient is the client that gets used for package-level functions

func NewClient

func NewClient() (*Client, error)

NewClient gets a new client using the environment (DOCKER_HOST, etc). If you need a fancier client, you can build it by hand.

func (*Client) Containers

func (c *Client) Containers() ([]*Container, error)

Containers gets a detailed list of Containers

func (*Client) Images

func (c *Client) Images() ([]*Image, error)

func (*Client) Networks

func (c *Client) Networks() ([]*Network, error)

func (*Client) Swarm

func (c *Client) Swarm() (*Swarm, error)

func (*Client) Volumes

func (c *Client) Volumes() ([]*Volume, []string, error)

Volumes gets a detailed list of Volumes

type Container

type Container struct {
	types.ContainerJSON
}

func Containers

func Containers() ([]*Container, error)

Containers gets a list of Containers using the default client

type Image

type Image struct {
	types.ImageInspect
}

func Images

func Images() ([]*Image, error)

type Network

type Network struct {
	types.NetworkResource
}

func Networks

func Networks() ([]*Network, error)

type Swarm

type Swarm struct {
	swarm.Swarm
}

func GetSwarm

func GetSwarm() (*Swarm, error)

type Volume

type Volume struct {
	*types.Volume
}

func Volumes

func Volumes() ([]*Volume, []string, error)

Volumes gets a list of Volumes using the default client