docker-api

Docker Remote API driver for node.js. It uses the same modem than dockerode, but the interface is promisified and with a different syntax.

Support for:

• streams
• stream demux
• entities
• run
• tests
• promises
• full es6 support

The current status of the package is in beta state. This module covers the full API reference, including experimental stuff such as plugins.

Check the reference and the tests for full examples.

Installation

1$ npm install node-docker-api

Usage

You can find more into the examples folder

Create, start, stop, restart and remove a container

1'use strict';
2const {Docker} = require('node-docker-api');
3
4const docker = new Docker({ socketPath: '/var/run/docker.sock' });
5
6docker.container.create({
7  Image: 'ubuntu',
8  name: 'test'
9})
10  .then(container => container.start())
11  .then(container => container.stop())
12  .then(container => container.restart())
13  .then(container => container.delete({ force: true }))
14  .catch(error => console.log(error));

List, inspect and top containers

1'use strict';
2const {Docker} = require('node-docker-api');
3
4const docker = new Docker({ socketPath: '/var/run/docker.sock' });
5
6// List
7docker.container.list()
8   // Inspect
9  .then(containers => containers[0].status())
10  .then(container => container.top())
11  .then(processes => console.log(processes))
12  .catch(error => console.log(error));

List, inspect and stat containers

1'use strict';
2const {Docker} = require('node-docker-api');
3
4const docker = new Docker({ socketPath: '/var/run/docker.sock' });
5
6// List
7docker.container.list()
8   // Inspect
9  .then(containers => containers[0].status())
10  .then(container => container.stats())
11  .then(stats => {
12    stats.on('data', stat => console.log('Stats: ', stat.toString()))
13    stats.on('error', err => console.log('Error: ', err))
14  })
15  .catch(error => console.log(error));

Get logs of a container

1'use strict';
2const {Docker} = require('node-docker-api');
3
4const docker = new Docker({ socketPath: '/var/run/docker.sock' });
5let container;
6
7docker.container.create({
8  Image: 'ubuntu',
9  name: 'test'
10})
11  .then(container => container.logs({
12    follow: true,
13    stdout: true,
14    stderr: true
15  }))
16  .then(stream => {
17    stream.on('data', info => console.log(info))
18    stream.on('error', err => console.log(err))
19  })
20  .catch(error => console.log(error));

Export a container

1const {Docker} = require('node-docker-api');
2const fs = require('fs');
3
4const docker = new Docker({ socketPath: '/var/run/docker.sock' });
5let container;
6
7docker.container.create({
8  Image: 'ubuntu',
9  name: 'test'
10})
11  .then(container => container.start())
12  .then(container => container.export())
13  .then(content => {
14    const file = fs.createWriteStream("container.tar");
15    file.end(content)
16  })
17  .catch(error => console.log(error));

Manipulate file system in a container

1'use strict';
2const fs = require('fs');
3const {Docker} = require('node-docker-api');
4
5const promisifyStream = stream => new Promise((resolve, reject) => {
6  stream.on('data', data => console.log(data.toString()))
7  stream.on('end', resolve)
8  stream.on('error', reject)
9});
10
11const docker = new Docker({ socketPath: '/var/run/docker.sock' });
12let container;
13
14docker.container.create({
15  Image: 'ubuntu',
16  Cmd: [ '/bin/bash', '-c', 'tail -f /var/log/dmesg' ],
17  name: 'test'
18})
19  .then(container => container.start())
20  .then(_container => {
21    container = _container
22    return _container.fs.put('./file.tar', {
23      path: 'root'
24    })
25  })
26  .then(stream => promisifyStream(stream))
27  .then(() => container.fs.get({ path: '/var/log/dmesg' }))
28  .then(stream => {
29    const file = fs.createWriteStream("file.jpg");
30    stream.pipe(file);
31    return promisifyStream(stream);
32  })
33  .then(() => container.status())
34  .then(container => container.stop())
35  .catch(error => console.log(error));

Execute commands and kill containers

1'use strict';
2const {Docker} = require('node-docker-api');
3
4const promisifyStream = stream => new Promise((resolve, reject) => {
5  stream.on('data', data => console.log(data.toString()))
6  stream.on('end', resolve)
7  stream.on('error', reject)
8});
9
10const docker = new Docker({ socketPath: '/var/run/docker.sock' });
11let _container;
12
13docker.container.create({
14  Image: 'ubuntu',
15  Cmd: [ '/bin/bash', '-c', 'tail -f /var/log/dmesg' ],
16  name: 'test'
17})
18  .then(container => container.start())
19  .then(container => {
20    _container = container
21    return container.exec.create({
22      AttachStdout: true,
23      AttachStderr: true,
24      Cmd: [ 'echo', 'test' ]
25    })
26  })
27  .then(exec => {
28    return exec.start({ Detach: false })
29  })
30  .then(stream => promisifyStream(stream))
31  .then(() => _container.kill())
32  .catch(error => console.log(error));

Build, inspect and remove an image

1'use strict';
2const {Docker} = require('node-docker-api');
3const tar = require('tar-fs');
4
5const promisifyStream = stream => new Promise((resolve, reject) => {
6  stream.on('data', data => console.log(data.toString()))
7  stream.on('end', resolve)
8  stream.on('error', reject)
9});
10
11const docker = new Docker({ socketPath: '/var/run/docker.sock' });
12
13var tarStream = tar.pack('/path/to/Dockerfile')
14docker.image.build(tarStream, {
15  t: 'testimg'
16})
17  .then(stream => promisifyStream(stream))
18  .then(() => docker.image.get('testimg').status())
19  .then(image => image.remove())
20  .catch(error => console.log(error));

Pull and check history of an image

1'use strict';
2const {Docker} = require('node-docker-api');
3
4const promisifyStream = (stream) => new Promise((resolve, reject) => {
5  stream.on('data', (d) => console.log(d.toString()))
6  stream.on('end', resolve)
7  stream.on('error', reject)
8})
9
10const docker = new Docker({ socketPath: '/var/run/docker.sock' })
11
12return docker.image.create({}, { fromImage: 'ubuntu', tag: 'latest' })
13  .then(stream => promisifyStream(stream))
14  .then(() => docker.image.get('ubuntu').status())
15  .then(image => image.history())
16  .then(events => console.log(events))
17  .catch(error => console.log(error))

Fetch events from docker

1'use strict'
2const fs = require('fs');
3const {Docker} = require('node-docker-api');
4
5const promisifyStream = stream => new Promise((resolve, reject) => {
6    stream.on('data', data => console.log(data.toString()))
7    stream.on('end', resolve)
8    stream.on('error', reject)
9})
10
11const docker = new Docker({ socketPath: '/var/run/docker.sock' })
12
13docker.events({
14    since: ((new Date().getTime() / 1000) - 60).toFixed(0)
15})
16  .then(stream => promisifyStream(stream))
17  .catch(error => console.log(error))