Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1769802

Summary: [Docs] [RFE] [sahara] [OSP16] Sahara removal for OSP16
Product: Red Hat OpenStack Reporter: ndeevy <ndeevy>
Component: documentationAssignee: RHOS Documentation Team <rhos-docs>
Status: CLOSED CURRENTRELEASE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: high Docs Contact:
Priority: high    
Version: 16.0 (Train)CC: ccopello, gcharot, lmarsh, ltoscano, tkajinam
Target Milestone: ---Keywords: FutureFeature, NoDocsQEReview
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: 2019-12-18 21:59:21 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:
Bug Depends On: 1712981    
Bug Blocks:    

Description ndeevy 2019-11-07 14:16:57 UTC
Remove Sahara references from the relevant documentation sections.

Comment 1 ndeevy 2019-11-08 10:39:46 UTC
Sahara mentions from OSP15 portal search:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html/overcloud_parameters/clustering-sahara-parameters

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/external_load_balancing_for_the_overcloud/index#sahara

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/firewall_rules_for_red_hat_openstack_platform/index#sahara_api

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html/bare_metal_provisioning/sect-baremetal-instances

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/openstack_data_processing/index

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/logging_monitoring_and_troubleshooting_guide/index#data_processing_sahara_log_files

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html/openstack_integration_test_suite_guide/chap-install-tempest#sec-list-of-plugins

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html/openstack_data_processing/createhadoopimg

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html/package_manifest/ch02

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html/upgrading_red_hat_openstack_platform/assembly-preparing_for_overcloud_upgrade#preparing_for_composable_networks

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/storage_guide/index#ch-intro-persistent

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/openstack_integration_test_suite_guide/index#sec-install-tempest-packages

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/product_guide/index#sect-components

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/external_load_balancing_for_the_overcloud/index#sahara

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/advanced_overcloud_customization/index#sect-Enabling_Disabled_Services

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/14/html-single/director_installation_and_usage/index#sect-Overcloud

Comment 2 ndeevy 2019-11-08 10:45:23 UTC
One more from a manual search that didn't sow up on the portal search:
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/14/html-single/command_line_interface_reference/index
There may be more.

Also, per gcharot's suggestion, we should look for diagrams that include Sahara. The graphics team would need to rework diagrams that include Sahara, this work can take time to organize and carry out.

Comment 4 ndeevy 2019-11-26 09:03:05 UTC
Hi Luigi, 
This script-generated guide [1] includes the following the line: "This command is provided by the python-saharaclient plugin." 

Do you know if it should be taken out of the code somewhere? (because if we rerun the script it will pull the contents from the code)

Or, should it remain in the guide as is?

[1] https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/15/html-single/command_line_interface_reference/index

Thanks,
Naomi

Comment 5 Luigi Toscano 2019-11-26 09:31:01 UTC
(In reply to ndeevy from comment #4)
> Hi Luigi, 
> This script-generated guide [1] includes the following the line: "This
> command is provided by the python-saharaclient plugin." 
> 
> Do you know if it should be taken out of the code somewhere? (because if we
> rerun the script it will pull the contents from the code)

All the "openstack dataprocessing foo" commands come from python-saharaclient, which means that the entire chapter 30 should disappear.
From a technical point of view, if I read the script correctly, it extracts the documentation from all available commands, but the -fooclient packages may be available even when the service is not. My suggestion is to talk with the script's author(s) and implement a blacklist mechanism. For example, also all the "openstack database foo " commands (from python-troveclient) should not be there.

Comment 6 Gregory Charot 2019-11-26 09:57:40 UTC
+1 on Luigi suggestion if possible.

Comment 7 Chuck Copello 2019-12-18 21:59:21 UTC
Content updated in 16.0-Beta guides.

Comment 8 Takashi Kajinami 2020-02-07 12:56:05 UTC
Hi,


I still see the data processing doc[1] available for osp16.0, and it doesn't say sahara was removed in osp16,
but still says "sahara is targeted for removal in osp16".
 
~~~
 The Data Processing service (sahara) is deprecated in OpenStack Platform version 15 and is targeted for removal in version 16. 
~~~

[1] https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/openstack_data_processing

IMO we should remove the doc if we don't support sahara, or at least update that description.
Could you again check the above documentation ?

Thank you,
Takashi

Comment 9 Luigi Toscano 2020-02-07 13:41:17 UTC
(In reply to Takashi Kajinami from comment #8)
> Hi,
> 
> 
> I still see the data processing doc[1] available for osp16.0, and it doesn't
> say sahara was removed in osp16,
> but still says "sahara is targeted for removal in osp16".
>  
> ~~~
>  The Data Processing service (sahara) is deprecated in OpenStack Platform
> version 15 and is targeted for removal in version 16. 
> ~~~
> 
> [1]
> https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.
> 0/html/openstack_data_processing

In fact that guide should be completely removed from the 16 documentation.

Comment 10 Takashi Kajinami 2020-02-07 14:08:13 UTC
Hi Luigi,

Thanks for your quick confirmation.
Do you want me to file another bugzilla to remove the doc,
or will we reopen this bug to manage that removal ?

Thank you,
Takashi

Comment 11 Chuck Copello 2020-02-07 16:07:25 UTC
@Takashi,

The Release Notes are updated to reflect Sahara is removed in 16.0, and the OpenStack Data Processing guide is removed from the docs splash page.

Comment 12 Takashi Kajinami 2020-02-11 11:07:05 UTC
Hi Chuck,

Thanks for the update. I confirmed that the Data Processing guide is removed from index page.

However, I still the documentation itself[1] is still alive.
 [1] https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/openstack_data_processing/index

Will we remove the doc completely ? 

If we don't does it make sense to update the following note in Chapter 1, 
~~~
The Data Processing service (sahara) is deprecated in OpenStack Platform version 15 and is targeted for removal in version 16. 
~~~
so that it clearly mentions that we don't support sahara any more, like;
~~~
The Data Processing service (sahara) is not more supported since OpenStack Platform version 16.
~~~
just in case some users directly land to the document ?

I'm afraid it would be possible that the users find the 16 data processing guide
after they find 15 one and change the version in url, as some users do to find the correct version doc.

Thank you,
Takashi

Comment 14 Takashi Kajinami 2020-02-17 04:38:21 UTC
I confirmed that the 16 guide is now completely removed.