8aab6f82de
The labs scripts need two sets of login/password for each service:
one for the (MySQL) database used by the service, and one for
authentication with keystone.
For the labs scripts login names and passwords are simple functions
of the service names: for the first set (database), we have
${service}User/${service}Pass, for the second set (keystone auth)
${service}/${service}_pass.
This changeset adds two functions for producing the second set of
credentials and renames the existing functions (as well as related
variables) for producing the first set.
This prevents us from having to store login names and passwords in the
service scripts. It also keeps those things in one location where they
can be changed easily should we ever want to do so.
Implements: blueprint openstack-training-labs
Change-Id: I730eab475bee843767984b6c64bab88a94c0156e
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.