Source repo for Docker's Documentation
Go to file
Kushal Pisavadia 78dba5d623 Remove prefixes from DiscoveryService implementations
All of these structs are public. Previously when they were used, they'd
look like the following:

 - `consul.ConsulDiscoveryService`
 - `etcd.EtcdDiscoveryService`
 - `file.FileDiscoveryService`
 - `nodes.NodesDiscoveryService`
 - `token.TokenDiscoveryService`
 - `zookeeper.ZkDiscoveryService`

As a result, they stuttered when read. This commit removes the
duplication of the package names on the struct so that they read better.

See also: https://golang.org/ref/spec#Import_declarations

Signed-off-by: Kushal Pisavadia <kushi.p@gmail.com>
2015-04-15 20:58:17 +01:00
Godeps update Godeps 2015-03-17 17:41:46 -07:00
api Update README.md 2015-04-09 10:44:28 +08:00
cluster Improve Error message to show node's Name and IP 2015-04-14 11:27:02 -07:00
discovery Remove prefixes from DiscoveryService implementations 2015-04-15 20:58:17 +01:00
docs Fixed typo 2015-04-14 13:50:51 -04:00
scheduler Fixed typo 2015-04-14 13:48:42 -04:00
script Enable coveralls. 2015-03-13 18:15:45 -07:00
state [Store] Drop an index variable in Store.All 2015-04-02 00:04:43 +03:00
test/integration Merge pull request #581 from chanwit/test-file-discovery 2015-04-13 12:07:40 -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 Closes #499: Enable golint on PRs 2015-03-30 21:39:00 -06: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 Did a quick pass on the docs to fix numerous formatting, spelling and grammar errors 2015-04-14 11:59:50 -04:00
ROADMAP.md Update ROADMAP.md 2015-04-13 19:32:17 -07:00
flags.go disable cluster flag 2015-04-03 16:33:48 -07:00
help.go Use actual binary name instead of hardcoding it 2015-01-24 08:27:36 +00:00
join.go Change heartbeat type to unsigned int 2015-04-09 00:04:50 +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 Remove prefixes from DiscoveryService implementations 2015-04-15 20:58:17 +01:00
manage.go Change heartbeat type to unsigned int 2015-04-09 00:04:50 +00: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 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.