Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/arhea/harbor-master

🛥️ Harbor Master is a Docker Remote API client written in Node.js
https://github.com/arhea/harbor-master
docker docker-api docker-sdk harbor-master nodejs npm npm-module swarm
Last synced: about 9 hours ago
JSON representation
🛥️ Harbor Master is a Docker Remote API client written in Node.js
Host: GitHub
URL: https://github.com/arhea/harbor-master
Owner: arhea
Created: 2017-01-14T22:57:30.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2023-10-13T21:27:02.000Z (about 1 year ago)
Last Synced: 2024-04-23T02:21:12.115Z (7 months ago)
Topics: docker, docker-api, docker-sdk, harbor-master, nodejs, npm, npm-module, swarm
Language: JavaScript
Homepage:
Size: 168 KB
Stars: 75
Watchers: 6
Forks: 18
Open Issues: 11
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # Harbor Master

[![Build Status](https://travis-ci.org/arhea/harbor-master.svg?branch=master)](https://travis-ci.org/arhea/harbor-master)

[![NPM](https://nodei.co/npm/harbor-master.png?downloads=true&downloadRank=true)](https://nodei.co/npm/harbor-master/)

[![NPM](https://nodei.co/npm-dl/harbor-master.png?months=6&height=3)](https://nodei.co/npm/harbor-master/)

Harbor Master is a Docker Remote API client written in Node. This client is meant to be a simple wrapper that makes it easy to communicate with your Docker Daemon over the unix socket or http based APIs.

This project is still in active development. This project will be versioned in accordance with the Docker Remote API. For example, if the current Docker Remote API version is `1.32`, Harbor Master's version will be `1.32.x`.

## Table of Contents

- [Examples](#examples)

- [Documentation](#documentation)

  + [Client](#client)

  + [API](#api)

    + [Configs](#configs)

    + [Containers](#containers)

    + [Images](#images)

    + [Networks](#networks)

    + [Volumes](#volumes)

    + [Secrets](#secrets)

    + [Swarm](#swarm)

    + [Nodes](#nodes)

    + [Services](#services)

    + [Tasks](#task)

    + [Plugins](#plugins)

    + [Systems](#system)

## Examples

### Unix Socket Example

```javascript

const docker = require('../index');

const client = docker.Client({

  socket: '/var/run/docker.sock'

});

client.info().then((info) => {

  console.log(info);

}).catch((err) => {

  console.error(err);

});

```

### Remote Host Example

```javascript

const docker = require('../index');

const client = docker.Client({

  host: 'swarm.example.com',

  port: '2375'

});

client.info().then((info) => {

  console.log(info);

}).catch((err) => {

  console.error(err);

});

```

### SSL Configuration

```javascript

const docker = require('../index');

const client = docker.Client({

  host: 'swarm.example.com',

  port: '2376',

  tls: {

    ca: fs.readFileSync('ca.pem'),

    cert: fs.readFileSync('cert.pem'),

    key: fs.readFileSync('key.pem'),

    passphrase: 'supersecretpass'

  }

});

client.info().then((info) => {

  console.log(info);

}).catch((err) => {

  console.error(err);

});

```

## API Documentation

#### `docker.Client(options)` - Harbor Master Client

- `options`

  + `host` - the IP address or Hostname of the Docker server

  + `port` - the port number the Docker server exposes

  + `socket` - the unix socket

  + `tls`

    * `cert` - contents of the server certificate

    * `key` - contents of the server certificate key

    * `ca` - contents of the CA certificate

    * `password` - the certificate password

### Configs

#### `client.configs().list(options)` - List Configs

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ConfigList)

- `options`

  + `filters` - `map[string][]string` to process on the configs list

#### `client.configs().create(model, options)` - Create Config

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ConfigCreate)

- `model` - the JSON model that the Docker API consumes

- `options`

#### `client.configs().inspect(id, options)` - Inspect Config

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ConfigInspect)

- `id` - the id or name of the config

- `options`

#### `client.configs().remove(id, options)` - Remove Config

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ConfigDelete)

- `name` - the id of the config

- `options`

#### `client.configs().update(id, model, options)` - Update Config

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ConfigUpdate)

- `id` - the id or name of the config

- `model` - the JSON model that the Docker API consumes

- `options`

  + `version` - The version number of the config object being updated. This is required to avoid conflicting writes.

### Containers

#### `client.containers().list(options)` - List Containers

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerList)

- `options`

  + `all` - *default: `false`* Show all containers. Only running containers are shown by default.

  + `limit` - Show limit last created containers, include non-running ones.

  + `since` -  Show only containers created since Id, include non-running ones.

  + `before` - Show only containers created before Id, include non-running ones.

  + `size` - *default: `false`* Show the containers sizes

  + `filters` - `map[string][]string` to process on the containers list

#### `client.containers().create(model, options)` - Create Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate)

- `model` - the JSON model that the Docker API consumes

- `options`

  + `name` - Assign the specified name to the container. Must match `/?[a-zA-Z0-9_-]+`.

#### `client.containers().inspect(name, options)` - Inspect Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerInspect)

- `name` - the name or id of the container

- `options`

  + `size` - *default: `false`* Show the containers sizes

#### `client.containers().top(name)` - List Processes Running Inside a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerTop)

- `name` - the name or id of the container

- `options`

  + `ps_args` - `ps` arguments to use (e.g., aux), defaults to `-ef`

#### `client.containers().logs(name, options)` - Container Logs

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerLogs)

- `name` - the name or id of the container

- `options`

  + `details` - Show extra details provided to logs. *default: `false`*

  + `follow` - return stream. *default: `false`*

  + `stdout` - show stdout log. *default: `false`*

  + `stderr` - show stderr log. *default: `false`*

  + `since` - Specifying a timestamp will only output log-entries since that timestamp. *default: `false`*

  + `timestamps` - print timestamps for every log line *default: `false`*

  + `tail` - Output specified number of lines at the end of logs: all or  *default: `all`*

#### `client.containers().changes(name, options)` - Inspect Container Filesystem Changes

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerChanges)

- `name` - the name or id of the container

- `options`

#### `client.containers().export(name, options)` - Export a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerExport)

- `name` - the name or id of the container

- `options`

#### `client.containers().stats(name, options)` - Export a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerStats)

- `name` - the name or id of the container

- `options`

  + `stream` - stream statistics *default: `true`*

#### `client.containers().resize(name, options)` - Resize a container TTY

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerResize)

- `name` - the name or id of the container

- `options`

  + `h` - height

  + `w` - width

#### `client.containers().start(name, options)` - Start a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerStart)

- `name` - the name or id of the container

- `options`

  + `detachKeys` - Override the key sequence for detaching a container. Format is a single character.

#### `client.containers().stop(name, options)` - Stop a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerStop)

- `name` - the name or id of the container

- `options`

  + `t` - number of seconds to wait before killing the container

#### `client.containers().restart(name, options)` - Restart a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerRestart)

- `name` - the name or id of the container

- `options`

  + `t` - number of seconds to wait before killing the container

#### `client.containers().kill(name, options)` - Kill a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerKill)

- `name` - the name or id of the container

- `options`

  + `signal` - Signal to send to the container: integer or string like SIGINT. When not set, SIGKILL is assumed and the call waits for the container to exit.

#### `client.containers().update(name, model, options)` - Update a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerUpdate)

- `name` - the name or id of the container

- `model` - the JSON model that the Docker API consumes

- `options`

#### `client.containers().rename(name, options)` - Rename a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerRename)

- `name` - the name or id of the container

- `options`

  + `name` - new name for the container

#### `client.containers().pause(name)` - Pause a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerPause)

- `name` - the name or id of the container

- `options`

#### `client.containers().unpause(name)` - Unpause a Container

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/unpause-a-container)

- `name` - the name or id of the container

- `options`

#### `client.containers().attach(name, options)` - Attach a Container

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/attach-to-a-container)

- `name` - the name or id of the container

- `options`

  + `detachKeys` - Override the key sequence for detaching a container. Format is a single character

  + `logs` - return logs *default: `false`*

  + `stream` - return stream *default: `false`*

  + `stdin` - return stdin *default: `false`*

  + `stdout` - return stdout *default: `false`*

  + `stderr` - return stderr *default: `false`*

#### `client.containers().unpause(name, options)` - Wait a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerPause)

- `name` - the name or id of the container

- `options`

#### `client.containers().remove(name, options)` - Wait a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ContainerDelete)

- `name` - the name or id of the container

- `options`

  + `v` - Remove the volumes associated to the container *default: `false`*

  + `force` - Kill then remove the container *default: `false`*

### Images

#### `client.images().list(options)` - Wait a Container

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageList)

- `options`

  + `filters` - `map[string][]string` to process on the images list

#### `client.images().build(stream, options, registryAuth)` - Build an Image From a Dockerfile

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageBuild)

- `options`

  +

- `registryAuth`

  + `username`

  + `password`

  + `serveraddress`

#### `client.images().create(options, registryAuth)` - Create Image

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageCreate)

- `options`

  + `fromImage`

  + `fromSrc`

  + `repo`

  + `q`

  + `tag`

- `registryAuth`

  + `username`

  + `password`

  + `serveraddress`

#### `client.images().inspect(name, options)` - Inspect an Image

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageInspect)

- `name` - the name or id of the image

- `options`

#### `client.images().history(name, options)` - History of an Image

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageHistory)

- `name` - the name or id of the image

- `options`

#### `client.images().push(name, options, registryAuth)` - Push an Image on the Registry

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImagePush)

- `name` - the name or id of the image

- `options`

  + `tag`

- `registryAuth`

  + `username`

  + `password`

  + `serveraddress`

#### `client.images().tag(name, options)` - Tag an Image

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageTag)

- `name` - the name or id of the image

- `options`

  + `repo`

  + `tag`

#### `client.images().remove(name, options)` - Remove of Image

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageDelete)

- `name` - the name or id of the image

- `options`

  + `repo`

  + `tag`

#### `client.images().search(options)` - Search Images

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ImageSearch)

- `name` - the name or id of the image

- `options`

  + `term`

  + `limit`

  + `filters`

### Networks

#### `client.networks().list(options)` - List Networks

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NetworkList)

- `options`

  + `filters` - JSON encoded network list filter.

#### `client.networks().create(model, options)` - Create a Network

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NetworkCreate)

