Add User Guide documentation

Add examples of usage of some discover-tempest-config
options, document what resources can be created and
what's needed for it

Change-Id: I78b499a79bc05e9c0528da573af78fd2b58df7f4
Story: 2002703
Task: 22885
Task: 22573
Martin Kopec 5 years ago
parent adb6d7b001
commit f161dbac04

@ -0,0 +1,78 @@
**Before** reading this page, **it's recommended** to go through `User Guide`_
first as the content on this site is more advanced and uses knowledge gained
from the `User Guide`_.
.. _User Guide: ../user/usage.html
This page shows examples of usage of ``python-tempestconf`` where **admin
credentials** are **required**. That means, only users with admin credentials
will run :command:`discover-tempest-config` with arguments described on this
page successfully.
Why admin credentials? It's because ``python-tempestconf`` can create resources
**necessary** for tempest execution in order to make user's life easier.
The following resources are created **only when** ``--create`` argument is
* flavors, to see what flavors are created, see User Guide, `Flavors`_
* users, to see what users are created, see User Guide, `Users`_ section
.. _Flavors: ../user/usage.html#flavors
.. _Users: ../user/usage.html#users
In the following example, ``python-tempestconf`` will create all necessary
resources (`Flavors`_ and `Users`_) if they don't exist already:
.. code-block:: shell-session
$ discover-tempest-config \
--os-cloud devstack-admin \
``python-tempestconf`` can also create a minimal accounts file when
``--create-accounts-file`` is used. It can be useful when a user doesn't have
any and wants to create it. It can be done with one call:
.. code-block:: shell-session
$ discover-tempest-config \
--os-cloud devstack-admin \
--create \
--create-accounts-file ~/accounts.yaml
The call above will behave the same as if ``--test-accounts`` argument was
used, `see here`_. The generated accounts file will look similarly to this one:
.. _see here: ../user/usage.html#usage-with-tempest-accounts-file
.. code-block:: ini
$ cat ~/accounts.yaml
# A minimal accounts.yaml file
# Will likely not work with swift, since additional
# roles are required. For more documentation see:
- password: password
project_name: admin
username: admin
.. note::
More about accounts file can be in our documentation about
`Usage with tempest accounts file`_
.. _Usage with tempest accounts file: ../user/usage.html#usage-with-tempest-accounts-file

@ -0,0 +1,8 @@
Admin User Guide
.. toctree::
:maxdepth: 2

@ -12,15 +12,21 @@ based on user's cloud.
.. note::
In Ocata release new features were presented. ``discover-tempest-config``
is the new name of the **old** ```` script and it
**accepts the same parameters.** More about the new features can be found
`here <>`__
.. toctree::
:maxdepth: 2
* :ref:`genindex`
* :ref:`search`

@ -0,0 +1,50 @@
Default values
``python-tempestconf`` defines some options by default in order to simplify
general executions, because not so many options need to be defined in each
run of ``python-tempestconf``, for example in CI.
Here is the list of tempest options, which are set by default:
.. code-block:: ini
debug = true
use_stderr = false
log_file = tempest.log
username = demo
password = secrete
project_name = demo
alt_username = alt_demo
alt_password = secrete
alt_project_name = alt_demo
disable_ssl_certificate_validation = true
img_dir = etc
tempest_roles = _member_
admin_username = admin
admin_project_name = admin
admin_domain_name = Default
reseller_admin_role = ResellerAdmin
lock_path = /tmp
# Default deployment does not use shared storage
live_migration = false
live_migrate_paused_instances = true
preserve_ports = true
ipv6_subnet_attributes = true

@ -1,5 +1,5 @@
User Guide
.. toctree::
:maxdepth: 2
@ -7,3 +7,4 @@ Usage

