tempest/doc/source/index.rst
Ghanshyam Mann 672eee1d31 Add documentation on the usage of keystone's scope & roles
As Tempest support the keystone's scope and new default roles
like reader, this commit document that how those can be
requested and used in Tempest or its plugins tests.

Change-Id: Iebacbeda231f82d6d16dbdcde635f19ae862181f
2021-03-12 09:54:39 -06:00

149 lines
2.3 KiB
ReStructuredText

=======================
Tempest Testing Project
=======================
Overview
========
.. toctree::
:maxdepth: 2
overview
Field Guides
============
Tempest contains tests of many different types, the field guides
attempt to explain these in a way that makes it easy to understand
where your test contributions should go.
.. toctree::
:maxdepth: 1
field_guide/index
field_guide/api
field_guide/scenario
field_guide/unit_tests
Users Guide
===========
Tempest Configuration Guide
---------------------------
.. toctree::
:maxdepth: 2
configuration
sampleconf
Command Documentation
---------------------
.. toctree::
:maxdepth: 1
account_generator
cleanup
subunit_describe_calls
workspace
run
Supported OpenStack Releases and Python Versions
------------------------------------------------
.. toctree::
:maxdepth: 1
supported_version
Description of Tests
--------------------
.. toctree::
:maxdepth: 2
tests/modules
For Contributors
================
* If you are a new contributor to Tempest please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Developers Guide
================
Development
-----------
.. toctree::
:maxdepth: 2
HACKING
REVIEWING
microversion_testing
test_removal
write_tests
requirement_upper_constraint_for_tempest
Plugins
-------
.. toctree::
:maxdepth: 2
plugins/index
Tempest & Plugins Compatible Version Policy
-------------------------------------------
.. toctree::
:maxdepth: 2
tempest_and_plugins_compatible_version_policy
Keystone Scopes & Roles Support in Tempest
------------------------------------------
.. toctree::
:maxdepth: 2
keystone_scopes_and_roles_support
Stable Branch Support Policy
----------------------------
.. toctree::
:maxdepth: 2
stable_branch_support_policy
Stable Branch Testing Policy
----------------------------
.. toctree::
:maxdepth: 2
stable_branch_testing_policy
Library
-------
.. toctree::
:maxdepth: 2
library
Search
======
.. only:: html
* :ref:`Tempest document search <search>`: Search the contents of this document.
* `OpenStack wide search <https://docs.openstack.org>`_: Search the wider
set of OpenStack documentation, including forums.