Bug 1733534

Summary: [Docs] Add a note about suffixes in Director installation and Advanced Overcloud Customization guides
Product: Red Hat OpenStack Reporter: Thom Carlin <tcarlin>
Component: documentationAssignee: RHOS Documentation Team <rhos-docs>
Status: CLOSED CURRENTRELEASE QA Contact: RHOS Documentation Team <rhos-docs>
Severity: high Docs Contact:
Priority: high    
Version: 10.0 (Newton)CC: dcadzow, dmacpher, ealcaniz
Target Milestone: ---Keywords: ZStream
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-09-18 16:39:34 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:
Bug Depends On:    
Bug Blocks: 1715822    

Description Thom Carlin 2019-07-26 12:16:30 UTC 
Description of problem:

Encountered an issue 

Version-Release number of selected component (if applicable):

10-z

How reproducible:

100%

Steps to Reproduce:
1. Create an environment file with .yml extension
2. Run an openstack command using the environment file

Actual results:

Various errors (depending on usage) which aren't clear as to cause (e.g."Failed to validate: Failed to validate: resources[0]: The Resource Type (OS::TripleO::Controller::Net::SoftwareConfig) could not be found.")

Expected results:

Working command

Additional info:

This bz requests adding a note similar to: https://docs.openstack.org/heat/newton/template_guide/environment.html#override-a-resource-with-a-custom-resource: "Note

The template file extension must be .yaml or .template, or it will not be treated as a custom template resource."

Once the file(s) were renamed from the incorrect suffix (.yml) to the correct suffix (.yaml), the openstack commands worked as expected

For occasional OpenStack users, this can be extremely vexing