Bug 1175075
| Summary: | Add "Smart Variable" section to the books | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Athene Chan <achan> |
| Component: | Docs User Guide | Assignee: | Stephen Wadeley <swadeley> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Peter Ondrejka <pondrejk> |
| Severity: | high | Docs Contact: | |
| Priority: | medium | ||
| Version: | Unspecified | CC: | adahms, aupadhye, bkearney, dlackey, fvzwieten, pdwyer, rdickens, riehecky, swadeley, xdmoon |
| Target Milestone: | Unspecified | ||
| Target Release: | Unused | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-07-15 15:52:18 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: | 1179472 | ||
| Deadline: | 2015-04-03 | ||
|
Description
Athene Chan
2014-12-17 05:56:38 UTC
Since this issue was entered in Red Hat Bugzilla, the release flag has been set to ? to ensure that it is properly evaluated for this release. Bryan or Xixi, Can you recommend an SME for this? thanks See here for the upstream documentation: http://theforeman.org/manuals/1.1/index.html#4.2.4SmartVariables for inspiration, although it assumes puppet knowledge. Concepts are not enough explained. In short: A Smart variable can be used inside puppet classes as a top level variable and can, in that respect, be seen and handled the same way as facts. It will be included in the yaml file send by Satellite (the ENC) to the host's puppet master (which is part of the capsule) for inclusion into the catalog. The "smart" part is the same as for puppet class parameters. Cleaning up flags for easier reporting. Since this issue was entered in Red Hat Bugzilla, the release flag has been set to ? to ensure that it is properly evaluated for this release. This has been flagged for 6.1 async Assigning to David for review. David - this looks like a good candidate for the User Guide. Andrew, pls refer to email about this bug. Thanks On discussion with David, re-assigning to the default assignee to be re-triaged to someone assigned more closely to work on the content in the User Guide. Hello
I found the 6.1 User Guide has a brief section on this but it is called "Configuring Smart Parameters" [1]
A bit above that is a definition:
Smart Parameters
A complex parameter that defines a value for a key but allows conditional arguments, validation, and overrides for specific object types
It seems to me the task is now to provide an example or two to make it clear how this is useful.
= = = = =
The Puppet Guide has "Configuring Smart Variables from Puppet Classes" [2]
[1]
https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/6.1/html/User_Guide/sect-Red_Hat_Satellite-User_Guide-Configuring_the_Provisioning_Environment-Parameters.html#sect-Red_Hat_Satellite-User_Guide-Configuring_Smart_Parameters
[2]
https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/6.1/html/Puppet_Guide/sect-Red_Hat_Satellite-Puppet_Guide-Adding_Puppet_Modules_to_Red_Hat_Satellite_6-Configuring_Smart_Variables_from_Puppet_Classes.html
Hello This has now been published here: https://access.redhat.com/documentation/en/red-hat-satellite/6.2-beta/host-configuration-guide/82-parameters Thank you |