- `model` - a json model representing the network

- `options`

#### `client.networks().inspect(id, options)` - Inspect a Network

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NetworkInspect)

- `id` - the network id or name

- `options`

#### `client.networks().remove(id, options)` - Remove a Network

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NetworkDelete)

- `id` - the network id or name

- `options`

#### `client.networks().connect(id, options)` - Connect a Container to a Network

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NetworkConnect)

- `id` - the network id or name

- `options`

#### `client.networks().disconnect(id, options)` - Disconnect a Container to a Network

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NetworkDisconnect)

- `id` - the network id or name

- `options`

### Nodes

#### `client.nodes().list(options)` - List Nodes

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NetworkDisconnect)

- `id` - the node id

- `options`

  + `filters` - JSON encoded node list filter.

#### `client.nodes().inspect(id, options)` - Inspect a Node

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NodeInspect)

- `id` - the node id

- `options`

#### `client.nodes().remove(id, options)` - Remove a Node

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NodeDelete)

- `id` - the node id

- `options`

#### `client.nodes().update(id, options)` - Update A Node

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/NodeUpdate)

- `id` - the node id

- `options`

  + `version` - The version number of the node object being updated. This is required to avoid conflicting writes.

### Plugins

#### `client.plugins().list(options)` - List Plugins

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#list-plugins)