@ -1,44 +1,428 @@
To install python-tempestconf follow `Installation Guide`_
To install ``python-tempestconf`` follow our `Installation Guide`_
.. _Installation Guide: ../install/installation.html
For a successful execution of ``python-tempestconf`` a user needs to do one
of the following:
* source OpenStack RC file before running :command:`discover-tempest-config`
command, see `Examples of usage with sourced credentials`_
* use ``clouds.yaml`` file and take advantage of ``os-client-config`` support
and use a named cloud, see `Examples of usage with a named cloud`_
If a user doesn't use ``--create``, no resources, which requires admin
credentials, are created. See `Resources`_ section.
Examples of usage with sourced credentials
**All of the examples** in this section mentioned below **use** the following
step **as a prerequisite**:
* Source your OpenStack RC file containing the cloud credentials. Let's say
you have a overcloud_rc file with the following content:
.. code-block:: shell-session
$ cat overcloud_rc
export OS_USERNAME=demo
export OS_PASSWORD='password'
export OS_AUTH_URL=
export PS1='[\u@\h \W(keystone_demo)]\$ '
export OS_PROJECT_NAME=demo
export OS_USER_DOMAIN_NAME=default
Then it can be sourced by:
.. code-block:: shell-session
$ source overcloud_rc
.. note::
Thanks to
`os-client-config <>`_
support, ``python-tempestconf`` is able to read cloud credentials from
the shell environment, which means, they **don't need** to be
explicitly passed via CLI.
Override values
Override values can be useful when a user wants to set a key-value pair in
generated ``tempest.conf`` from one of the two following reasons:
* ``python-tempestconf`` is **not** able to discover it and therefore set the
key-value pair in ``tempest.conf`` by itself
* ``python-tempestconf`` is able to discover it, but a user wants to set it
Values specified as overrides will be set to tempest.conf no matter what if
they were discovered or not. If a section or a key don't exist, they will be
In the following example we make the tool to print debugging information, we
set that ``tempest.conf`` will be written to ``etc/`` directory and we pass
some override values.
.. code-block:: shell-session
:emphasize-lines: 4-6
$ discover-tempest-config \
--debug \
--out etc/tempest.conf \
auth.tempest_roles Member \
identity.username MyOverrideUsername \
section.key MyValue
The generated ``tempest.conf`` will look like:
.. code-block:: shell-session
$ cat etc/tempest.conf
<omitted some content>
tempest_roles = Member
<omitted some content>
username = MyOverrideUsername
<omitted some content>
key = value
<omitted some content>
.. note::
-\\-`remove`_ option will remove even values set as overrides
.. _remove: ./usage.html#prevent-some-key-value-pairs-to-be-set-in-tempest-conf
Prevent some key-value pairs to be set in tempest.conf
A user can define key-value pairs which are not wanted to be written to the
generated ``tempest.conf``. This can be useful in case when
``python-tempestconf`` discovers something which is not wanted by a user to
have in ``tempest.conf``. If the option is used, ``python-tempestconf`` will
make sure, that the defined values are not written to tempest.conf no matter
if they were discovered or not.
.. code-block:: shell-session
$ discover-tempest-config \
--remove section1.key1 \
--remove section2.key2=value \
--remove section3.key3=value1,value2
In the following case **all** api_extensions will be removed and tempest.conf
will **not contain** the api_extensions key under compute-feature-enabled
.. code-block:: shell-session
$ discover-tempest-config \
--remove compute-feature-enabled.api_extensions
In the following case **only** NMN api extension will be removed from the
api_extensions list.
.. code-block:: shell-session
$ discover-tempest-config \
--remove compute-feature-enabled.api_extensions=NMN
In the following case only NMN **and** OS-EXT-IPS api extensions will be
.. code-block:: shell-session
$ discover-tempest-config \
--remove compute-feature-enabled.api_extensions=NMN,OS-EXT-IPS
.. note::
``--remove`` option will remove even values set as `overrides`_
.. _overrides: ./usage.html#override-values
Usage with tempest accounts file
To read more about ``accounts.yaml`` file and how to generate it follow these
* `what is accounts.yaml? <>`_
* `how to generate it? <>`_
When ``--test-accounts`` argument is used, ``python-tempestconf`` will not
write any credentials to generated tempest.conf file, it will add a
**test_accounts_file** key to **auth** section with value equal to the path
provided by the ``--test-accounts`` argument. Also **use_dynamic_credentials**
under **auth** section will be set to False as
`tempest documentation <>`_
This argument can be useful when a user doesn't want to store credentials in
``tempest.conf``, f.e: the user want's to share the ``tempest.conf``.
If you already have the file created, you can run
:command:`discover-tempest-config` command with ``--test-accounts`` argument:
.. code-block:: shell-session
:emphasize-lines: 3
$ discover-tempest-config \
--out etc/tempest.conf \
--test-accounts /path/to/my/accounts.yaml
1. Source cloud credentials, for example:
The generated tempest.conf will look like:
.. code-block:: shell-session
$ source cloudrc
$ cat etc/tempest.conf
<omitted some content>
test_accounts_file = /path/to/my/accounts.yaml
use_dynamic_credentials = False
<omitted some content>
2. Run python-tempestconf to generate tempest configuration file:
non-admin argument
If your credentials are **non-admin ones**, which means, you are
**not allowed** to create any resources in your cloud, please, specify
``--non-admin`` argument. When the argument is used, ``python-tempestconf``
will **not create** any resources.
.. code-block:: shell-session
:emphasize-lines: 4
$ discover-tempest-config \
-v \
--debug \
Examples of usage with a named cloud
``python-tempestconf`` supports
`os-client-config <>`__
so instead of sourcing an OpenStack RC file a user can use clouds.yml file.
Location where this file should be stored and syntax which is used to define
it can be found
`here <>`__
Let's say there is a ``clouds.yaml`` file located in ``/etc/openstack/`` with
the following content:
.. code-block:: shell-session
$ discover-tempest-config --debug --create
$ cat /etc/openstack/clouds.yaml
password: password
project_domain_id: default
project_name: demo
user_domain_id: default
username: demo
identity_api_version: '3'
region_name: RegionOne
volume_api_version: '2'
Then if you use ``--os-cloud`` argument you can run
:command:`discover-tempest-config` **without** sourcing any OpenStack RC file.
``--os-cloud`` defines specifies one of the cloud names located in the
``clouds.yaml`` file.
.. code-block:: shell-session
:emphasize-lines: 3
$ discover-tempest-config \
--debug \
--os-cloud devstack
So the call from `non-admin argument`_ section would for example look like:
.. code-block:: shell-session
:emphasize-lines: 5
$ discover-tempest-config \
-v \
--debug \
--non-admin \
--os-cloud devstack
The call from `Usage with tempest accounts file`_ section would for example
look like:
.. code-block:: shell-session
:emphasize-lines: 2
$ discover-tempest-config \
--os-cloud devstack \
--out etc/tempest.conf \
--test-accounts /path/to/my/accounts.yaml
Without specifying ``--create`` argument, no resources which requires admin
credentials are crated during the ``python-tempestconf`` execution. For the
documentation on how to use ``--create`` argument see `Admin User Guide`_
.. _Admin User Guide: ../admin/admin_usage.html
This affects these types of resources:
* users
* images
* flavors
For a successful execution of Tempest at least two users need to be created
(the default concurrency is 2). Therefor ``python-tempestconf`` looks for
the following two users:
* the user who started ``python-tempestconf``
* the alt user defined by:
* identity.alt_username
* identity.alt_password
* identity.alt_project_name
.. note::
These values are set by default, have a look at `default values`_ which
``python-tempestconf`` sets to a ``tempest.conf``
After this, ``./etc/tempest.conf`` is generated.
.. _default values: ./default.html
If the users are not found, they can't be created, so
:command:`discover-tempest-config` ends with an exception.
Any user can create an image, therefore ``--create`` argument doesn't have to
be used in order to have created images, necessary for tempest execution, by
However, when non-admin credentials are used, the created images will have
**community** visibility. It's because users without admin credentials can't
create a public image and private images are not visible for other users -
tempest tests **would fail** finding the image, because they are usually run
under a **different user.**
When admin credentials are used, the images are created as public ones.
``--image`` argument is used to specify an image which will be uploaded
to glance and used later by tempest tests for booting VMs.
The following example will upload ``/my/path/to/myImage.img`` image to glance
twice. First **compute.image_ref** will be equal to the ID of the uploaded
image. Then the image is uploaded to glance again and but
**compute.image_alt_ref** is set to that corresponding ID:
.. code-block:: shell-session
$ discover-tempest-config \
--os-cloud myCloud \
--image /my/path/to/myImage.img
In the following example, an `override`_ value is used to set
**conpute.image_ref**, which means, that the image specified by ``--image`` is
uploaded and only **compute.image_alt_ref** is set to the ID of newly created
.. _override: ./usage.html#override-values
.. code-block:: shell-session
$ discover-tempest-config \
--os-cloud myCloud \
compute.image_ref 2eb9f6c9-bd32-427d-850d-c3bb3cfaaa87
.. note::
In Ocata release new features were presented.
``discover-tempest-config`` is the new name of the **old**
```` script and it **accepts the same parameters.**
More about new features can be found
`here <>`__
``python-tempestconf`` checks by image name, if it is already present
in glance and only in case it's not present there, will upload the
.. note::
If the image ID specified as an override is not found, the image where
``--image`` points to is used.
If ``--image`` is not defined, the default image (see `CLI options`_)
is chosen to be uploaded.
.. _CLI options: ../cli/cli_options.html
``python-tempestconf`` looks for these two flavors:
* m1.nano with 64 MB of RAM, which will be set as **compute.flavor_ref**
* m1.micro with 128 MB of RAM, which will be set as **compute.flavor_alt_ref**
os-client-config support
If they are not found and ``--create`` argument is not used, the tool will try
to auto discover two smallest flavors available in the system. If at least two
flavors are not found, the tool ends with an exception.
python-tempestconf supports `os-client-config <>`__
so instead of sourcing openstackrc files you can use clouds.yml files. Location where
these files should be stored and syntax which is used to specify cloud.yaml files
can be found `here <>`__
If two flavors are found, their IDs will be set to ``tempest.conf``, see the
following example:
.. code-block:: shell-session
$ discover-tempest-config --debug --create --os-cloud <name of cloud>
$ discover-tempest-config \
--out etc/tempest.conf
The generated tempest.conf will look like:
.. code-block:: ini
$ cat etc/tempest.conf
<omitted some content>
# typically an ID of the smaller flavor found
flavor_ref = <ID_1>
# typically an ID of the bigger flavor found
flavor_alt_ref = <ID_2>
<omitted some content>
In the following example, a `override`_ option specifies **compute.flavor_ref**
ID, which if it's found, the tool continues with looking for a **m1.micro**
flavor to be set as **compute.flavor_alt_ref** as was explained above.
.. code-block:: shell-session
$ discover-tempest-config \
--out etc/tempest.conf \
compute.flavor_ref 123
.. note::
If the **compute.flavor_ref** ID is not found, the tool ends with an