- Notifications
You must be signed in to change notification settings - Fork0
gleeds/dockerode
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Not another Node.js Docker Remote API module.
Whydockerode is different from other Docker node.js modules:
- streams -
dockerodedoes NOT break any stream, it passes them to you allowing for some stream voodoo. - stream demux - Supports optional demultiplexing.
- entities - containers, images and execs are defined entities and not random static methods.
- run -
dockerodeallow you to seamless run commands in a container aladocker run. - tests -
dockerodereally aims to have a good test set, allowing to followDockerchanges easily, quickly and painlessly. - feature-rich - There's a real effort in keepingAll
DockerRemote API features implemented and tested.
npm install dockerode
- Input options are directly passed to Docker. CheckDocker Remote API documentation for more details.
- Return values are unchanged from Docker, official Docker documentation will also apply to them.
- Check the tests and examples folder for more examples.
To usedockerode first you need to instantiate it:
varDocker=require('dockerode');vardocker=newDocker({socketPath:'/var/run/docker.sock'});vardocker1=newDocker();//defaults to above if env variables are not usedvardocker2=newDocker({host:'http://192.168.1.10',port:3000});vardocker3=newDocker({protocol:'http',host:'127.0.0.1',port:3000});vardocker4=newDocker({host:'127.0.0.1',port:3000});//defaults to http//protocol http vs https is automatically detectedvardocker5=newDocker({host:'192.168.1.10',port:process.env.DOCKER_PORT||2375,ca:fs.readFileSync('ca.pem'),cert:fs.readFileSync('cert.pem'),key:fs.readFileSync('key.pem')});vardocker6=newDocker({protocol:'https',//you can enforce a protocolhost:'192.168.1.10',port:process.env.DOCKER_PORT||2375,ca:fs.readFileSync('ca.pem'),cert:fs.readFileSync('cert.pem'),key:fs.readFileSync('key.pem')});//...
// create a container entity. does not query APIvarcontainer=docker.getContainer('71501a8ab0f8');// query API for container infocontainer.inspect(function(err,data){console.log(data);});container.start(function(err,data){console.log(data);});container.remove(function(err,data){console.log(data);});//...
You may also specify default options for each container's operations, which will always be used for the specified container and operation.
container.defaultOptions.start.Binds=["/tmp:/tmp:rw"];
docker.listContainers(function(err,containers){containers.forEach(function(containerInfo){docker.getContainer(containerInfo.Id).stop(cb);});});
docker.buildImage('archive.tar',{t:imageName},function(err,response){//...});
docker.createContainer({Image:'ubuntu',Cmd:['/bin/bash'],name:'ubuntu-test'},function(err,container){container.start(function(err,data){//...});});//...
//tty:truedocker.createContainer({/*...*/Tty:true/*...*/},function(err,container){/* ... */container.attach({stream:true,stdout:true,stderr:true},function(err,stream){stream.pipe(process.stdout);});/* ... */}//tty:falsedocker.createContainer({/*...*/Tty:false/*...*/},function(err,container){/* ... */container.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);});/* ... */}docker.createImage({fromImage:'ubuntu'},function(err,stream){stream.pipe(process.stdout);});//...
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.
docker.run('ubuntu',['bash','-c','uname -a'],process.stdout,function(err,data,container){console.log(data.StatusCode);});
or, if you want to split stdout and stderr (you must to passTty:false as an option for this to work)
docker.run('ubuntu',['bash','-c','uname -a'],[process.stdout,process.stderr],{Tty:false},function(err,data,container){console.log(data.StatusCode);});
Run also returns an EventEmitter supporting the following events: container, stream, data. Allowing stuff like this:
docker.run('ubuntu',['bash','-c','uname -a'],[process.stdout,process.stderr],{Tty:false},function(err,data,container){//...}).on('container',function(container){container.defaultOptions.start.Binds=["/tmp:/tmp:rw"];});
repoTag- container image name (optionally with tag)myrepo/myname:withtagopts- extra options passed to create image.callback- callback called when execution ends.
docker.pull('myrepo/myname:tag',function(err,stream){// streaming output from pull...});
Tests are implemented usingmocha andchai. Run them withnpm 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.htmlUnless 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.
About
Not just another Docker Remote API node.js module
Resources
Stars
Watchers
Forks
Packages0
Languages
- JavaScript100.0%