aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2016-06-16 16:37:19 -0300
committerSilvio Rhatto <rhatto@riseup.net>2016-06-16 16:37:19 -0300
commitc05feecd9554cedde58c8343db9035259ea5b35a (patch)
tree554d90b59490427d44d4efa55f12b6ffb556b9df
parent5cc48c99abd1fe914cc48cb37e63f65a91453524 (diff)
downloadhydra-c05feecd9554cedde58c8343db9035259ea5b35a.tar.gz
hydra-c05feecd9554cedde58c8343db9035259ea5b35a.tar.bz2
Updates docs
-rw-r--r--doc/index.rst15
-rw-r--r--doc/management.rst11
2 files changed, 17 insertions, 9 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 2821a3f..7298a9f 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,17 +1,14 @@
Hydra Suite - Cloud Command and Control
=======================================
-The Hydra Suite is a complete set of tools for orchestration and management of
-network of machines.
+Hydra is a suite for orchestration and management of machines composed of
+the following basic commands:
-This suite is made of three commands:
+* `hydractl`: act in the current host.
+* `hydra`: act on at set of hosts.
+* `hydras`: act on a superset of hosts.
-* `hydractl`: issues commands in the current host.
-* `hydra`: issues commands on multiple hosts.
-* `hydras`: issues commands to multiple sets of hosts.
-
-It is also built around a set of Puppet modules which does the actual
-configuration of each system.
+See further documentation for details:
.. toctree::
:maxdepth: 1
diff --git a/doc/management.rst b/doc/management.rst
index cbdede8..85427b8 100644
--- a/doc/management.rst
+++ b/doc/management.rst
@@ -1,6 +1,15 @@
Management
==========
+Sets and supersets
+------------------
+
+The Hydra Suite is flexible enough so you can use it to:
+
+* Manage a single machine using `hydractl` command.
+* Manage a set or a subset of machines -- a *network* -- from the same organization using `hydra` command.
+* Manage a superset of machines -- *a constelation* -- comprised of one or more organizations using `hydras` command.
+
Creating a new network
----------------------
@@ -11,6 +20,8 @@ Use the following commands to create the needed repositories when starting a new
hydra example init ~/file/example
hydra example config domain example.org
+This makes `~/files/example` the base folder for all configuration of the network of machines called `example`.
+
Managing an existing network
----------------------------