Name: dockerode
Owner: Shipyard
Description: Not just another Docker Remote API node.js module
Created: 2015-11-09 05:13:58.0
Updated: 2016-07-01 17:37:37.0
Pushed: 2015-11-10 13:43:51.0
Size: 1180
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Not another Node.js Docker Remote API module.
Why dockerode
is different from other Docker node.js modules:
dockerode
does NOT break any stream, it passes them to you allowing for some stream voodoo.dockerode
allow you to seamless run commands in a container ala docker run
.dockerode
really aims to have a good test set, allowing to follow Docker
changes easily, quickly and painlessly.Docker
Remote API features implemented and tested.npm install dockerode
To use dockerode
first you need to instantiate it:
Docker = require('dockerode');
docker = new Docker({socketPath: '/var/run/docker.sock'});
docker1 = new Docker(); //defaults to above if env variables are not used
docker2 = new Docker({host: 'http://192.168.1.10', port: 3000});
docker3 = new Docker({protocol:'http', host: '127.0.0.1', port: 3000});
docker4 = new Docker({host: '127.0.0.1', port: 3000}); //defaults to http
otocol http vs https is automatically detected
docker5 = new Docker({
st: '192.168.1.10',
rt: process.env.DOCKER_PORT || 2375,
: fs.readFileSync('ca.pem'),
rt: fs.readFileSync('cert.pem'),
y: fs.readFileSync('key.pem')
docker6 = new Docker({
otocol: 'https', //you can enforce a protocol
st: '192.168.1.10',
rt: process.env.DOCKER_PORT || 2375,
: fs.readFileSync('ca.pem'),
rt: fs.readFileSync('cert.pem'),
y: fs.readFileSync('key.pem')
.
reate a container entity. does not query API
container = docker.getContainer('71501a8ab0f8');
uery API for container info
ainer.inspect(function (err, data) {
nsole.log(data);
ainer.start(function (err, data) {
nsole.log(data);
ainer.remove(function (err, data) {
nsole.log(data);
.
You may also specify default options for each container's operations, which will always be used for the specified container and operation.
ainer.defaultOptions.start.Binds = ["/tmp:/tmp:rw"];
er.listContainers(function (err, containers) {
ntainers.forEach(function (containerInfo) {
docker.getContainer(containerInfo.Id).stop(cb);
;
er.buildImage('archive.tar', {t: imageName}, function (err, response){
...
er.createContainer({Image: 'ubuntu', Cmd: ['/bin/bash'], name: 'ubuntu-test'}, function (err, container) {
ntainer.start(function (err, data) {
//...
;
.
y:true
er.createContainer({ /*...*/ Tty: true /*...*/ }, function(err, container) {
... */
ntainer.attach({stream: true, stdout: true, stderr: true}, function (err, stream) {
stream.pipe(process.stdout);
;
... */
y:false
er.createContainer({ /*...*/ Tty: false /*...*/ }, function(err, container) {
... */
ntainer.attach({stream: true, stdout: true, stderr: true}, function (err, stream) {
//dockerode may demultiplex attach streams for you :)
container.modem.demuxStream(stream, process.stdout, process.stderr);
;
... */
er.createImage({fromImage: 'ubuntu'}, function (err, stream) {
ream.pipe(process.stdout);
.
docker run
in dockerode
:image
- container imagecmd
- command to be executedstream
- stream(s) which will be used for execution output.create_options
- options used for container creation. (optional)start_options
- options used for container start. (optional)callback
- callback called when execution ends.er.run('ubuntu', ['bash', '-c', 'uname -a'], process.stdout, function (err, data, container) {
nsole.log(data.StatusCode);
or, if you want to split stdout and stderr (you must to pass Tty:false
as an option for this to work)
er.run('ubuntu', ['bash', '-c', 'uname -a'], [process.stdout, process.stderr], {Tty:false}, function (err, data, container) {
nsole.log(data.StatusCode);
Run also returns an EventEmitter supporting the following events: container, stream, data. Allowing stuff like this:
er.run('ubuntu', ['bash', '-c', 'uname -a'], [process.stdout, process.stderr], {Tty:false}, function (err, data, container) {
...
n('container', function (container) {
ntainer.defaultOptions.start.Binds = ["/tmp:/tmp:rw"];
docker pull
in dockerode
:repoTag
- container image name (optionally with tag)
myrepo/myname:withtag
opts
- extra options passed to create image.callback
- callback called when execution ends.er.pull('myrepo/myname:tag', function (err, stream) {
streaming output from pull...
docker-modem
already base64 encodes the necessary auth object for you.
auth = {
ername: 'username',
ssword: 'password',
th: '',
ail: 'your@email.email',
rveraddress: 'https://index.docker.io/v1'
er.pull('tag', {'authconfig': auth}, function (err, stream) {
...
If you already have a base64 encoded auth object, you can use it directly:
auth = { key: 'yJ1J2ZXJhZGRyZXNzIjoitZSI6Im4OCIsImF1dGgiOiIiLCJlbWFpbCI6ImZvbGllLmFkcmc2VybmF0iLCJzZX5jb2aHR0cHM6Ly9pbmRleC5kb2NrZXIuaW8vdZvbGllYSIsInBhc3N3b3JkIjoiRGVjZW1icmUjEvIn0=' }
followProgress
- allows to fire a callback only in the end of a stream based process. (build, pull, …)llowProgress(stream, onFinished, [onProgress])
er.pull(repoTag, function(err, stream) {
...
cker.modem.followProgress(stream, onFinished, onProgress);
nction onFinished(err, output) {
//output is an array with output json parsed objects
//...
nction onProgress(event) {
//...
demuxStream
- demux stdout and stderrmuxStream(stream, stdout, stderr)
ainer.attach({
ream: true,
dout: true,
derr: true
unction handler(err, stream) {
...
ntainer.modem.demuxStream(stream, process.stdout, process.stderr);
...
docker pull ubuntu:latest
to prepare your system for the tests.
Tests are implemented using mocha
and chai
. Run them with npm test
.
Check the examples folder for more specific use cases examples.
Pedro Dias - @pedromdias
Licensed under the Apache license, version 2.0 (the “license”); You may not use this file except in compliance with the license. You may obtain a copy of the license at:
http://www.apache.org/licenses/LICENSE-2.0.html
Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an “as is” basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.