Bug 1326982

Summary: [Docs] [CFME] Create the Red Hat CloudForms Quick Start Guide
Product: Red Hat OpenStack Reporter: Andrew Dahms <adahms>
Component: documentationAssignee: Martin Lopes <mlopes>
Status: CLOSED CURRENTRELEASE QA Contact: Radek Bíba <rbiba>
Severity: medium Docs Contact:
Priority: medium    
Version: 8.0 (Liberty)CC: mlopes, rbiba, srevivo
Target Milestone: gaKeywords: Documentation, ZStream
Target Release: 8.0 (Liberty)   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-07-11 23:47:54 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-04-14 00:48:41 UTC
A new guide outlining how to set up a Red Hat CloudForms instance on Red Hat OpenStack Platform must be created for publication as part of the Red Hat OpenStack Platform documentation suite.

This guide must cover the following key areas:

1. Introduction to Red Hat CloudForms
2. Installing Red Hat CloudForms
3. Adding a Red Hat OpenStack Platform Cloud Provider
4. Adding a Red Hat OpenStack Platform Infrastructure Provider
5. Instance Life Cycle Management
6. More Information

Comment 1 Andrew Dahms 2016-04-14 00:50:04 UTC
Assigning to Martin for review.

Comment 5 Martin Lopes 2016-04-15 00:23:57 UTC
Updating with feedback from Loic.

Comment 6 Martin Lopes 2016-04-15 00:33:52 UTC
* Added missing chapter: "Adding Red Hat OpenStack Platform Cloud Provider".
* Moved chapter 5 into section 4.2. (Now section 5.2 due to addition of above chapter)
* Added in sections 10.18 and 10.20, as 5.3 and 5.4.
* Changed guide's name to "QuickStart Guide for CloudForms with OpenStack".

Comment 10 Andrew Dahms 2016-05-16 07:13:04 UTC
Assigning Radek as the QA contact.

Radek - could you take a look at the changes for this bug?

Comment 11 Radek Bíba 2016-05-16 11:42:37 UTC
The guide looks great! Just a few things:

1 - Insight: Discovery, Monitoring, Utilization, Performance, Reporting, Analytic, Chargeback, and Trending.

I believe "Analytic" is actually supposed to be "Analytics". (See https://github.com/ManageIQ/manageiq/blob/master/README.md.)

2 - Control: Security, Compliance, Alerting, and Policy-Based Resource, and Configuration Enforcement.

I'm not sure sure about the commas. Is it:

 * ", Policy-Based Resource, and Configuration Enforcement" (two things, notice only one "and")? or:
 * ", and Policy-Based Resource and Configuration Enforcement" (one thing, enforcement of both resources and configuration?

3 - A SmartProxy agent must configured in each storage location

Missing "be" in front of "configured?

4 - A monitor with minimum resolution of 1280x1024.

Indefinite article in front of "minimum"?

5 - enter a unique three digit region ID

Hyphen in "three-digit"?

6 - Type a Instance Name

s/a/an/

7 - Enter a IP Address Information

s/a //

8 -  Select a Customize Template for additional instance configuration. Select from the Cloud-Init scripts stored on your appliance.

Needs some other construction, I'd say. At minimum, something like, "Use Customize Template for additional instance configuration...

(Leaving in ON_QA for now.)

Comment 14 Andrew Dahms 2016-07-11 23:47:54 UTC
This content is now live on the Customer Portal.

Closing.