Bug 1574472

Summary: Ambiguous openstack overcloud deploy examples in Advanced Overcloud Customization guide
Product: Red Hat OpenStack Reporter: Alex Stupnikov <astupnik>
Component: documentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED EOL QA Contact: RHOS Documentation Team <rhos-docs>
Severity: medium Docs Contact:
Priority: medium    
Version: 10.0 (Newton)CC: astupnik, dcadzow, nlevinki, srevivo
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-07-07 10:36:04 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 Alex Stupnikov 2018-05-03 11:41:36 UTC 
Description of problem:


"Chapter 4. Configuration Hooks" of "Advanced Overcloud Customization guide" contain ambiguous examples of "openstack deploy" command: it leaves an impression that the only environment file that should be provided with the command is the file that was changed/added. And this is not true.

A user should append new environment file to a list of original environment files that were used to deploy environment to update existing environment. If user will issue "openstack overcloud deploy" command with only one environment file he will break his existing environment and will be very frustrated.

It is possible to use example format from upstream documentation [1] (this is current documentation, so everything except example may be incorrect for RHOSP 10) or KCS article [2]

[1] https://docs.openstack.org/tripleo-docs/latest/install/advanced_deployment/extra_config.html
[2] https://access.redhat.com/solutions/3209781

How reproducible:

Follow multiple examples from documentation, issue "openstack overcloud deploy" with modified or created environment file.


Actual results:

Broken environment.


Expected results:

Updated environment.
Comment 1 Alex Stupnikov 2018-05-03 11:42:11 UTC 
A link to reported document:
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html/advanced_overcloud_customization/chap-configuration_hooks