Refactors the architecture of osbash

Changes to the repository layout to incorporate the following:

  1. Migrate to dedicated repository
  2. Rebranding osbash to openstack-labs
  3. Adding Python specific bits
  4. Allowing a wrapper and switch to osbash meanwhile the
     python scripts (stacktrain) is underprogress

The current repository structure will allow us to carry out the above
mentioned changes while the stable code base is usable and will also
allow us to update the version of OpenStack being deployed on osbash.

This is the rough sketch of the repository ignoring the boilerplate:

    .
    |-- doc
    |-- openstack-labs
    |   |-- img
    |   |-- osbash
    |   |   |-- config
    |   |   |-- lib
    |   |   |-- tools
    |   |   |-- scripts
    |   |   |-- osbash.sh
    |   |   `-- wbatch
    |   |-- stacktrain
    |   |   `-- lib
    |   `-- stacktrain.py
    `-- oslabs.py

Note: Also adds/edits existing boilerplate (README's, Tools etc.)

Co-Authored-By: Roger Luethi <rl@patchworkscience.org>
Co-Authored-By: Sayali Lunkad <sayali.92720@gmail.com>

.gitignore

@@ -0,0 +1,68 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+.eggs
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+.testrepository
+.venv
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+doc/build
+
+# pbr generates these
+AUTHORS
+ChangeLog
+
+# Editors
+*~
+.*.swp
+.*sw?
+
+# Others
+*.log
+*.sqlite
+tenvironment
+.ropeproject/
+
+# Labs artifacts
+labs/autostart
+labs/img
+labs/log
+labs/wbatch
+labs/lib/vagrant-ssh-keys
+labs/test_tmp/

.gitreview

@@ -0,0 +1,4 @@
+[gerrit]
+host=review.openstack.org
+port=29418
+project=openstack/labs.git

CONTRIBUTING.rst

@@ -0,0 +1,17 @@
+If you would like to contribute to the development of OpenStack, you must
+follow the steps in this page:
+
+   http://docs.openstack.org/infra/manual/developers.html
+
+If you already have a good understanding of how the system works and your
+OpenStack accounts are set up, you can skip to the development workflow
+section of this documentation to learn how changes to OpenStack should be
+submitted for review via the Gerrit tool:
+
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
+
+Pull requests submitted through GitHub will be ignored.
+
+Bugs should be filed on Launchpad, not GitHub:
+
+   https://bugs.launchpad.net/labs

HACKING.rst

@@ -1,45 +1,48 @@
-Contributing to training-labs scripts
+Contributing to replace-labs scripts
 =====================================
 
+First things first
+------------------
+
+Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
+
 General
 -------
 
-Contributing code to training-labs scripts follows the usual OpenStack process
+Contributing code to replace labs scripts follows the usual OpenStack process
 as described in `How To Contribute`__ in the OpenStack wiki.
 Our `main blueprint`__ contains the usual links for blueprints, bugs, etc.
 
 __ contribute_
 .. _contribute: http://docs.openstack.org/infra/manual/developers.html
 
-__ lp_
+__ spec_
-.. _lp: https://blueprints.launchpad.net/openstack-training-guides/+spec/openstack-training-labs
+.. _spec: http://specs.openstack.org/openstack/docs-specs/specs/liberty/traininglabs.html
 
 Getting started
 ---------------
 
-The main script is osbash.sh. It will call libraries and other scripts to build
+.. TODO(psalunke): Fix Me. Add more content here.
-the training-labs setup. The setup can be customized in labs/config where all
-scripts keep their configuration files.
 
 Prerequisites
 -------------
 
-The labs scripts are designed to have minimal dependencies: bash and
+.. TODO(psalunke): Fix Me. Add more content here.
-`VirtualBox <https://www.virtualbox.org/>`_. To support OS X, we keep the
-host-side scripts compatible with bash 3.2 (don't use features not present in
-that somewhat dated version).
-
-For testing the generated Windows batch scripts, any supported version of
-Windows (Vista and later) will do. After having created the batch files using
-osbash.sh, just copy the whole labs directory to Windows. If you don't have
-access to that operating system, comparing the output in labs/wbatch will tell
-you how your changes affect behavior on that platform.
 
 Coding style
 ------------
 
-We follow the conventions of other OpenStack projects. Since labs scripts are
+We follow the conventions of other OpenStack projects.
-currently all written in bash, the examples to follow are this project and
+
+StackTrain
+~~~~~~~~~~
+
+.. TODO(psalunke): Fix me. Add more content here.
+
+Osbash
+~~~~~~
+
+Osbash is written in BASH and follows conventions of DevStack:
 `devstack <http://devstack.org/>`_.
 
 DevStack bash style guidelines can be found at the bottom of:
@@ -48,6 +51,12 @@ https://git.openstack.org/cgit/openstack-dev/devstack/blob/master/HACKING.rst
 Structure
 ---------
 
+
+.. TODO(psalunke): Add more information as the repo gets merged.
+
+OSBASH:
+~~~~~~~
+
 **autostart**
 
 osbash/wbatch copy shell scripts (\*.sh) into this directory to have them
@@ -60,7 +69,7 @@ Contains the configuration files for all the scripts. The setup can be customize
 **img**
 
 By default osbash will put into this directory its base disk images
-(base-\*-<distro>.vdi), the VM export images (oslabs-<distro>.ova),
+(base-\*-<distro>.vdi), the VM export images (labs-<distro>.ova),
 and all installation ISO images it may download.
 
 **lib**
@@ -80,20 +89,18 @@ All scripts in this directory run within the VMs.
 
 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.
+replace-labs VMs as configured when osbash created them.
 
 Testing
 -------
 
-The labs scripts don't have automated tests yet. Patch submitters should be
-aware of their responsibility for ensuring that their code works and can be
-tested by reviewers.
-
 Useful tools for checking scripts:
 
 - `bashate <https://github.com/openstack-dev/bashate>`_ (must pass)
 - `shellcheck <https://github.com/koalaman/shellcheck.git>`_ (optional)
 
+.. TODO (psalunke): Add Python checks etc.
+
 Submitting patches
 ------------------
 
@@ -103,7 +110,7 @@ this one):
 - http://docs.openstack.org/infra/manual/developers.html#development-workflow
 - https://wiki.openstack.org/wiki/GitCommitMessages
 
