]> gitweb.fluxo.info Git - hydra.git/commitdiff
Updates docs
authorSilvio Rhatto <rhatto@riseup.net>
Thu, 16 Jun 2016 19:37:19 +0000 (16:37 -0300)
committerSilvio Rhatto <rhatto@riseup.net>
Thu, 16 Jun 2016 19:37:19 +0000 (16:37 -0300)
doc/index.rst
doc/management.rst

index 2821a3fcc4c4e75562cf274995306c747a75f632..7298a9f8edfdac14956185d63e615fdbf394982f 100644 (file)
@@ -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
index cbdede8c2da0c44268c757c92cb3da3de702f5fc..85427b819db3e0c308004e7a210f4ede7fcef3ca 100644 (file)
@@ -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
 ----------------------------