Bug 1301619 - [Docs] [Director] Documentation does not include impacts of modifying Director template files. [NEEDINFO]
[Docs] [Director] Documentation does not include impacts of modifying Directo...
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation (Show other bugs)
8.0 (Liberty)
Unspecified Unspecified
medium Severity medium
: ga
: 8.0 (Liberty)
Assigned To: Dan Macpherson
RHOS Documentation Team
: Documentation
Depends On:
  Show dependency treegraph
Reported: 2016-01-25 09:25 EST by Derek
Modified: 2018-04-14 22:12 EDT (History)
4 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Last Closed:
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---
dmacpher: needinfo? (dcadzow)

Attachments (Terms of Use)

  None (edit)
Description Derek 2016-01-25 09:25:41 EST
Description of problem:   What are the impacts on specific parts of the system if a customer makes modifications to Director template files? (which modification implies a full redeployment, which are applicable live, etc.)  No current user information about this in documentation - please assess and schedule.    

Version-Release number of selected component (if applicable):  OSP 7 or 8

Expected results: docs to be updated with this information.
Comment 2 Andrew Dahms 2016-02-07 22:09:17 EST
Assigning to Dan for review.
Comment 3 Dan Macpherson 2016-02-09 08:19:46 EST
This is a copy/paste segment from an email I wrote to multiple people outlining a plan for this BZ:

So Telefonica has asked about some documentation gaps regarding modifications to the Overcloud stack and impacts of certain modifications. There's two parts to this:

1. Telefonica had some confusion as to whether modifications to the stack occur live or whether you need to re-deploy. I said that the modifications do not happen live, but you have to modify your custom Heat template/environment files and re-run the same command from when you first deployed (openstack overcloud deploy). After running this command, the director (and more specifically Heat) performs an update on each stack resource.

2. Nicholas mentioned that there are certain impacts to performing the modifications and it would be good to document them. For example, some things can't be modified, like the network environment configuration, or else the stack update fails. Or certain caveats like you need to deploy one Ceph node in your initial deployment if you want to scale Ceph nodes.

Item 1 can be addresses quite easily by me. I can document a general modification procedure in Chapter 7 of the director guide and let customers know that modifications require subsequent runs of "openstack overcloud deploy". Although some sections in Chapter 7 use this command (e.g. the Scaling instruction), I don't think we explicitly say this is how it works. I can add this pretty much immediately as a starting point.

Item 2 is trickier and I might need some help from the Engineering team. What would be good is if we also had some general guidelines as to what can and can't modified. Things like networking, storage, hieradata, Portal registration details, etc, etc. This is kind of similar to an email Graeme Gillies raised for storage node scalability and having a table to show what was supported. So I think collating this info in similar list/table would the best approach and we can include this information with Item 1 (although if anyone has any other suggestions on how to approach this, please feel free to raise them)

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