-If you change the behavior of the scripts as documented in the training-guides,
+If you change the behavior of the scripts as documented in the replace-guides,
 add a DocImpact flag to alert the documentation team. For instance, add a line
 like this to your commit message:
 
@@ -119,8 +126,6 @@ Learn how to review (or what to expect when having your patches reviewed) here:
 
 TODO
 ----
-Etherpad:
-- https://etherpad.openstack.org/p/training-guides-developing-topics
 
 Anything not covered here
 -------------------------

LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

MANIFEST.in

@@ -0,0 +1,6 @@
+include AUTHORS
+include ChangeLog
+exclude .gitignore
+exclude .gitreview
+
+global-exclude *.pyc

README.rst

@@ -1,52 +1,46 @@
-
+=============
-Training Labs
+training labs
 =============
 
 About
 -----
 
-Training Labs will provide scripts to automate the creation of the Training
+Provide an automated way to deploy Vanilla OpenStack and closely follow
-Environment.
+.. _install-guides: https://wiki.openstack.org/wiki/Documentation/InstallGuide
 
-**Note:** Training Labs are specifically meant for OpenStack Training and are
+We strove to give easy way to setup OpenStack cluster which should
-specifically tuned as per Training Manuals repo.
+be a good starting point for beginners to learn OpenStack, and for advanced
+users to test out new features, check out different capabilities of OpenStack.
+On top of that training-labs will also be a good way to test the install
+guides on a regular basis.
 
+Training-labs is a project under OpenStack Documentation. Please checkout
+the wiki for more information: .. _training-labs: https://wiki.openstack.org/wiki/Documentation/training-labs
+
+* Free software: Apache license
+* Documentation: http://docs.openstack.org/developer/training-labs
+* Source: http://git.openstack.org/cgit/openstack/training-labs
+* Bugs: http://bugs.launchpad.net/training-labs
 
 Pre-requisite
 -------------
 
 * Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads).
 
-
 How to run the scripts
 ----------------------
 
