Bug 1844084

Summary: [openstack-tempest] Remove containerized tempest from the doc
Product: Red Hat OpenStack Reporter: Martin Kopec <mkopec>
Component: documentationAssignee: fallen
Status: CLOSED CURRENTRELEASE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 17.0 (Wallaby)CC: acruz, amoralej, chkumar, fallen, jschluet, mariel, whayutin
Target Milestone: ---Keywords: Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-06-02 07:50:45 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Martin Kopec 2020-06-04 15:11:11 UTC
Description of problem:
Since the containerized tempest hasn't been used much - f.e. upstream stopped using it some time ago, I'd advised to remove it from the current master documentation so that it's not included in the documentation for RHOS-17 and next releases.

Comment 1 Martin Kopec 2020-06-04 15:14:56 UTC
To add additional info to the previous comment:
The containerized tempest is documented in the chapter 6 of the official doc, f.e. for RHOS-16:
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/openstack_integration_test_suite_guide/chap-configure-tempest

The whole chapter 6 should be removed.

Comment 2 Alfredo Moralejo 2020-06-08 12:04:38 UTC
This bz refers to removing the container from documentation but then the real question is if the container itself must be kept in supported registry in OSP17. I'm not sure if we fully support this and how our customers use it.

Comment 3 Jon Schlueter 2022-05-19 14:50:12 UTC
So tempest container image is currently used by osp-director-operator but not default used by OpenStack normal usage

Comment 4 fallen 2022-05-19 14:58:37 UTC
OK, so should we keep it in OSP17 or remove it, that is the question?
Who is best placed to make that decision?

Thanks
Fiona

Comment 5 fallen 2022-05-31 14:02:43 UTC
Hi Jon,

Can you confirm (or deny) that Chapter 6 should be removed in Wallaby?

It would be great if you could let me know before the 14th of June as I am starting work on OSP 17.

Thank you
Fiona

Comment 6 Martin Kopec 2022-06-01 07:12:47 UTC
Chapter 5 (in 16.2 doc) with the title "Chapter 5. Running the Integration Test Suite (tempest) from a container" can be removed:
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/openstack_integration_test_suite_guide/index#assembly_running-the-integration-test-suite-tempest-from-a-container_tempest

Tempest team doesn't maintain the tempest container, never has and to the best of my knowledge it has never been used by any customer (the user interface of the container was not user friendly, running tempest from a container was too complicated, too many steps required). Therefore I believe the tempest container can be removed from any customer facing documentation.

Comment 7 fallen 2022-06-01 15:14:14 UTC
Hello Martin,

Please confirm that the changes made are correct: https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Linux_OpenStack_Platform/-/merge_requests/9443

Basically, as requested, I have removed Chapter 5 from the Integration test guide.

Thank you
Fiona

Comment 8 Martin Kopec 2022-06-01 15:17:23 UTC
i confirm the removal of the chapter #5, thank you Fiona