aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 21 insertions, 4 deletions
diff --git a/README.md b/README.md
index 311d131..822eee7 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
Hydra Suite - Cloud Command and Control
=======================================
-The Hydra Suite is a complete set of tools for orchestration and management
-of network of computers.
+The Hydra Suite is a complete set of tools for orchestration and management of
+network of machines.
This suite is made of three commands:
@@ -10,15 +10,23 @@ This suite is made of three commands:
- 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.
+
Installation
------------
First, clone the code:
git clone git://git.sarava.org/hydra.git
- cd hydra && git tag -v
-Then add hydra folder to your `$PATH` or run the following command to install
+Then check the source integrity of the latest release:
+
+ cd hydra
+ tag="`git describe --abbrev=0 --tags`
+ git tag -v $tag && git checkout $tag # check the source!
+
+Finally, add hydra folder to your `$PATH` or run the following command to install
it under `/usr/local`:
./hydractl deploy
@@ -39,3 +47,12 @@ Use the following commands to create the needed repositories when starting a new
hydra example init ~/file/example
hydra example config domain example.org
+
+Dependencies
+------------
+
+Major direct upstreams:
+
+* [https://www.debian.org Debian].
+* [http://docs.puppetlabs.com Puppet].
+* [Shared Puppet Modules Initiative](https://labs.riseup.net/code/projects/sharedpuppetmodules).