- `options`

  + `filters` - a JSON encoded value of the filters (a map[string][]string) to process on the services list.

#### `client.plugins().install(options)` - Install a Plugin

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#install-a-plugin)

- `options`

  + `name` - Name of the plugin to pull. The name may include a tag or digest. This parameter is required.

#### `client.plugins().inspect(id, options)` - Inspect a Plugin

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#inspect-a-plugin)

- `options`

#### `client.plugins().enable(id, options)` - Enable a Plugin

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#enable-a-plugin)

- `options`

#### `client.plugins().disable(id, options)` - Disable a Plugin

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#disable-a-plugin)

- `options`

#### `client.plugins().remove(id, options)` - Remove a Plugin

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#remove-a-plugin)

- `options`

### Services

#### `client.services().list(options)` - List Services

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-services)

- `options`

  + `filters` - a JSON encoded value of the filters (a map[string][]string) to process on the services list.

#### `client.services().create(options, registryAuth)` - Create a Service

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-service)

- `options`

#### `client.services().remove(id, options)` - Remove a Service

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-service)

- `id` - id or name of the service

- `options`

#### `client.services().inspect(id, options)` - Inspect a Service

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-one-or-more-services)

- `id` - id or name of the service

- `options`

#### `client.services().logs(id, options)` - Get Service Logs

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/ServiceLogs)

