node-docker-api

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>node-docker-api</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">node-docker-api</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> All <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="globals.html">Globals</a> </li> </ul> <h1> node-docker-api</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <h1 id="docker-api">docker-api</h1> <a href="https://travis-ci.org/AgustinCB/docker-api"><img src="https://travis-ci.org/AgustinCB/docker-api.png?branch=master" alt="travis-ci"></a> Docker Remote API driver for node.js. It uses the same modem than <a href="https://github.com/apocas/dockerode">dockerode</a>, but the interface is promisified and with a different syntax. Support for: <ul> <li>streams</li> <li>stream demux</li> <li>entities</li> <li>run</li> <li>tests</li> <li>promises</li> <li>full es6 support</li> </ul> The current status of the package is in beta state. This module covers the full <a href="https://docs.docker.com/engine/api/v1.26">API reference</a>, including experimental stuff such as plugins. Check the <a href="https://github.com/AgustinCB/docker-api/tree/master/docs">reference</a> and the <a href="https://github.com/AgustinCB/docker-api/tree/master/test">tests</a> for full examples. <h2 id="installation">Installation</h2> <code>npm install node-docker-api</code> <h2 id="usage">Usage</h2> <h3 id="create-start-stop-restart-and-remove-a-container">Create, start, stop, restart and remove a container</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker let docker = new Docker({ socketPath: '/var/run/docker.sock' }) docker.container.create({ Image: 'ubuntu', name: 'test' }) .then((container) => container.start()) .then((container) => container.stop()) .then((container) => container.restart()) .then((container) => container.delete({ force: true })) .catch((error) => console.log(error)) </code></pre> <h3 id="list-inspect-and-top-containers">List, inspect and top containers</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker let docker = new Docker({ socketPath: '/var/run/docker.sock' }) // List docker.container.list() // Inspect .then((containers) => containers[0].status()) .then((container) => container.top()) .then((processes) => console.log(processes)) .catch((error) => console.log(error)) </code></pre> <h3 id="list-inspect-and-stat-containers">List, inspect and stat containers</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker let docker = new Docker({ socketPath: '/var/run/docker.sock' }) // List docker.container.list() // Inspect .then((containers) => containers[0].status()) .then((container) => container.stats()) .then((stats) => { stats.on('data', (stat) => console.log('Stats: ',stat)) stats.on('error', (err) => console.log('Error: ', err)) }) .catch((error) => console.log(error)) </code></pre> <h3 id="get-logs-of-a-container">Get logs of a container</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker let docker = new Docker({ socketPath: '/var/run/docker.sock' }) let container docker.container.create({ Image: 'ubuntu', name: 'test' }) .then((container) => container.logs({ follow: true, stdout: true, stderr: true })) .then((stream) => { stream.on('data', (info) => console.log(info)) stream.on('error', (err) => console.log(err)) }) .catch((error) => console.log(error)) </code></pre> <h3 id="export-a-container">Export a container</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker, fs = require('fs') let docker = new Docker({ socketPath: '/var/run/docker.sock' }) let container docker.container.create({ Image: 'ubuntu', name: 'test' }) .then((container) => container.start()) .then((container) => container.export()) .then((content) => { let file = fs.createWriteStream("container.tar"); file.end(content) }) .catch((error) => console.log(error)) </code></pre> <h3 id="manipulate-file-system-in-a-container">Manipulate file system in a container</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker, fs = require('fs') const promisifyStream = (stream) => new Promise((resolve, reject) => { stream.on('data', (d) => console.log(d.toString())) stream.on('end', resolve) stream.on('error', reject) }) let docker = new Docker({ socketPath: '/var/run/docker.sock' }) let container docker.container.create({ Image: 'ubuntu', Cmd: [ '/bin/bash', '-c', 'tail -f /var/log/dmesg' ], name: 'test' }) .then((container) => container.start()) .then((_container) => { container = _container return _container.fs.put('./file.tar', { path: 'root' }) }) .then((stream) => promisifyStream(stream)) .then(() => container.fs.get({ path: '/var/log/dmesg' })) .then((stream) => { let file = fs.createWriteStream("file.jpg"); stream.pipe(file) return promisifyStream(stream) }) .then(() => container.status()) .then((container) => container.stop()) .catch((error) => console.log(error)) </code></pre> <h3 id="execute-commands-and-kill-containers">Execute commands and kill containers</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker const promisifyStream = (stream) => new Promise((resolve, reject) => { console.log(stream); stream.on('data', (d) => console.log(d.toString())) stream.on('end', resolve) stream.on('error', reject) }) let docker = new Docker({ socketPath: '/var/run/docker.sock' }) docker.container.create({ Image: 'ubuntu', Cmd: [ '/bin/bash', '-c', 'tail -f /var/log/dmesg' ], name: 'test' }) .then((container) => container.start()) .then((_container) => { container = _container return container.exec.create({ Cmd: [ "top" ] }) }) .then((exec) => { return exec.start() }) .then((stream) => { stream.on('data', (info) => { console.log(info.toString()) _container.kill() }) stream.on('error', (err) => console.log(err)) }) .catch((error) => console.log(error)) </code></pre> <h3 id="build-inspect-and-remove-an-image">Build, inspect and remove an image</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker, tar = require('tar-fs') const promisifyStream = (stream) => new Promise((resolve, reject) => { stream.on('data', (d) => console.log(d.toString())) stream.on('end', resolve) stream.on('error', reject) }) let docker = new Docker({ socketPath: '/var/run/docker.sock' }) var tarStream = tar.pack('/path/to/Dockerfile') docker.image.build(tarStream, { t: 'testimg' }) .then((stream) => promisifyStream(stream)) .then(() => docker.image.status('testimg')) .then((image) => image.remove()) .catch((error) => console.log(error)) </code></pre> <h3 id="pull-and-check-history-of-an-image">Pull and check history of an image</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker const promisifyStream = (stream) => new Promise((resolve, reject) => { stream.on('data', (d) => console.log(d.toString())) stream.on('end', resolve) stream.on('error', reject) }) let docker = new Docker({ socketPath: '/var/run/docker.sock' }) return docker.image.create({}, { fromImage: 'ubuntu', tag: 'latest' }) .then((stream) => promisifyStream(stream)) .then(() => docker.image.status('ubuntu')) .then((image) => image.history()) .then((events) => console.log(events)) .catch((error) => console.log(error)) </code></pre> <h3 id="fetch-events-from-docker">Fetch events from docker</h3> <pre><code class="lang-js">const Docker = require('node-docker-api').Docker, fs = require('fs') const promisifyStream = (stream) => new Promise((resolve, reject) => { stream.on('data', (d) => console.log(data)) stream.on('end', resolve) stream.on('error', reject) }) let docker = new Docker({ socketPath: '/var/run/docker.sock' }) docker.events({ since: ((new Date().getTime() / 1000) - 60).toFixed(0) }) .then((container) => container.events()) .then((stream) => promisifyStream(stream)) .catch((error) => console.log(error)) </code></pre> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="globals.html">Globals</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_container_.html">"container"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_docker_.html">"docker"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_image_.html">"image"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_network_.html">"network"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_node_.html">"node"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_plugin_.html">"plugin"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_secret_.html">"secret"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_service_.html">"service"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_swarm_.html">"swarm"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_task_.html">"task"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_volume_.html">"volume"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module">Module</li> <li class="tsd-kind-object-literal">Object literal</li> <li class="tsd-kind-variable">Variable</li> <li class="tsd-kind-function">Function</li> <li class="tsd-kind-function tsd-has-type-parameter">Function with type parameter</li> <li class="tsd-kind-index-signature">Index signature</li> <li class="tsd-kind-type-alias">Type alias</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum">Enumeration</li> <li class="tsd-kind-enum-member">Enumeration member</li> <li class="tsd-kind-property tsd-parent-kind-enum">Property</li> <li class="tsd-kind-method tsd-parent-kind-enum">Method</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface">Interface</li> <li class="tsd-kind-interface tsd-has-type-parameter">Interface with type parameter</li> <li class="tsd-kind-constructor tsd-parent-kind-interface">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-interface">Property</li> <li class="tsd-kind-method tsd-parent-kind-interface">Method</li> <li class="tsd-kind-index-signature tsd-parent-kind-interface">Index signature</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class">Class</li> <li class="tsd-kind-class tsd-has-type-parameter">Class with type parameter</li> <li class="tsd-kind-constructor tsd-parent-kind-class">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-class">Property</li> <li class="tsd-kind-method tsd-parent-kind-class">Method</li> <li class="tsd-kind-accessor tsd-parent-kind-class">Accessor</li> <li class="tsd-kind-index-signature tsd-parent-kind-class">Index signature</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">Inherited constructor</li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited">Inherited property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited">Inherited method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">Inherited accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected">Protected property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected">Protected method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected">Protected accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private">Private property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private">Private method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private">Private accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static">Static property</li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static">Static method</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script> </body> </html>