dockops

docker convenience functions on top of dockerode

Table of Contents generated with DocToc

Installation
API
License

var dockops = require('dockops')
var docker = dockops.createDocker({ dockerhost: dockerhost });
 
var images = new dockops.Images(docker);
dockops.logEvents(images, 'verbose');
 
var containers = new dockops.Containers(docker);
dockops.logEvents(containers, 'verbose');
 
build('test:uno', testUnoTar, function () {
  build('toast:uno', toastUnoTar, function () {
 
    containers.run(.. // run test:uno and toast:uno containers
 
    containers.listRunning(function (err, res) {
      inspect(res);
      containers.stopRemoveGroup('test', function (err, res) {
        containers.listRunning(function (err, res) {
          inspect(res);
          http.request({ port: 49222 }, function (res) {
            console.log('--------------------------')
            inspect({ status: res.statusCode, headers: res.headers })
            res.pipe(process.stdout)
          }).end()
        }) 
      })
    })
  })
})

full example

output

Installation

npm install dockops

API

dockops::Containers(docker) → {Object}

Creates a new containers instance that will use the given docker instance to communicate with docker.

Parameters:

Name	Type	Description
`docker`	Object	dockerode instance to communicate with docker

Source:

containers.js , lineno 24

Returns:

initialized containers

Type: Object

dockops::Containers::activePorts(cb)

Lists all running containers by the ports they expose.

Parameters:

Name	Type	Description
`cb`	function	called back with list of containers hashed by their port number

Source:

containers.js , lineno 275

dockops::Containers::clean(id, cb)

Stops and/or kills and then removes a container.

Heavy machinery clean operation. It was useful when running on arch with docker not always working as promised. This may not be needed anymore as docker got more stable.

Parameters:

Name	Type	Description
`id`	string	container id
`cb`	function	called back after container was cleaned or maximum attempts were exceeded

Source:

containers.js , lineno 97

dockops::Containers::create(opts, cb)

Creates a docker container according to given opts.

Parameters:

Name	Type	Description
`opts`	Object	creation options passed to dockerode
`cb`	function	called back when container was created

Source:

containers.js , lineno 42

dockops::Containers::listAll(cb)

Lists all docker containers.

Parameters:

Name	Type	Description
`cb`	function	called back with list of containers

Source:

containers.js , lineno 180

dockops::Containers::listGroup(group, cb)

Lists all containers that were created from images belonging to a given group.

Parameters:

Name	Type	Description
`group`	string	group for which to list containers
`cb`	function

Source:

containers.js , lineno 208

dockops::Containers::listGroupRunning(group, cb)

Lists all running docker containers of the given group

Parameters:

Name	Type	Description
`group`	string	group for which to list running containers
`cb`	function	called back with list of running containers

Source:

containers.js , lineno 236

dockops::Containers::listImage(imageName, cb)

Lists all containers that were created from a particular image.

Parameters:

Name	Type	Description
`imageName`	string	name of image for which to list containers
`cb`	function

Source:

containers.js , lineno 253

dockops::Containers::listRunning(cb)

Lists all running docker containers

Parameters:

Name	Type	Description
`cb`	function	called back with list of running containers

Source:

containers.js , lineno 225

dockops::Containers::listStopped(cb)

Lists all stopped docker containers

Parameters:

Name	Type	Description
`cb`	function	called back with list of stopped containers

Source:

containers.js , lineno 191

dockops::Containers::remove(id, cb)

Removes the container with the given id

Parameters:

Name	Type	Description
`id`	string	id of the container to remove
`cb`	function	called back when container was removed

Source:

containers.js , lineno 375

dockops::Containers::removeGroup(group, cb)

Removes all containers that were created from images belonging to a given group.

Parameters:

Name	Type	Description
`group`	string	group for which to remove containers
`cb`	function

Source:

containers.js , lineno 441

dockops::Containers::removeImage(name, cb)

Removes all containers that were created from the image with the given name

Parameters:

Name	Type	Description
`name`	string	name of the image for which to remove containers
`cb`	function	called back when containers were removed

Source:

containers.js , lineno 396

dockops::Containers::removeStopped(cb)

Removes all stopped containers.

Parameters:

Name	Type	Description
`cb`	function	called back when all stopped containers where removed.

Source:

containers.js , lineno 416

dockops::Containers::run(opts, cb)

Creates and starts a container.

Parameters:

Name Type Description

opts

Object

container creation and start options

Properties

Name	Type	Argument	Description
`create`	Object		creation options passed to dockerode
`start`	Object		start options passed to `container.start`
`startRetries`	Object	<optional>	(default: 0) determines how many times we retry to start the container in case it fails

cb

function

called when the container was started - with an error if it failed

Source:

containers.js , lineno 61

dockops::Containers::stop(id, cb)

Stops the container with the given id

Parameters:

Name	Type	Description
`id`	string	id of the container to stop
`cb`	function	called back when container was stopd

Source:

containers.js , lineno 302

dockops::Containers::stopGroup(group, cb)

Stops all containers that were created from images belonging to a given group.

Parameters:

Name	Type	Description
`group`	string	group for which to stop containers
`cb`	function

Source:

containers.js , lineno 322

dockops::Containers::stopImage(name, cb)

Stops all containers that were created from the image with the given name

Parameters:

Name	Type	Description
`name`	string	name of the image for which to stop containers
`cb`	function	called back when containers were stopped

Source:

containers.js , lineno 354

dockops::Containers::stopRemove(id, cb)

Stops and then removes the container with the given id

Parameters:

Name	Type	Description
`id`	string	id of the container to stop and remove
`cb`	function	called back when container was stopped and removed

Source:

containers.js , lineno 472

dockops::Containers::stopRemoveGroup(group, cb)

Stops and then removes all containers created from images belonging to a given group.

Parameters:

Name	Type	Description
`group`	string	group for which to remove containers
`cb`	function

Source:

containers.js , lineno 518

dockops::Containers::stopRemoveImage(name, cb)

Stops and then removes all containers that were created from the image with the given name

Parameters:

Name	Type	Description
`name`	string	name of the image for which to stop and remove containers
`cb`	function	called back when containers were stopped and removed

Source:

containers.js , lineno 497

dockops::createDocker(dockerhost) → {Object}

Convenience function to create a dockerode instance.

Parameters:

Name	Type	Argument	Description
`dockerhost`	string	<optional>	(default: `'unix:///var/run/docker.sock'`) the docker host can also be `http` or `tcp`

Source:

lib/create-docker.js , lineno 19

Returns:

dockerode instance

Type: Object

dockops::Images(docker) → {Object}

Creates a new images instance that will use the given docker instance to communicate with docker.

Parameters:

Name	Type	Description
`docker`	Object	dockerode instance to communicate with docker

Source:

images.js , lineno 14

Returns:

initialized images

Type: Object

dockops::Images::build(tarStream, image, cb)

Builds an image from the stream provided. All intermediate containers are removed after the image was created.

All events from the tar stream are re-emitted, especially useful if it was created with dockerify.

Parameters:

Name	Type	Description
`tarStream`	Stream	the tar stream that contains the project files and a `Dockerfile`
`image`	string	then name under which to tag the created image
`cb`	function	called back when image is created or with an error if one occurred

Source:

images.js , lineno 65

dockops::Images::buildStream(tarStream, image, cb)

Builds an image from the stream provided. All intermediate containers are removed after the image was created.

Note: if you want all events from the tar stream to be propagated, i.e. if it was created with dockerify, use build instead.

Parameters:

Name	Type	Description
`tarStream`	Stream	the tar stream that contains the project files and a `Dockerfile`
`image`	string	then name under which to tag the created image
`cb`	function	called back when image is created or with an error if one occurred

Source:

images.js , lineno 32

dockops::Images::deserializeImageName(name) → {Object}

Deserializes the given image name into an object.

Parameters:

Name	Type	Description
`name`	string	the name of the image, expected to be in the format: `'group:tag'`.

Source:

images.js , lineno 104

Returns:

object of the format: { group: 'group', tag: 'tag' }

Type: Object

dockops::Images::list(cb)

Lists docker images.

Parameters:

Name	Type	Description
`cb`	function	called back with list of images

Source:

images.js , lineno 120

dockops::Images::listGroup(group, cb)

Lists docker images for given group.

Parameters:

Name	Type	Description
`group`	string	name of the group of images to list
`cb`	function	called back with list of images

Source:

images.js , lineno 131

dockops::Images::removeGroup(group, cb)

Removes all images for the given group

Parameters:

Name	Type	Description
`group`	string	name of the group of images to remove
`cb`	function	called back when the images were removed

Source:

images.js , lineno 159

dockops::logEvents(events, level)

Logs events emitted with npm log at the given level.

debug events are logged as verbose.

Parameters:

Name	Type	Description
`events`	EventEmitter	events that should be logged
`level`	string	(default: verbose) level of logging `error\|warn\|info\|verbose\|silly`

Source:

lib/log-events.js , lineno 7

dockops::portBindings(exposePort, hostPort) → {Object}

Helper function to creat a proper tcp portbinding for the given ports

Parameters:

Name	Type	Argument	Description
`exposePort`	number		the port of the docker container to expose to the host
`hostPort`	number	<optional>	(default: `0` which causes docker to pick a port) the host port to which to bind the exposed port

Source:

lib/port-bindings.js , lineno 5

Returns:

the port binding to pass to docker when creating a container

Type: Object

generated with docme

License

MIT

dockops

dockops

Installation

API

dockops::Containers(docker) → {Object}

Parameters:

Returns:

dockops::Containers::activePorts(cb)

Parameters:

dockops::Containers::clean(id, cb)

Parameters:

dockops::Containers::create(opts, cb)

Parameters:

dockops::Containers::listAll(cb)

Parameters:

dockops::Containers::listGroup(group, cb)

Parameters:

dockops::Containers::listGroupRunning(group, cb)

Parameters:

dockops::Containers::listImage(imageName, cb)

Parameters:

dockops::Containers::listRunning(cb)

Parameters:

dockops::Containers::listStopped(cb)

Parameters:

dockops::Containers::remove(id, cb)

Parameters:

dockops::Containers::removeGroup(group, cb)

Parameters:

dockops::Containers::removeImage(name, cb)

Parameters:

dockops::Containers::removeStopped(cb)

Parameters:

dockops::Containers::run(opts, cb)

Parameters:

Properties

dockops::Containers::stop(id, cb)

Parameters:

dockops::Containers::stopGroup(group, cb)

Parameters:

dockops::Containers::stopImage(name, cb)

Parameters:

dockops::Containers::stopRemove(id, cb)

Parameters:

dockops::Containers::stopRemoveGroup(group, cb)

Parameters:

dockops::Containers::stopRemoveImage(name, cb)

Parameters:

dockops::createDocker(dockerhost) → {Object}

Parameters:

Returns:

dockops::Images(docker) → {Object}

Parameters:

Returns:

dockops::Images::build(tarStream, image, cb)

Parameters:

dockops::Images::buildStream(tarStream, image, cb)

Parameters:

dockops::Images::deserializeImageName(name) → {Object}

Parameters:

Returns:

dockops::Images::list(cb)

Parameters:

dockops::Images::listGroup(group, cb)

Parameters:

dockops::Images::removeGroup(group, cb)

Parameters:

dockops::logEvents(events, level)

Parameters:

dockops::portBindings(exposePort, hostPort) → {Object}

Parameters:

Returns:

License

Readme

Keywords

Package Sidebar

Install

Repository

Homepage

DownloadsWeekly Downloads

Weekly Downloads