Bug 1331293 - Reference documentation of introspection rule syntax needed
Summary: Reference documentation of introspection rule syntax needed
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 8.0 (Liberty)
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Dan Macpherson
QA Contact: RHOS Documentation Team
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-04-28 08:41 UTC by David Juran
Modified: 2016-06-16 04:41 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-06-16 04:41:06 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description David Juran 2016-04-28 08:41:34 UTC
Description of problem:
The new method of automatically tagging nodes into profiles, briefly described in https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/director-installation-and-usage/appendix-c-automatic-profile-tagging need to be better documented. In particular, a reference of the rule syntax is needed, a (poorly formatted) example is not sufficient.

Comment 2 David Juran 2016-04-28 12:14:35 UTC
Upstream documentation can be found at http://docs.openstack.org/developer/ironic-inspector/usage.html

Comment 6 Dan Macpherson 2016-05-13 03:21:49 UTC
David, I've revamped this section a little and removed the information about prefixing:

https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/director-installation-and-usage/appendix-c-automatic-profile-tagging

Have a read and let me know what you think?

Comment 7 David Juran 2016-05-17 11:48:41 UTC
Hello

Does the syntax in examples really work? e.g. 

'value': '{data[inventory][bmc_address]}

or 

{"op": "lt", "field": "local_gb", "value": 1024}

Also,  I think this section should be moved to, or at least referenced in https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/director-installation-and-usage/52-inspecting-the-hardware-of-nodes since if introspection already have been done, creating rules later is moot.

Additionally, the examples would be much easier to read if they were properly indented according to the json structures.

Comment 13 Dan Macpherson 2016-06-16 04:41:06 UTC
Changes now live on the customer portal.


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