From 9ada0ed03299c99e7cc6f53bb12a327581bebf89 Mon Sep 17 00:00:00 2001
From: Roger Luethi <rl@patchworkscience.org>
Date: Mon, 16 Jun 2014 12:21:26 +0200
Subject: [PATCH] Add README.rst for subdirectories

This changeset adds README.rst files to several subdirectories
to explain their content and purpose.

Partial-Bug: 1312764
Implements: blueprint openstack-training-labs
Change-Id: Ibba6a68d104b2aade412a06d63ed49467fb2bba3
---
 labs/autostart/README.rst  |  2 ++
 labs/config/README.rst     |  2 ++
 labs/img/README.rst        |  3 +++
 labs/lib/README.rst        | 10 ++++++++++
 labs/lib/wbatch/README.rst |  2 ++
 labs/log/README.rst        |  5 +++++
 labs/scripts/README.rst    |  8 ++++++++
 labs/wbatch/README.rst     |  7 +++++++
 8 files changed, 39 insertions(+)
 create mode 100644 labs/autostart/README.rst
 create mode 100644 labs/config/README.rst
 create mode 100644 labs/img/README.rst
 create mode 100644 labs/lib/README.rst
 create mode 100644 labs/lib/wbatch/README.rst
 create mode 100644 labs/log/README.rst
 create mode 100644 labs/scripts/README.rst
 create mode 100644 labs/wbatch/README.rst

diff --git a/labs/autostart/README.rst b/labs/autostart/README.rst
new file mode 100644
index 00000000..eff56aca
--- /dev/null
+++ b/labs/autostart/README.rst
@@ -0,0 +1,2 @@
+osbash/wbatch copy shell scripts (*.sh) into this directory to have them
+automatically executed (and removed) upon boot.
diff --git a/labs/config/README.rst b/labs/config/README.rst
new file mode 100644
index 00000000..7251284c
--- /dev/null
+++ b/labs/config/README.rst
@@ -0,0 +1,2 @@
+The configuration files in this directory are used by osbash/wbatch and
+by scripts running inside the VMs (scripts directory).
diff --git a/labs/img/README.rst b/labs/img/README.rst
new file mode 100644
index 00000000..4768db41
--- /dev/null
+++ b/labs/img/README.rst
@@ -0,0 +1,3 @@
+By default, osbash will put into this directory its base disk images
+(base-*-<distro>.vdi), the VM export images (oslabs-<distro>.ova),
+and all installation ISO images it may download.
diff --git a/labs/lib/README.rst b/labs/lib/README.rst
new file mode 100644
index 00000000..7c226dac
--- /dev/null
+++ b/labs/lib/README.rst
@@ -0,0 +1,10 @@
+This directory contains bash libraries used by scripts.
+
+Configuration files for kickstart (Fedora) and preseed (Ubuntu) are in
+osbash/netboot.
+
+The vagrant-ssh-keys from the Vagrant project can be automatically installed
+into osbash VMs to make them accessible like Vagrant VMs without having
+to install yet another set of ssh keys.
+
+The templates used to build Windows batch files are in the wbatch subdirectory.
diff --git a/labs/lib/wbatch/README.rst b/labs/lib/wbatch/README.rst
new file mode 100644
index 00000000..03423220
--- /dev/null
+++ b/labs/lib/wbatch/README.rst
@@ -0,0 +1,2 @@
+The files in this directory are used to create Windows batch scripts that
+can build base disks and VM clusters.
diff --git a/labs/log/README.rst b/labs/log/README.rst
new file mode 100644
index 00000000..911d6277
--- /dev/null
+++ b/labs/log/README.rst
@@ -0,0 +1,5 @@
+The log files in this directory are written (and removed) by osbash/wbatch and
+the scripts running within the VMs.
+
+The status subdirectory is used by the VM scripts to inform osbash/wbatch
+about their progress.
diff --git a/labs/scripts/README.rst b/labs/scripts/README.rst
new file mode 100644
index 00000000..81c290fb
--- /dev/null
+++ b/labs/scripts/README.rst
@@ -0,0 +1,8 @@
+All scripts in this directory run within the VMs.
+
+They install and configure OpenStack components and any other required
+software (such as databases).
+
+Before these generic scripts run, scripts from the osbash (or vagrant,
+depending on the installation method) subdirectory set up the VM and
+configure basic networking.
diff --git a/labs/wbatch/README.rst b/labs/wbatch/README.rst
new file mode 100644
index 00000000..231eea0c
--- /dev/null
+++ b/labs/wbatch/README.rst
@@ -0,0 +1,7 @@
+Files in this directory are Windows batch files generated by osbash to
+configure host-only networks, produce a base disk, and build OpenStack
+training-labs VMs as configured when osbash created them.
+
+When copying these files to a Windows host, make sure to preserve the
+Windows-style CR/LF newlines, or the batch scripts may fail (e.g. not
+find jump labels).