Bug 1574472 - Ambiguous openstack overcloud deploy examples in Advanced Overcloud Customization guide
Summary: Ambiguous openstack overcloud deploy examples in Advanced Overcloud Customiza...
Status: NEW
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 10.0 (Newton)
Hardware: All
OS: Linux
Target Milestone: ---
: ---
Assignee: Dan Macpherson
QA Contact: RHOS Documentation Team
Depends On:
TreeView+ depends on / blocked
Reported: 2018-05-03 11:41 UTC by Alex Stupnikov
Modified: 2020-04-05 09:30 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Last Closed:
Target Upstream Version:

Attachments (Terms of Use)

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.

Note You need to log in before you can comment on or make changes to this bug.