- `id` - id or name of the service

- `options`

  + `details` - boolean, Show extra details provided to logs.

  + `follow` - boolean, Return the logs as a stream.

  + `stdout` - boolean, Return logs from stdout

  + `stderr` - boolean, Return logs from stderr

  + `since` - number, Only return logs since this time, as a UNIX timestamp

  + `timestamps` - boolean, Add timestamps to every log line

  + `tail` - Only return this number of log lines from the end of the logs. Specify as an integer or all to output all log lines.

#### `client.services().update(id, options, registryAuth)` - Update a Service

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/update-a-service)

- `id` - id or name of the service

- `options`

  + `version` - The version number of the service object being updated. This is required to avoid conflicting writes.

### Swarm

#### `client.swarm().info(options)` - Swarm Info

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/swarm)

- `options`

#### `client.swarm().init(options)` - Initialize a Swarm

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/initialize-a-new-swarm)

- `options`

#### `client.swarm().join(options)` - Join a Swarm

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/join-an-existing-swarm)

- `options`

#### `client.swarm().leave(options)` - Leave a Swarm

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/join-an-existing-swarm)

- `options`

  + `force` - Boolean (false/true). Force leave swarm, even if this is the last manager or that it will break the cluster.

#### `client.swarm().update(options)` - Update a Swarm

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/update-a-swarm)

- `options`

  + `version` - The version number of the swarm object being updated. This is required to avoid conflicting writes.

  + `rotateWorkerToken` - Set to true to rotate the worker join token.

  + `rotateManagerToken` - Set to true to rotate the manager join token.

### Tasks

#### `client.tasks().list(options)` - List Services

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-tasks)

- `options`

  + `filters` - a JSON encoded value of the filters (a map[string][]string) to process on the tasks list.

#### `client.tasks().inspect(id, options)` - Inspect a Task

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-one-or-more-services)

- `options`

### Volumes

#### `client.volumes().list(options)` - List Volumes

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-volumes)

- `options`

  + `filters` - a JSON encoded value of the filters (a map[string][]string) to process on the volumes list.

#### `client.volumes().create(options, registryAuth)` - Create a Volume

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#create-a-volume)

- `id` or name of the volume

- `options`

#### `client.volumes().remove(id, options)` - Remove a Volume

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#remove-a-volume)

- `id` or name of the volume

- `options`

#### `client.volumes().inspect(id, options)` - Inspect a Volume

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#inspect-a-volume)

- `id` or name of the volume

- `options`

### Secrets

#### `client.secrets().list(options)` - List Secret

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/SecretList)

- `options`

  + `filters` - `map[string][]string` to process on the secrets list

#### `client.secrets().create(model, options)` - Create Secret

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/SecretCreate)

- `model` - the JSON model that the Docker API consumes

- `options`

#### `client.secrets().inspect(id, options)` - Inspect Secret

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/SecretInspect)

- `id` - the id or name of the secret

- `options`

#### `client.secrets().remove(id, options)` - Remove Secret

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/SecretDelete)

- `name` - the id of the secret

- `options`

#### `client.secrets().update(id, model, options)` - Update Secret

- [Docker Documentation](https://docs.docker.com/engine/api/v1.32/#operation/SecretUpdate)

- `id` - the id or name of the secret

- `model` - the JSON model that the Docker API consumes

- `options`

  + `version` - The version number of the secret object being updated. This is required to avoid conflicting writes.

### Daemon

#### `client.info()` - System Wide Information

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#display-system-wide-information)

#### `client.auth(options)` - Authentication Configuration

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#check-auth-configuration)

- `options`

  + `username`

  + `password`

  + `serveraddress`

#### `client.version()` - Version

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#show-the-docker-version-information)

#### `client.ping()` - Ping Daemon

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#ping-the-docker-server)

#### `client.events()` - Events Stream

- [Docker Documentation](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#monitor-dockers-events)

- `options`

  + `since` - Timestamp. Show all events created since timestamp and then stream

  + `until` - Timestamp. Show events created until given timestamp and stop streaming

  + `filters` - value of the filters (a map[string][]string) to process on the event list