Bug 1272144

Summary: [Docs] [Director] Basic Deployment Guide Does Not Include Deployment Paramaters
Product: Red Hat OpenStack Reporter: Dan Sneddon <dsneddon>
Component: documentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED CURRENTRELEASE QA Contact:
Severity: medium Docs Contact:
Priority: high    
Version: 7.0 (Kilo)CC: adahms, dsneddon, jtrowbri, lbopf, mburns, rhel-osp-director-maint, yeylon
Target Milestone: y2Keywords: Documentation, ZStream
Target Release: 7.0 (Kilo)   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-03-01 01:22:22 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:

Description Dan Sneddon 2015-10-15 14:47:28 UTC 
Description of problem:
In the basic deployment guide, we only give the most basic command-line parameters. However, most of the time you need to enter additional parameters to end up with a successful deployment. We cover a lot of CLI parameters in the Advanced Deployment section, but not in the Basic Deployment.

Steps to Reproduce:
1. Follow Basic Deployment guide
2. Deploy with "openstack overcloud deploy --templates"
3. (Probably fail to deploy)

Actual results:
In the majority of cases, additional parameters will be required, so the deployment will fail, or hang, or will complete but be non-functional.

Expected results:
The Basic Deployment guide should indicate which additional CLI parameters will be required under certain scenarios.

Additional info:
If the deployment is on virt, then the paramater '--libvirt-type qemu' is required.

If the deployment is on bare metal, then '--neutron-public-interface <NIC>' should be used to indicate which NIC will be used for the external bridge (br-ex).

The '--ntp-server <HOST>' should be used to make sure the computes and controllers don't skew too far apart (which can create token timeout errors), this is absolutely required for HA deployments

The '--neutron-network-type' and '--neutron-tunnel-types' parameters are valid for a Basic deployment, but we don't document them.

Examples should be given for different quantities of hosts:

1 controller + 1 compute: openstack deploy blahblahblah

HA: 3 controllers + 2 compute + 3 ceph: openstack deploy blahblahblah
Comment 2 John Trowbridge 2015-10-15 15:59:26 UTC 
was this meant to be filed against Director? It is posted to rdo-list.
Comment 3 Dan Sneddon 2015-10-15 20:13:58 UTC 
(In reply to John Trowbridge from comment #2)
> was this meant to be filed against Director? It is posted to rdo-list.

No, that was a mistake on my part. Thanks for catching it.
Comment 4 Andrew Dahms 2015-10-20 12:40:11 UTC 
Assigning to Dan for review.
Comment 8 Dan Macpherson 2016-01-22 03:49:37 UTC 
This change is now live: https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/7/html/Director_Installation_and_Usage/sect-Scenario_2_Using_the_CLI_to_Create_a_Basic_Overcloud.html#sect-Creating_the_Basic_Overcloud

Dan, any further changes required for this section?
Comment 9 Dan Macpherson 2016-01-22 03:50:12 UTC 
This change is now live: https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/7/html/Director_Installation_and_Usage/sect-Scenario_2_Using_the_CLI_to_Create_a_Basic_Overcloud.html#sect-Creating_the_Basic_Overcloud

Dan, any further changes required for this section?
Comment 10 Dan Macpherson 2016-03-01 01:22:22 UTC 
No response in over a month. Closing this BZ. If changes are required, feel free to reopen.