Source repo for Docker's Documentation
Go to file
Victor Vieux b655cbb7c5 Merge pull request #514 from technolo-g/Issue_499_Automate_golint_pr
Issue #500 Run golint on codebase
2015-03-30 12:14:15 -07:00
Godeps update Godeps 2015-03-17 17:41:46 -07:00
api Merge pull request #514 from technolo-g/Issue_499_Automate_golint_pr 2015-03-30 12:14:15 -07:00
cluster Fix lint violations 2015-03-27 21:17:44 -06:00
discovery Merge pull request #514 from technolo-g/Issue_499_Automate_golint_pr 2015-03-30 12:14:15 -07:00
docs Fix 404s that manifest in GitHub but not in the Docs site. Links should work in both. 2015-03-25 20:45:19 -07:00
scheduler Fix lint violations 2015-03-27 21:17:44 -06:00
script Enable coveralls. 2015-03-13 18:15:45 -07:00
state Fix lint violations 2015-03-27 21:17:44 -06:00
test/integration make SWARM_ROOT configurable 2015-03-26 22:51:09 +07:00
version Bump version to 0.2.0 2015-03-23 14:56:45 -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 Enable coveralls. 2015-03-13 18:15:45 -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 Fixing the Readme file. 2015-03-26 20:20:34 -04:00
ROADMAP.md Update ROADMAP.md 2015-03-30 10:26:34 -07:00
flags.go Fix lint violations 2015-03-27 21:17:44 -06: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 Fix lint violations 2015-03-27 21:17:44 -06:00
manage.go Fix lint violations 2015-03-27 21:17:44 -06:00

README.md

Swarm: a Docker-native clustering system

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 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.

Then install the swarm binary:

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.