Source repo for Docker's Documentation
Go to file
Victor Vieux 57ef27efcc fix consul help
Signed-off-by: Victor Vieux <victorvieux@gmail.com>
2015-04-23 14:41:21 -07:00
Godeps Updated dockerclient and fixed API changes. 2015-04-15 14:32:51 -07:00
api add force-refresh when commit/tag/pull 2015-04-20 02:45:06 -04:00
cli fix consul help 2015-04-23 14:41:21 -07:00
cluster Add Node Labels to Cluster Info information 2015-04-21 20:30:19 +00:00
discovery golint: DiscoveryService -> Discovery 2015-04-15 14:26:39 -07:00
docs Fixed typo 2015-04-14 13:50:51 -04:00
scheduler Merge pull request #646 from chanwit/fix-const-overflow 2015-04-20 17:44:29 -07:00
script Exclude CLI from unit tests coverage 2015-04-18 20:26:55 -07:00
state [Store] Drop an index variable in Store.All 2015-04-02 00:04:43 +03:00
test Merge pull request #652 from jimmyxian/add-pause-unpause-inspect-integration-test 2015-04-22 19:54:21 -07:00
version bump version to 0.3.0 2015-04-21 15:03:51 -07: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 Change to make Travis-CI run correctly on forks of docker/swarm 2015-04-16 19:12:08 -07:00
CONTRIBUTING.md tweak workflow for godep update 2015-03-25 20:18:02 +07: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 README: Link to godoc reference 2015-04-18 20:45:57 -07:00
ROADMAP.md Update ROADMAP.md 2015-04-22 16:37:35 -07:00
logo.png smaller logo 2014-12-03 11:47:55 +01:00
main.go Cleanup: Move CLI related files to a subpackage. 2015-04-18 20:26:55 -07:00

README.md

Swarm: a Docker-native clustering system

GoDoc Build Status Coverage 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 set of simple scheduling backends out of the box, and as initial development settles, an API will be developed to enable pluggable backends. The goal is to provide a smooth out-of-the-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, godep and the git client installed.

For example, on Ubuntu you'd run:

$ apt-get install golang git
$ go get github.com/tools/godep

You may need to set $GOPATH, e.g mkdir ~/gocode; export GOPATH=~/gocode.

For example, on Mac OS X you'd run:

$ brew install go
$ export GOPATH=~/go
$ export PATH=$PATH:~/go/bin
$ go get github.com/tools/godep

Then install the swarm binary:

$ mkdir -p $GOPATH/src/github.com/docker/
$ cd $GOPATH/src/github.com/docker/
$ git clone https://github.com/docker/swarm
$ cd swarm
$ godep go install .

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.

Our planning process and release cycle are detailed on the wiki

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.