Bug 896197

Summary: [RFE] Documentation for "packstack"
Product: Red Hat OpenStack Reporter: Stephen Gordon <sgordon>
Component: doc-Getting_Started_GuideAssignee: Stephen Gordon <sgordon>
Status: CLOSED DUPLICATE QA Contact: ecs-bugs
Severity: high Docs Contact:
Priority: high    
Version: 2.1CC: alyoung, breeler, jclift
Target Milestone: ---Keywords: Documentation, Triaged
Target Release: 2.1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-04-04 06:04:07 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: 911101, 911195    
Bug Blocks:    

Description Stephen Gordon 2013-01-16 20:13:42 UTC
Description of problem:

For 2.1 we documentation for packstack. At this stage I've identified the following top level chapters/sections:
Part II: Deploying OpenStack using PackStack

    Introduction to PackStack
    Installing PackStack
    Using PackStack Interactively
    Using PackStack Non-Interactively
        Generating a PackStack Answer File
        Editing a PackStack Answer File
        Using a PackStack Answer File

It seems likely more will turn up but this would get us pointed in the right direction (and besides, I needed a bug to log these commits against ;)).

Comment 2 Stephen Gordon 2013-01-30 01:26:24 UTC
I had an idea here for helping to beef up the guide's multi-node credentials. As well as generally applicable information about the answer file we should provide an extra section "Example PackStack Answer Files".

This should contain a usage scenario (for instance cloud controller with multiple compute nodes, cloud controller with multiple compute nodes and separate storage nodes etc. etc.).

Comment 3 Stephen Gordon 2013-02-14 14:51:45 UTC
Swift default has changed from N to Y. Need to capture this.

Comment 4 Stephen Gordon 2013-02-14 14:52:47 UTC
(In reply to comment #3)
> Swift default has changed from N to Y. Need to capture this.

Looks like I got the wrong end of the stick here:

<derekh> swift isn't installed by default, just setting it to y, will install swift on a 1G loopback device

Comment 5 Justin Clift 2013-02-18 16:17:30 UTC
As food for thought, I'd completely missed the Packstack stuff in the documentation because of this line in Chapter 3:

  "If you are preparing a new installation of OpenStack, please skip this chapter and proceed to Chapter 8, Keystone (Identity)."

That should probably be changed to:

  If you are preparing a new installation of OpenStack, please skip this chapter and proceed to Part II. Deploying OpenStack using PackStack."

Though the approach taken so far in that Packstack section is kind of non-optimal for newbies.

Might be best to show people they can do an easy install without having to learn things first, by just using all defaults if they want?

Comment 6 Stephen Gordon 2013-02-19 04:36:58 UTC
(In reply to comment #5)
> Might be best to show people they can do an easy install without having to
> learn things first, by just using all defaults if they want?

The --all-in-one option introduced in Bug # 892247 is intended to fill this gap (in conjunction with an additional section in the documentation) but the relevant patch has only just merged upstream (today in fact) and as such does not appear in the RHOS snapshots nor the documentation at this time.

Comment 8 Stephen Gordon 2013-03-05 22:03:04 UTC
(In reply to comment #6)
> (In reply to comment #5)
> > Might be best to show people they can do an easy install without having to
> > learn things first, by just using all defaults if they want?
> 
> The --all-in-one option introduced in Bug # 892247 is intended to fill this
> gap (in conjunction with an additional section in the documentation) but the
> relevant patch has only just merged upstream (today in fact) and as such
> does not appear in the RHOS snapshots nor the documentation at this time.

On closer inspection this ended up being "--install-hosts" I have documented this in a new section titled "Quick Start using PackStack". I imagine there is still going to be some massaging of this content required but this should go a long way to filling this gap.

Comment 9 Stephen Gordon 2013-03-13 12:39:52 UTC
Outstanding:

- Need to make it clearer that for production cinder-volumes needs to be created ahead of time (we state this currently but only after it is really too late).
- Need to perform another run through to pick up last minute string changes.
- Add command line arguments to table for non-interactive.

Comment 10 Stephen Gordon 2013-03-13 12:43:47 UTC
*** Bug 911195 has been marked as a duplicate of this bug. ***

Comment 11 Stephen Gordon 2013-03-13 12:44:17 UTC
*** Bug 904250 has been marked as a duplicate of this bug. ***

Comment 12 Stephen Gordon 2013-03-13 12:55:06 UTC
In addition to comment # 9 make sure the log location listed is correct.

Comment 13 Stephen Gordon 2013-03-13 12:55:14 UTC
*** Bug 911758 has been marked as a duplicate of this bug. ***

Comment 14 Stephen Gordon 2013-03-26 15:00:12 UTC
I have posted what is likely to be my last set of patches on this material for 2.1 (aside from responding to QE review). Moving to POST.

Comment 16 Alison Young 2013-04-04 06:04:07 UTC
Marking as a duplicate of BZ921395 as that bug contains my notes from Chapter 6 as per the documentation and process review.

*** This bug has been marked as a duplicate of bug 921395 ***