Bug 1576336 - Upgrade docs: all 'deploy' arguments need to be carried over to 'upgrade prepare/converge' commands
Summary: Upgrade docs: all 'deploy' arguments need to be carried over to 'upgrade prep...
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 13.0 (Queens)
Hardware: Unspecified
OS: Unspecified
Target Milestone: ---
: 13.0 (Queens)
Assignee: Dan Macpherson
QA Contact: RHOS Documentation Team
Depends On:
Blocks: 1571437
TreeView+ depends on / blocked
Reported: 2018-05-09 08:48 UTC by Jiri Stransky
Modified: 2018-08-13 04:22 UTC (History)
15 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 1571437
Last Closed: 2018-08-13 04:22:36 UTC
Target Upstream Version:

Attachments (Terms of Use)

Description Jiri Stransky 2018-05-09 08:48:05 UTC
We need to pass all `deploy` arguments to `upgrade prepare/converge` commands, not just -e parameters. (See bug 1571437 for possible effects if some params are left out.) This is most important for network data, roles data, and any role count parameters, but prepare/converge commands inherit from deploy, so we should simply carry over all.

There's a gotcha that some parameters were deprecated -- the --ntp-server and all --*-scale parameters. These should be converted into environment files, see


Comment 1 Jiri Stransky 2018-05-09 10:46:01 UTC
The commands which should receive all `deploy` args:

update prepare
update converge
upgrade prepare
upgrade converge
ffwd-upgrade prepare
ffwd-upgrade converge
ceph-upgrade run

Comment 2 Mike Orazi 2018-05-10 17:30:05 UTC
Once this is properly triaged, please make sure to add Documentation keyword.

Comment 4 Dan Macpherson 2018-08-10 03:33:20 UTC
Hi Jiri,

I ended up including a table with the deprecated CLI options:


And included the environment file for it with the ffu commands. E.g.


I also mentioned the use of --roles-file but on advice from Marius Cornea not to include the --network-files param for a couple of reasons (mainly OSP10 users will only have the default networks and we don't support changing networks in the middle of the upgrade).

How does all this sound to you? Is there anything else I should mentioned?

Comment 5 Jiri Stransky 2018-08-10 07:45:00 UTC
Hi Dan,

i looked at the doc parts you linked and i think all is good, thanks for making the edits.

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