npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mdock

v1.0.2

Published

combine multiple docker servers as though they were one massive docker

Downloads

6

Readme

mdock

(m)ultiple (dock)ers

Container Ships

combine multiple docker servers as though they were one massive docker

similar to the libswarm aggregate backend

install

$ npm install mdock

usage

An mdock proxy will route HTTP requests from the standard docker client back to a collection of docker hosts.

You pass functions to decide on routing and to list the current inventory.

var http = require('http')
var mdock = require("mdock")

var dockers = mdock()

// we need a list of all servers in our cluster
dockers.on('list', function(next){

	// we can load the list from a database
	// it should return an array of server objects
	listServers(next)
})

// we need to route a container onto a single server
dockers.on('route', function(info, next){
	if(info.container){
		// route based on the container info
		var containerName = info.name
		var containerInfo = info.container

		// you can remap properties of the container before it reaches the docker server
		next(null, server)
	}
	else if(info.image){
		// route based on the image name
		var imageName = info.image
		next(null, server)
	}
})

dockers.on('map', function(info, next){

	// here we can change properties of the info.container before it is launched
	// we can also study the image for exposed ports and volumes
	
})

dockers.on('start', function(info, next){

	// here we can change properties of the info.boot record
	// the container and image have been created and so are immutable
	
})

var server = http.createServer(function(req, res){

	// we can do custom auth/routing logic here
	dockers.handle(req, res)	
})

// this is important if we want docker attach to work
server.httpAllowHalfOpen = true

// we now have a multi-docker server compatable with the standard docker client
server.listen(80)

api

var dockers = mdock()

Create a new mdock proxy

events

dockers.on('route', function(info, next){})

Called when a new container needs allocating to a docker server

This function is your chance to customize your network by changing what server / environment variables etc

if it is a container then info is an object with the following properties:

  • name - the name of the container
  • image - the name of the image
  • container - the JSON object describing the container

if it is an image, then info is an object with the following properties:

  • image - the name of the image

It is up to you to keep state between POST /containers/create and POST /images/create for docker run commands

Call next with a string representing the docker server to send the request to e.g. 127.0.0.1:2375

Any changes made to the info will apply to the forwarded request - this lets you intercepts create requests and route them where you choose and change environment variables etc

dockers.on('route', function(info, next){
	doSomeAsyncStuff(function(err, meta){
		info.container.name = meta.name
		next(null, meta.server)
	})
})

dockers.on('map', function(info, next){})

Called just before calling /containers/create but once the image has been downloaded onto the machine

Info is an object with the following properties:

  • name - the name of the container (immutable)
  • image - a JSON object describing the image (immutable)
  • backend - a JSON object describing the host (immutable)
  • container - a JSON object describing the container (mutable)

You can change the properties of container - image is immutable but contains the data for the image (this can be used to discover ports from within the Dockerfile not mentioned in the docker run command)

The backend is the host the container is being routed to.

dockers.on('map', function(info, next){

	// read properties of the info.image
	// change properties of the info.container

	next()
})

dockers.on('start', function(info, next){})

  • name - the name of the container (immutable)
  • image - a JSON object describing the image (immutable)
  • backend - a JSON object describing the host (immutable)
  • container - a JSON object describing the container (immutable)
  • boot - a JSON object describing the boot record (mutable)

Called when a request to /containers/start is captured.

containerJSON and imageJSON are the records loaded from the already routed docker server and are immutable.

bootJSON is the JSON body of the /containers/start request and can be changed

dockers.on('map', function(info, next){

	// change properties of the info.boot
	// read properties of the image and container

	next()
})

dockers.on('list', function(next){})

Called when the proxy needs a list of all current servers

An array of docker endpoint strings should be returned

var dockerServers = [{
	hostname:'node1',
	docker:'192.168.8.120:2375'
},{
	hostname:'node2',
	docker:'192.168.8.121:2375'
},{
	hostname:'node3',
	docker:'192.168.8.122:2375'
}]

dockers.on('list', function(next){
	next(null, dockerServers)
})

server.httpAllowHalfOpen

Because of the way docker attach works - you must set this property to true on the http server to allow attach traffic to travel via the proxy

// this is important if we want docker attach to work
server.httpAllowHalfOpen = true
server.listen(80)

license

MIT