Update readme

Add an example on how to use python-tempestconf tool.

Change-Id: I13deed96c5af1feeef4e369cc2da17ad42de0363
This commit is contained in:
Martin Kopec 2017-03-14 09:31:44 +00:00
parent affc5179e9
commit d89e635020
1 changed files with 55 additions and 8 deletions

View File

@ -2,16 +2,63 @@
python-tempestconf
===============================
python-tempestconf will automatically generates the tempest configuration based on your cloud.
## Overview
python-tempestconf will automatically generate the tempest configuration based on your cloud.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/python-tempestconf
* Source: http://git.openstack.org/cgit/openstack/python-tempestconf
* Bugs: http://bugs.launchpad.net/python-tempestconf
* Documentation: https://github.com/redhat-openstack/python-tempestconf/blob/master/README.rst
* Source: https://github.com/redhat-openstack/python-tempestconf
* Bugs: https://github.com/redhat-openstack/python-tempestconf/issues
## Usage
### Git
[1.] Clone and change to the directory:
$ git clone https://github.com/redhat-openstack/python-tempestconf
$ cd python-tempestconf
[2.] Create virtual environment using virtualenv:
$ virtualenv .venv
$ source .venv/bin/activate
[3.] Source the newly created virtual environment and install requirements:
(.venv) $ pip install -r requirements.txt
(.venv) $ pip install -r test-requirements.txt
[4.] Source cloud credentials, for example:
(py27) $ source cloudrc
[5.] Run python-tempestconf to generate tempest configuration file:
(py27) $ python config_tempest/config_tempest.py --debug identity.uri $OS_AUTH_URL \
identity.admin_password $OS_PASSWORD --create
After this, `./etc/tempest.conf` is generated.
### RPM Installation (RDO)
[1.] python-tempestconf is installed together with openstack-tempest,
as a new dependency (starting from the Ocata release)
# yum -y install openstack-tempest
[2.] Source cloud credentials, initialize tempest and run the discovery tool:
$ source cloudrc
$ tempest init testingdir
$ cd testingdir
$ discover-tempest-config --debug identity.uri $OS_AUTH_URL \
identity.admin_password $OS_PASSWORD --create
*Note:* In Ocata release new features were presented. `discover-tempest-config` is the new name
of the **old** `config_tempest.py` script and it **accepts the same parameters.** More about new
features can be found
[here](https://www.rdoproject.org/blog/2017/02/testing-rdo-with-tempest-new-features-in-ocata/)
Features
--------
* TODO