openstack/training-guides
Code Issues Proposed changes

Add README.rst for subdirectories

Browse Source 
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
This commit is contained in:
Roger Luethi 2014-06-16 12:21:26 +02:00 committed by Pranav Salunke
parent ec2615fa7c
commit 9ada0ed032
8 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
labs/autostart/README.rst Normal file
View File

@ -0,0 +1,2 @@
osbash/wbatch copy shell scripts (*.sh) into this directory to have them
automatically executed (and removed) upon boot.

2
labs/config/README.rst Normal file
View File

@ -0,0 +1,2 @@
The configuration files in this directory are used by osbash/wbatch and
by scripts running inside the VMs (scripts directory).

3
labs/img/README.rst Normal file
View File

@ -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.

10
labs/lib/README.rst Normal file
View File

@ -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.

2
labs/lib/wbatch/README.rst Normal file
View File

@ -0,0 +1,2 @@
The files in this directory are used to create Windows batch scripts that
can build base disks and VM clusters.

5
labs/log/README.rst Normal file
View File

@ -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.

8
labs/scripts/README.rst Normal file
View File

@ -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.

7
labs/wbatch/README.rst Normal file
View File

@ -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).