Source repo for Docker's Documentation
Go to file
Victor Vieux 426953c866 add inspect for images
Signed-off-by: Victor Vieux <vieux@docker.com>
2015-03-03 16:30:31 -08:00
Godeps update dockerclient 2015-02-27 14:17:02 -08:00
api add inspect for images 2015-03-03 16:30:31 -08:00
cluster swarm.Node -> swarm.node && some method now private 2015-03-02 18:02:31 -08:00
discovery add an index and go make some small tweaks 2015-02-26 11:19:14 +10:00
docs Add beta warning to docs 2015-02-26 10:54:50 +00:00
scheduler Corrected typos in swarm scheduler docs 2015-02-28 03:31:49 -05:00
script docker-compose examples: Remove affinities. 2015-02-10 13:26:21 -08:00
state state: Store container ID in requested state. 2015-01-19 13:25:27 -08:00
test/integration add Bats integration tests 2015-03-04 03:13:30 +07:00
version add VERSION file 2015-02-03 01:53:01 +00:00
.gitignore improve locks 2014-11-18 23:04:11 +00:00
.godir update .godir 2014-11-18 21:47:00 +00:00
.travis.yml hack code to not error on go vet 2015-02-02 18:20:41 +00:00
CONTRIBUTING.md Add Contributing doc 2014-12-07 00:54:19 +00:00
Dockerfile Dockerfile: Set swarm to bind to all interfaces in container mode. 2015-02-02 18:44:22 -08:00
LICENSE use tcp:// in doc and update copyrights 2015-01-12 22:58:03 +00:00
README.md cluster API instead of scheduler API 2015-02-27 14:20:37 -08:00
ROADMAP.md Update ROADMAP.md 2015-02-09 11:01:23 -08:00
flags.go cluster API instead of scheduler API 2015-02-27 14:20:37 -08:00
help.go Use actual binary name instead of hardcoding it 2015-01-24 08:27:36 +00:00
join.go improve some logs 2015-01-26 23:41:56 +00:00
join_test.go allow hostnames in join 2015-01-16 01:47:38 +00:00
logo.png smaller logo 2014-12-03 11:47:55 +01:00
main.go cluster API instead of scheduler API 2015-02-27 14:20:37 -08:00
manage.go remove mesos.go to move it to it's own PR 2015-02-27 14:25:50 -08:00

README.md

Swarm: a Docker-native clustering system Build Status

Docker Swarm Logo

Docker Swarm is native clustering for Docker. It turns a pool of Docker hosts into a single, virtual host.

Swarm serves the standard Docker API, so any tool which already communicates with a Docker daemon can use Swarm to transparently scale to multiple hosts: Dokku, Compose, Krane, Flynn, Deis, DockerUI, Shipyard, Drone, Jenkins... and, of course, the Docker client itself.

Like other Docker projects, Swarm follows the "batteries included but removable" principle. It ships with a simple scheduling backend out of the box, and as initial development settles, an API will develop to enable pluggable backends. The goal is to provide a smooth out-of-box experience for simple use cases, and allow swapping in more powerful backends, like Mesos, for large scale production deployments.

Installation and documentation

Full documentation is available here.

Development installation

You can download and install from source instead of using the Docker image.

Ensure you have golang and git client installed (e.g. apt-get install golang git on Ubuntu). You may need to set $GOPATH, e.g mkdir ~/gocode; export GOPATH=~/gocode.

The install swarm binary to your $GOPATH directory.

go get -u github.com/docker/swarm

From here, you can follow the instructions in the main documentation, replacing docker run swarm with just swarm.

Participating

We welcome pull requests and patches; come say hi on IRC, #docker-swarm on freenode.

Creators

Andrea Luzzardi

Victor Vieux

Code and documentation copyright 2014-2015 Docker, inc. Code released under the Apache 2.0 license.

Docs released under Creative commons.