-1. Clone the training-guides repo which contains scripts in the labs section that will install multi-node OpenStack automatically.
+.. TODO(psalunke: fix me)
-
+1. Clone the training-labs repository:
-        $ git clone git://git.openstack.org/openstack/training-guides
-
-2. Go to the labs folder
-
-        $ cd training-guides/labs
-
-3. Run the script:
-
-        $ ./osbash -b cluster
-
-This will do the complete installation for all the nodes - Controller, Compute and Network.
-
-For more help you can check
-
-        $ ./osbash --help
 
+        $
 
 This will take some time to run the first time.
 
-
 What the script installs
 ------------------------
 
-Running this will automatically spin up 3 virtual machines in VirtualBox:
+Running this will automatically spin up 3 virtual machines in VirtualBox/KVM:
 
 * Controller node
 * Network node
@@ -93,7 +87,6 @@ Openstack Services installed on Compute node:
 
     * neutron-plugin-openvswitch-agent
 
-
 How to access the services
 --------------------------
 
@@ -152,19 +145,18 @@ For Demo user privileges:
 
 Now you can access the OpenStack services via CLI.
 
+Specs
+-----
 
-BluePrints
+* .. _training-labs: http://specs.openstack.org/openstack/docs-specs/specs/liberty/traininglabs.html
-----------
-
-* Training Manuals : https://blueprints.launchpad.net/openstack-manuals/+spec/training-manuals
-* Training Labs : https://blueprints.launchpad.net/openstack-training-guides/+spec/openstack-training-labs
 
 Mailing Lists, IRC
 ------------------
 
 * To contribute please hop on to IRC on the channel `#openstack-doc` on IRC freenode
   or write an e-mail to the OpenStack Manuals mailing list
-  `openstack-docs@lists.openstack.org`.
+  `openstack-docs@lists.openstack.org`. Please use [training-labs] tag in the email
+  message.
 
 **NOTE:** You might consider registering on the OpenStack Manuals mailing list if
           you want to post your e-mail instantly. It may take some time for
@@ -187,14 +179,11 @@ any queries about the Labs section.
 Meetings
 --------
 
-To follow the weekly meetings for OpenStack Training, please refer
+Team meeting for training-labs is on alternating Thursdays on Google Hangouts.
-to the following link.
+https://wiki.openstack.org/wiki/Documentation/training-labs#Meeting_Information
-
-For IRC meetings, refer to the wiki page on training manuals.
-https://wiki.openstack.org/wiki/Meetings/training-manual
 
 Wiki
 ----
 
-Follow various links on OpenStack Training Manuals here:
+Follow various links on training-labs here:
-https://wiki.openstack.org/wiki/Training-guides
+https://wiki.openstack.org/wiki/Documentation/training-labs#Meeting_Information

babel.cfg

@@ -0,0 +1,2 @@
+[python: **.py]
+

doc/README.rst

@@ -0,0 +1,5 @@
+Documentation for training-labs
+===============================
+
+See the "Building the Dcumenation" section of
+doc/source/development.environment.rst.

doc/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    #'sphinx.ext.intersphinx',
+    'oslosphinx'
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'training-labs'
+copyright = u'2013, OpenStack Foundation'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     u'%s Documentation' % project,
+     u'OpenStack Foundation', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/contributing.rst

@@ -0,0 +1,4 @@
+============
+Contributing
+============
+.. include:: ../../CONTRIBUTING.rst

doc/source/index.rst

@@ -0,0 +1,25 @@
+.. labs documentation master file, created by
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to labs's documentation!
+========================================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   installation
+   usage
+   contributing
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/source/installation.rst

@@ -0,0 +1,11 @@
+============
+Installation
+============
+
+At the command line::
+
+    $ git clone git://git.openstack.org/openstack/training-labs
+    $ cd labs
+    $ ./os-labs.py -h
+
+Make sure that you have VirtualBox installed on your system.

doc/source/readme.rst

@@ -0,0 +1 @@
+.. include:: ../../README.rst

doc/source/usage.rst

@@ -0,0 +1,5 @@
+========
+Usage
+========
+
+

getting-started.rst

@@ -1 +0,0 @@
-TODO: Getting started section will lie in this section.

openstack-common.conf

@@ -0,0 +1,7 @@
+[DEFAULT]
+
+# The list of modules to copy from oslo-incubator.git
+
+
+# The base module to hold the copy of openstack.common
+base=labs

oslabs/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import pbr.version
+
+
+__version__ = pbr.version.VersionInfo(
+    'openstack-labs').version_string()