6a5c39c257
So far, the Tobiko docs were duplicated in some places, different
(although duplicated), and some fragments were not relevant (or
outdated).
This patch refactors the Tobiko configuration guide by modularizing
the fragments ("spilling" fragments instead of coping them),
correcting typos, and deleting/updating irrelevant information.
Change-Id: I2b01c5ef43ba7156fbd2369fa2134a5eb5e7aadf
64 lines
1.5 KiB
ReStructuredText
64 lines
1.5 KiB
ReStructuredText
.. _tobiko-configuration-guide:
|
|
|
|
=============
|
|
Configuration
|
|
=============
|
|
|
|
This document describes how to configure Tobiko.
|
|
|
|
.. sidebar:: See also
|
|
|
|
For a quick and simpler start you can jump to the
|
|
:ref:`tobiko-quick-start-guide`.
|
|
|
|
To install Tobiko inside a virutalenv please read
|
|
:ref:`tobiko-installation-guide`.
|
|
|
|
To run Tobiko scenario test cases please look at
|
|
:ref:`tobiko-test-case-execution-guide`.
|
|
|
|
|
|
Configure Tobiko Framework
|
|
--------------------------
|
|
|
|
In order to make sure Tobiko tools can connect to OpenStack services via Rest
|
|
API configuration parameters can be passed either via environment variables or
|
|
via an INI configuration file (referred here as :ref:`tobiko-conf`). Please look
|
|
at :ref:`authentication-methods` for more details.
|
|
|
|
|
|
tobiko.conf
|
|
~~~~~~~~~~~
|
|
|
|
.. include:: _conf_explanation.rst
|
|
:start-after: tobiko-conf-label
|
|
|
|
Configure Logging
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. include:: _conf_logging.rst
|
|
:start-after: configure-tobiko-logging-label
|
|
|
|
.. include:: _conf_credentials.rst
|
|
|
|
.. _authentication-methods:
|
|
|
|
Authentication Methods
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Tobiko uses
|
|
`OpenStack client <https://docs.openstack.org/python-openstackclient/latest/>`__
|
|
to connect to OpenStack services.
|
|
|
|
Skipping resources creation
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. include:: _skip_resources_creation.rst
|
|
:start-after: skipping-resources-creation-label
|
|
|
|
What's Next
|
|
-----------
|
|
|
|
To know how to run Tobiko scenario test cases you can look at
|
|
:ref:`tobiko-test-case-execution-guide`
|