Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 1.64 KB

.verb.md

File metadata and controls

69 lines (44 loc) · 1.64 KB
Raw

{%= name %} {%= badge("travis") %}

{%= description %}

higher-docker-manager

HigherDockerManager is built on top of node-docker-api offering some higher-order management functions. node-docker-api is not included as dependency but referenced as a peer dependency.

Install

Install with npm:

$ npm install --save higher-docker-manager node-docker-api@^1.1.2

Usage

const HigherDockerManager = require('{%= name %}');

return HigherDockerManager.pullImage({}, 'hello-world:latest')
    .then(() => HigherDockerManager.runTemporaryContainer({
        image: 'hello-world:latest'
    }))
    .then((output) => {
        assert(_.isArray(output));
        assert(output[1].payload, 'Hello from Docker!\n');
    });

Features

  • Pulling an image from a repository
  • Finding process's own container if its running in Docker
  • Running a temporary container
  • Executing a command in a running container
  • Finding containers by networks, labels and images
  • Finding volumes by labels and their values
  • Finding networks by labels and their values

API

{%= apidocs("lib/higher-docker-manager.js") %}

Related projects

{%= section("related", related(verb.related.list)) %}

Author

{%= includeEither("authors", "author") %}

Contributing

{%= include("contributing") %}

Revision history

{%= include("CHANGELOG.md") %}

License

{%= copyright({linkify: true, prefix: "Copyright", symbol: "©"}) %} {%= before.license ? (before.license + "\n") : "" %}{%= license %}{%= after.license ? (after.license + "\n") : "" %}

{%= include("footer") %}