Bug 1382585

Summary: [Docs] [RFE] [Storage] Add a section on the new OpenStack Swift provider
Product: Red Hat CloudForms Management Engine Reporter: Andrew Dahms <adahms>
Component: DocumentationAssignee: Dayle Parker <dayleparker>
Status: CLOSED CURRENTRELEASE QA Contact: Don Domingo <ddomingo>
Severity: medium Docs Contact:
Priority: medium    
Version: 5.7.0CC: ddomingo, hhudgeon, jhardy, jkeselma, obarenbo, roliveri
Target Milestone: GAKeywords: FutureFeature
Target Release: 5.7.0   
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: 2017-01-09 03:19:36 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:

Description Andrew Dahms 2016-10-07 05:52:32 UTC
Red Hat CloudForms 4.2 adds a new OSP Swift Manager provider that allows users to interact with volumes in OpenStack environments. A section needs to be added to the new 'Storage Providers' chapter of the Managing Providers guide that includes the following -

* A section on the Swift provider with -
  - An introduction to the Swift provider
  - Procedures with basic actions such as viewing timelines, etc.
  - A procedure on how to view object stores (via the object stores tab)

Comment 1 Andrew Dahms 2016-10-20 01:30:24 UTC
Assigning to Dayle for review.

Comment 2 Dayle Parker 2016-11-01 05:15:41 UTC
Checked in draft content in BZ1382585-swift.
Need to be linked from Storage_Providers.adoc, in the Cinder branch BZ1382584-cinder.

Comment 4 Dayle Parker 2016-11-04 04:01:55 UTC
Hi Rich,

Would you mind reviewing the draft content on Swift providers please, and letting me know of any corrections/additions to make?

If you're the wrong person to ask, please feel free to send the needinfo to the best person to review.

Thank you,
Dayle

Comment 5 Dayle Parker 2016-11-04 04:02:22 UTC
Hi Rich,

Would you mind reviewing the draft content on Swift providers (link in Comment 3) please, and letting me know of any corrections/additions to make?

If you're the wrong person to ask, please feel free to send the needinfo to the best person to review.

Thank you,
Dayle

Comment 6 Rich Oliveri 2016-11-14 18:16:46 UTC
Jerry,

Can you review this as per Dayle's request?

Thanks,
Rich

Comment 7 Jerry Keselman 2016-11-14 19:05:34 UTC
Hi Dayle,

Some comments - 

1) We should consider Swift and Cinder under Openstack to be "Managers", not "Providers".  I know that the UI may indicate them to be "Providers" in the release you are documenting, but that is changed in the next iteration of the code.  
Based on this - Chapter 5 should be titled "Storage Managers", and everyplace you talk about Cinder Providers or Swift Providers in the text should be changed to Cinder and Swift Managers.  When you are giving instructions about menu items that read as "Providers" I would leave that intact for the time being although as I indicated the next version of the code will change that to "Managers".  

2) The menu items will be different in the next release as well but the doc can be changed with the next true release.

3) "Viewing a Swift Provider's Timeline" - I did not realize this code path was apparent in the UI.  There is Swift event handling code in this release.  These instructions will only ever provide a screen that reads "No events available for this timeline" no matter what data points are selected.  You should probably leave this section out of the documentation for now.   I also believe the same is true for the Cinder Provider's Timeline.

4) When viewing Object Stores the top level selection displays the Object Store Container.  When you select the container to get the summary information - that is the detail for the container.  If you then click on the Object Store Objects in the link in the detail, you will get the list of Object Stores for that particular Object Store Container. And if you click on one of the object stores in the list you will get the detailed summary information for that particular Object Store.

Comment 9 Jerry Keselman 2016-11-15 20:39:42 UTC
Yes we have access to a provider you can use.  Contact me via IRC (nick jerrykbiker on #manageiq)or Gitter (jerryk55) for the login info.

There are zero or more containers per provider, and zero or more objects per container.
The revision looks better.  Thanks!

Comment 10 Dayle Parker 2016-11-16 05:55:49 UTC
Thanks for reviewing and clarifying, Jerry! 

Actually, I managed to get my hands on a provider with what I needed, so no worries. I found the procedure only just needed a few small edits. 

(Moving to ON_QA, as it will be merged as part of the BZ1382584-cinder branch for https://bugzilla.redhat.com/show_bug.cgi?id=1382584)

Comment 13 Dayle Parker 2017-01-09 03:19:36 UTC
This CloudForms 4.2 feature has been documented in the following guide & section:

https://access.redhat.com/documentation/en/red-hat-cloudforms/4.2/single/managing-providers/#openstack_object_storage_managers