Bug 1312691

Summary: CloudForms 4.0 Database Backup - Depot Name
Product: Red Hat CloudForms Management Engine Reporter: Andrew Spurrier <aspurrie>
Component: DocumentationAssignee: Deepti Navale <dnavale>
Status: CLOSED CURRENTRELEASE QA Contact: Suyog Sainkar <ssainkar>
Severity: medium Docs Contact:
Priority: medium    
Version: 5.5.0CC: adahms, dajohnso, jhardy, lbopf, mfeifer, obarenbo, ssainkar
Target Milestone: GA   
Target Release: 5.6.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: doc:database
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-07-05 05:04:48 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:
Attachments:
Description Flags
shows the fields for an scheduled backup using NFS. none

Description Andrew Spurrier 2016-02-28 23:56:23 UTC 
Created attachment 1131376 [details]
shows the fields for an scheduled backup using NFS.

Document URL: https://access.redhat.com/documentation/en/red-hat-cloudforms/version-4.0/general-configuration/#enabling_the_database_synchronization_role

Section Number and Name: 3.4.4.1. Scheduling a Database Backup

Describe the issue: 
1. promote section so it is visible from the Tables of Contents.  Backup is a very important part of configuration.  It should not be hidden under "Replicaton".

2. "Depot Name" is not explained and it is a required field.  It is just a human label for the name of the NFS or Samba share.

3. Image at step 7 is outdated.  Eg. text refers to "Depot Name" but the field is not shown on the image.

4. When raising this bugzilla I had to refer to the CFME version number but the CF documents only identify themselves via the CloudForms version number.  How is the reader suppose to match CFME 5.5 and CF 4.0?  Other product manuals have a section on how to report issues with the documentation.

Suggestions for improvement: 
Revise and create a CF Backup & Restore section.

Additional information:
Comment 2 Andrew Dahms 2016-05-09 01:31:07 UTC 
Assigning to Deepti for review.

Deepti - with item 4. above, it looks like a good approach might be to update the content on raising a documentation issue so that it provides a link to Bugzilla and calls out the appliance version, and remove all mention of raising a case with support. This can be added to the 'common' directory and added to the top of each guide in the suite so that we have a standard approach.

What do you think?
Comment 5 Lucy Bopf 2016-07-05 05:04:48 UTC 
Updates to the Database section are now published here:

https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/general-configuration/#backing_up_and_restoring_a_database

Version details and instructions for raising a bug are published in the abstract here:

https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/general-configuration/