From: Steven Dake <sdake@redhat.com>
Date: Tue, 27 Mar 2012 17:35:47 +0000 (-0700)
Subject: Add README to tools directory to help point out what files do
X-Git-Tag: 2014.1~2151
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=903529c05a7767344c5ea56bf77820257b3e5be2;p=openstack-build%2Fheat-build.git

Add README to tools directory to help point out what files do

Signed-off-by: Steven Dake <sdake@redhat.com>
---

diff --git a/tools/README b/tools/README
new file mode 100644
index 00000000..c143f60c
--- /dev/null
+++ b/tools/README
@@ -0,0 +1,21 @@
+Files in this directory are general developer tools or examples of how
+to do certain activities.
+
+-----
+Tools
+-----
+
++ experimental_create.py
+     - Example of creating an keypair and instantiating an instance after
+        one has been registered with JEOS create
+
++ openstack - WARNING COULD DESTROY DATA
+    - Installs, Uninstalls, starts, and stops openstack from the RPM repoistory
+      on F16 or F17.  This provides a consistent way for developers to deploy
+      openstack in a consistent painless way.
+
+      THIS IS NOT INTENDED FOR END USERS AS IT COULD PERMANENTLY DESTROY DATA
+      AND DOES NOT PROPERLY SECURE THE INSTALLATION.
+
++ experimental_ssh_eventlet.py
+     - Example of using ssh inside python with eventlets.