Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1381781 - Satellite 6 puppet module documentation does not accurately describe the creation of smart class parameters / variables
Summary: Satellite 6 puppet module documentation does not accurately describe the crea...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Puppet Guide
Version: 6.2.2
Hardware: x86_64
OS: Linux
medium
medium
Target Milestone: Unspecified
Assignee: Stephen Wadeley
QA Contact: Russell Dickenson
URL:
Whiteboard:
Depends On:
Blocks: 1415680
TreeView+ depends on / blocked
 
Reported: 2016-10-05 02:25 UTC by Mihir Lele
Modified: 2020-06-11 13:00 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
: 1415680 (view as bug list)
Environment:
Last Closed: 2017-01-20 03:58:53 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)

Description Mihir Lele 2016-10-05 02:25:20 UTC 
Document URL: 

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/puppet-guide

Section Number and Name: 

3.7. Configuring Smart Variables from Puppet Classes

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/puppet-guide/#sect-Red_Hat_Satellite-Puppet_Guide-Adding_Puppet_Modules_to_Red_Hat_Satellite_6-Configuring_Smart_Variables_from_Puppet_Classes

Describe the issue:

The section talks about how you can import the smart variables, with an example module (mymodule). But, it is found that these variables (http_port) get imported under smart class parameters when the puppet class is imported in Satellite gui  


Suggestions for improvement: 

1) It looks like this section should be reframed as How to import Smart Class parameters.

2) Also, the guide does not talk about smart class parameters and there is some confusion on difference between smart class parameters and smart variables. 



Additional information: NA
Comment 1 Stephen Wadeley 2016-10-05 08:26:16 UTC 
(In reply to Mihir Lele from comment #0)

<bug snip>

> 
> 2) Also, the guide does not talk about smart class parameters and there is
> some confusion on difference between smart class parameters and smart
> variables. 
> 

Hello, the section in the Host Configuration Guide describing Parameters was recently improved. See[1]



[1] https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/host-configuration-guide/82-parameters
Comment 2 Mihir Lele 2016-10-10 18:03:40 UTC 
Hello,

Thanks for pointing to the section.

but, what about the smart variables section?

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/puppet-guide/#sect-Red_Hat_Satellite-Puppet_Guide-Adding_Puppet_Modules_to_Red_Hat_Satellite_6-Configuring_Smart_Variables_from_Puppet_Classes

I think that it should be renamed as Configuring Smart Class Parameters, as the same procedure leads in importing the smart class parameters.

Do you want me to create a separate BZ for that, or that can be included under this BZ.
Comment 3 Andrew Dahms 2016-12-07 22:59:46 UTC 
Assigning to Stephen for review.
Comment 4 Stephen Wadeley 2017-01-02 10:45:46 UTC 
(In reply to Mihir Lele from comment #2)
> Hello,
> 
> Thanks for pointing to the section.
> 
> but, what about the smart variables section?
> 
> https://access.redhat.com/documentation/en/red-hat-satellite/6.2/single/
> puppet-guide/#sect-Red_Hat_Satellite-Puppet_Guide-
> Adding_Puppet_Modules_to_Red_Hat_Satellite_6-
> Configuring_Smart_Variables_from_Puppet_Classes
> 
> I think that it should be renamed as Configuring Smart Class Parameters, as
> the same procedure leads in importing the smart class parameters.

Yes, I agree will change that procedure.

I have tested the procedures from the beginning of the guide and I can see that you are correct.

> 
> Do you want me to create a separate BZ for that, or that can be included
> under this BZ.

Replacing the procedure "Configuring Smart Variables from Puppet Classes" with a procedure "Configuring Smart Class Parameters from Puppet Classes" is in the scope of this bug. If you think we need a new section to properly explain "Configuring Smart Class Parameters" then we should raise a new bug to avoid delaying this bugs task (because bug fix usually more urgent than RFE).

I noticed some other problems while testing, such as incorrect port number. Will fix that too in this bug.

Thank you and sorry for the delay.
Comment 14 Andrew Dahms 2017-01-20 03:58:53 UTC 
This content is now live on the Customer Portal.

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