From 68600b18faf6c24614e22f1f0081ba0b8d38a0be Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Wed, 9 Oct 2019 03:05:07 +0000 Subject: [PATCH] Add doc for supported OpenStack release & py version Tempest is branchless and support many OpenStack stable branches and python versions. Users of Tempest should have a clear doc about what all openstack releases and python versions are supported. Change-Id: Idc76e07efdd3710a59c773c564ca532419989ed5 --- doc/source/index.rst | 8 +++++++ doc/source/supported_version.rst | 37 ++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 doc/source/supported_version.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 7acfd62ebf..ab994d12b9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -48,6 +48,14 @@ Command Documentation workspace run +Supported OpenStack Releases and Python Versions +------------------------------------------------ + +.. toctree:: + :maxdepth: 1 + + supported_version + Developers Guide ================ diff --git a/doc/source/supported_version.rst b/doc/source/supported_version.rst new file mode 100644 index 0000000000..60e7b9765a --- /dev/null +++ b/doc/source/supported_version.rst @@ -0,0 +1,37 @@ +Supported OpenStack Releases and Python Versions +================================================ + +This Document list the officially supported OpenStack releases +and python versions by Tempest. + +Compatible OpenStack Releases +----------------------------- + +Tempest master supports the below OpenStack Releases: + +* Train +* Stein +* Rocky + +For older OpenStack Release: + +For any older OpenStack Release than the listed above, Tempest master might work. But if +Tempest master starts failing then, you can use the respective Tempest tag listed in OpenStack +release page. + +For example: OpenStack Stein: Tempest 20.0.0 + +* https://releases.openstack.org/stein/index.html#stein-tempest + +How to use Tempest tag on Extended Maintenance stable branch: +* https://review.opendev.org/#/c/681950/ + +Supported Python Versions +------------------------- + +Tempest master supports the below python versions: + +* Python 2.7 +* Python 3.5 +* Python 3.6 +* Python 3.7