8a6a88b6b8
Add script launch_instance.sh for basic instance VM tests. The script tries to deal with a number of failures that have turned up in testing (e.g., services failing to start, instance not launching). The changeset includes three scripts in a new tools directory. 1) To run a test once, use test-once.sh: $ ./tools/test-once.sh scripts/test/launch_instance.sh 2) To restore (and boot) the cluster to an earlier snapshot, use restore-cluster.sh. The argument selects the snapshot used for the controller node VM. To select the most recently used snapshot: $ ./tools/restore-cluster.sh current To select the controller snapshot, "controller_node_installed": $ ./tools/restore-cluster.sh controller_node_installed 3) To run the same test repeatedly, use repeat-test.sh. The test script name is hard-coded (launch_instance.sh). The argument determines whether the cluster is rebuilt for each test or if a snapshot of the cluster is restored. The controller snapshot is hardcoded (controller_node_installed); this particular snapshot is of interest because it does not seem to result in a reliable cluster. Log files are stored in log/test-results. Repeat-test.sh also saves log files from each node's /var/log/upstart to help with analyzing failures. $ ./tools/repeat-test.sh restore After running a number of tests, you can get some simple stats using a command like this: $ grep -h SUM log/test-results/*/test.log|LC_ALL=C sort|uniq -c Co-Author: Pranav Salunke <dguitarbite@gmail.com> Change-Id: I20b7273683b281bf7822ef66e311b955b8c5ec8a
OpenStack Training Guides
This repository contains open source training manuals that can be used to learn about the OpenStack project.
For more details, see the OpenStack Training Guides wiki page.
It includes these guides:
- Associate Guide
- Operator Guide
- Developer Guide
Prerequisites
Apache Maven must be installed to build the documentation.
To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:
apt-get install mavenOn Fedora 20 and later:
yum install mavenBuilding
The different guides are in subdirectories of the doc/
directory.
To build the guides, look for a pom.xml file within a
subdirectory, then run the mvn command in that directory.
For example:
cd doc/training-guides/
mvn clean generate-sourcesThe generated PDF documentation file is:
doc/training-guides/target/docbkx/webhelp/training-guides/training-guides.pdfThe root of the generated HTML documentation is:
doc/training-guides/target/docbkx/webhelp/training-guides/content/index.htmlTesting of changes and building of the manual
Install the python tox package and run tox from the
top-level directory to use the same tests that are done as part of our
Jenkins gating jobs.
If you like to run individual tests, run:
tox -e checkniceness- to run the niceness teststox -e checksyntax- to run syntax checkstox -e checkdeletions- to check that no deleted files are referencedtox -e checkbuild- to actually build the manual
tox will use the openstack-doc-tools package for execution of these tests.
Contributing
Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.
The best way to get involved with the community is to talk with
others online or at a meet up and offer contributions through our
processes, the OpenStack wiki,
blogs, or on IRC at #openstack on
irc.freenode.net.
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
If you would like to contribute to the documents, please see the Documentation HowTo.
Bugs
Bugs should be filed on Launchpad, not GitHub:
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.