bb303c8889
This library is used by osbash host-side scripts. It contains exec_cmd, a simple function that is used when marking commands for conditional execution, depending on whether the user requested Windows batch files and whether the artifacts are to be created on the local machine as well. The library also contains functions that allow the host to execute scripts in the VMs, either directly through ssh or indirectly, by adding files to an autostart directory shared with the guest VMs. In addition, the library contains functions to find and (if necessary) download the install ISO image of the configured Linux distribution. Partial-Bug: 1312764 Implements: blueprint openstack-training-labs Change-Id: I49d49340db89b61a03dbc483291c252c8c72d61a
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 15 and later:
yum install maven3Building
The different guides are in subdirectories of the
openstack-training-guides/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 openstack-training-guides/doc/training-guides/
mvn clean generate-sourcesThe generated PDF documentation file is:
openstack-training-guides/doc/training-guides/target/docbkx/webhelp/training-guides.pdfThe root of the generated HTML documentation is:
openstack-training-guides/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.