Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1538209

Summary: composable networks documentation needs clearer explanation for use of process_templates.py
Product: Red Hat OpenStack Reporter: Bob Fournier <bfournie>
Component: documentationAssignee: RHOS Documentation Team <rhos-docs>
Status: CLOSED DUPLICATE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 13.0 (Queens)CC: dsneddon, srevivo
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-07-12 17:37:33 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 Bob Fournier 2018-01-24 15:56:46 UTC
Description of problem:

In the documentation here - 
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/12/html-single/advanced_overcloud_customization/index#defining_a_composable_network

The description of how to use process_templates.py in conjunction with network_environment.yaml is a bit unclear as this tool won't generate a network_environment.yaml file, just the parameters which can be used in the file.

This is some feedback we have gotten from the field:
./tools/process_templates.py does render many files, but *not* network-environment.yaml, because there is no j2 for that. The whole note implies "just make your network_data.yaml, use the tool and you will have a ready to use network-environment.yaml". This will not work. And this note is *much* to short to understand the overall process. In https://access.redhat.com/solutions/3299211 we have much cleaner and better explanation about the process and what's all about than in the doc. So better remove from the docu something too short to understand and for the mentioned case barely usable - or - rewrite this note to be a real chapter and explain the process properly.

I also have a problem with "local copy of /usr/share/openstack-tripleo-heat-templates/" because I would never every copy everything over and have hundreds of files where I am only changing 5-10. We have "--templates" to exactly avoid copying unneeded files somewhere to
- make things more readable
- easier to maintain
- easier to diff in case of upgrades
- easier to understand.

For sure you can copy over for rendering and afterwards pull out the needed files.

Comment 3 Bob Fournier 2018-07-12 17:37:33 UTC
Since this bug is a bit updated in regards to the current documentation and we have another related one, closing this as a duplicate.

*** This bug has been marked as a duplicate of bug 1600639 ***