diff --git a/README.md b/README.md index 8406ebf551..a959a56830 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,13 @@ 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 +## Installation and documentation -###1 - Docker image. -The easiest way to get started with Swarm is to use the -[official Docker image](https://registry.hub.docker.com/_/swarm/). +Full documentation [is available here](http://docs.docker.com/swarm/). -```sh -docker pull swarm -``` +## Development installation -###2 - Alternative: Download and install from source. -Alternatively, you can download and install from source instead of using the -Docker image. +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`. @@ -40,63 +34,8 @@ The install `swarm` binary to your `$GOPATH` directory. go get -u github.com/docker/swarm ``` -###3 - Nodes setup -The only requirement for Swarm nodes is to run a regular Docker daemon (version -`1.4.0` and later). - -In order for Swarm to be able to communicate with its nodes, they must bind on a -network interface. This can be achieved by starting Docker with the `-H` flag -(e.g. `-H tcp://0.0.0.0:2375`). - -# Example usage - -```bash -# create a cluster -$ docker run --rm swarm create -6856663cdefdec325839a4b7e1de38e8 # <- this is your unique - -# on each of your nodes, start the swarm agent -# doesn't have to be public (eg. 192.168.0.X), -# as long as the swarm manager can access it. -$ docker run -d swarm join --addr= token:// - -# start the manager on any machine or your laptop -$ docker run -d -p :2375 swarm manage token:// - -# use the regular docker cli -$ docker -H tcp:// info -$ docker -H tcp:// run ... -$ docker -H tcp:// ps -$ docker -H tcp:// logs ... -... - -# list nodes in your cluster -$ docker run --rm swarm list token:// - -``` - -See [here](discovery) for more information about -other discovery services. - -## Advanced Scheduling - -See [filters](scheduler/filter) and [strategies](scheduler/strategy) to learn -more about advanced scheduling. - -## TLS - -Swarm supports TLS authentication between the CLI and Swarm but also between -Swarm and the Docker nodes. - -In order to enable TLS, the same command line options as Docker can be specified: - -`swarm manage --tlsverify --tlscacert= --tlscert= --tlskey= [...]` - -Please refer to the [Docker documentation](https://docs.docker.com/articles/https/) -for more information on how to set up TLS authentication on Docker and generating -the certificates. - -Note that Swarm certificates must be generated with`extendedKeyUsage = clientAuth,serverAuth`. +From here, you can follow the instructions [in the main documentation](http://docs.docker.com/swarm/), +replacing `docker run swarm` with just `swarm`. ## Participating