Bug 1475997

Summary: Using ansible-doc -l when pointing to the TripleO validations should not throw an error.
Product: Red Hat OpenStack Reporter: Darin Sorrentino <dsorrent>
Component: openstack-tripleo-validationsAssignee: Florian Fuchs <flfuchs>
Status: CLOSED CURRENTRELEASE QA Contact: Udi Kalifon <ukalifon>
Severity: medium Docs Contact:
Priority: medium    
Version: 11.0 (Ocata)CC: augol, beth.white, flfuchs, gchamoul, jjoyce, jschluet, slinaber, tvignaud
Target Milestone: z4Keywords: TestOnly, Triaged, ZStream
Target Release: 12.0 (Pike)   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: openstack-tripleo-validations-7.4.9-1.el7ost Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-10-22 10:42:53 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 Darin Sorrentino 2017-07-27 18:19:15 UTC
Description of problem:

If using an ansible.cfg file pointing to TripleO Validations and you attempt to list the docs for the modules, it throws an error:

$ grep ^library ansible.cfg 

library = /usr/share/openstack-tripleo-validations/validations/library

$ ansible-doc -l

ERROR! module advanced_format has a documentation error formatting or is missing documentation

$ 

The validations should have associated docs to show their use and ansible-doc -l should list those.

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


How reproducible:


Steps to Reproduce:
1. One Director create an ansible.cfg with an library pointing to /usr/share/openstack-tripleo-validations/validations/library
2. Run: ansible-doc -l
3.

Actual results:

$ ansible-doc -l

ERROR! module advanced_format has a documentation error formatting or is missing documentation


Expected results:

Document list of the validations

Additional info:

Comment 4 Lon Hohberger 2018-08-21 18:02:51 UTC
According to our records, this should be resolved by openstack-tripleo-validations-7.4.9-1.el7ost.  This build is available now.

Comment 5 Udi Kalifon 2018-10-19 11:33:24 UTC
Verified: openstack-tripleo-validations-7.4.9-1.el7ost.noarch