From 4b48b6851411bdbd77edc833490ece79b0eddbf2 Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Fri, 20 Feb 2015 15:42:11 +0000 Subject: [PATCH] Tweak docs introduction A bit punchier and tweaked the formatting to make it consistent with other docs/projects. Signed-off-by: Ben Firshman --- README.md | 22 ++++++++++++---------- userguide.md | 25 +++++++++++++------------ 2 files changed, 25 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 856d84b82c..a6fb65627e 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,20 @@ ![Docker Swarm Logo](logo.png?raw=true "Docker Swarm Logo") -`swarm` is a simple tool which controls a cluster of Docker hosts and exposes it -as a single "virtual" host. +Docker Swarm is native clustering for Docker. It turns a pool of Docker hosts +into a single, virtual host. -`swarm` uses the standard Docker API as its frontend, which means any tool which -speaks Docker can control swarm transparently: dokku, fig, krane, flynn, deis, -docker-ui, shipyard, drone.io, Jenkins... and of course the Docker client itself. +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 the 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. +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 diff --git a/userguide.md b/userguide.md index 3cae1237a1..e6c0d72f71 100644 --- a/userguide.md +++ b/userguide.md @@ -4,21 +4,22 @@ page_description: Swarm: a Docker-native clustering system page_keywords: docker, swarm, clustering --- -# Docker Swarm: a Docker-native clustering system +# Docker Swarm -Docker `swarm` helps you control a cluster of Docker hosts (known as nodes) -and expose them as a single "virtual" host. +Docker Swarm is native clustering for Docker. It turns a pool of Docker hosts +into a single, virtual host. -The Docker `swarm` manager can be interacted with using the Docker API, which means -any tool which can communicate with a Docker Daemon using that API, can control -a Docker swarm transparently: dokku, fig, krane, flynn, deis, docker-ui, shipyard, -drone.io, Jenkins... and of course the Docker client itself. +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 the 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. +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