Bug 1328132 - Information on available parameters missing for order field in Smart Class Parameter
Summary: Information on available parameters missing for order field in Smart Class P...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs User Guide
Version: 6.1.8
Hardware: All
OS: Linux
medium
medium vote
Target Milestone: Unspecified
Assignee: Stephen Wadeley
QA Contact: Lucie Jirakova
URL:
Whiteboard:
: 1285706 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-04-18 14:26 UTC by dgupte
Modified: 2020-02-14 17:44 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-11-14 10:11:54 UTC
Target Upstream Version:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1285706 0 medium CLOSED Docs should list parameters available for matching overrides 2021-02-22 00:41:40 UTC

Internal Links: 1285706

Description dgupte 2016-04-18 14:26:09 UTC
Document URL: 
https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/6.1/html-single/User_Guide/index.html#sect-Red_Hat_Satellite-User_Guide-Configuring_Smart_Parameters

Section Number and Name: 
13.2.2. Configuring Smart Parameters

Describe the issue: 

It is not mentioned that "it is mandatory to fill the matcher", meaning that is not clear that only matcher parameter will be looked up. Also the definition of a "matcher" is missing.
Currently, there are only fqdn, hostgroup, os, domain are available but no reference of what are other available parameters we can use in order field.

Suggestions for improvement: 
Add a paragraph that would contain a list of applicable parameters in order field.

For ex:
 puppetmaster
  domainname:
  hostgroup:
  location:
  organization:
  foreman_env:
  owner_name:
  owner_email:
  foreman_subnets:

Comment 2 Stephen Wadeley 2016-11-03 15:43:58 UTC
Hello


See also

Bug 1285706 - Docs should list parameters available for matching overrides

Bug 1374467 - [RFE] Add an 'AND' operator to the matcher conditionals


This is the "Parameters" section in the 6.2 Host Configuration Guide:

 https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/host-configuration-guide/82-parameters

Comment 3 Stephen Wadeley 2016-11-03 15:47:13 UTC
Hello

Section Number and Name: 
13.2.2. Configuring Smart Parameters

was replaced in 6.2 by

8.2.2. Configuring Smart Variables
The following procedure configures Smart Variables to override a value in a Puppet class

Comment 4 Stephen Wadeley 2016-11-03 16:14:14 UTC
Hello Ori

Re the list of parameters in comment 0


Is there some way we can explain how to discover the valid values? Because docs team are reluctant to put lists of things (reference material) in guides which can rapidly date.

At the moment, for the order field we have:

Set the Order of precedence in which the host attributes or Facts are to be evaluated against the matchers by arranging the entries in the list. You can add to the default list. 

So we mention "host attributes" and "Facts" as valid values.


I see you can find out valid Puppet Facts in the Satellite web UI:

https://sat6.example.com/fact_values


Is that useful in this context?

How can we discover all possible "host attributes"?


Thank you

Comment 5 orabin 2016-11-06 09:06:13 UTC
I'm also against a list, there is no way to list all facts because matchers can also be created on custom facts so that list is endless.

Explaining how to see which facts already exist might be helpful.

As for host attributes, that can mean either host parameters or associations to the host like hostgroup, domain, organization and so on.
The associations can only be something the host has one of, for example config group can't be used because the host can have many config groups but a host only has one location so location is a valid matcher.

Comment 6 Stephen Wadeley 2016-11-09 12:11:32 UTC
(In reply to orabin from comment #5)
> I'm also against a list, there is no way to list all facts because matchers
> can also be created on custom facts so that list is endless.
> 
> Explaining how to see which facts already exist might be helpful.

Seems I added that tip last time I worked on this section, I see this line:

To list available Puppet Facts navigate to Monitor → Facts. 

> 
> As for host attributes, that can mean either host parameters or associations
> to the host like hostgroup, domain, organization and so on.
> The associations can only be something the host has one of, for example
> config group can't be used because the host can have many config groups but
> a host only has one location so location is a valid matcher.

Last time I added this line:

It is recommend to use an attribute that is present in Facter and cannot be confused with a host attribute. 

I could add:

Host attributes can be either host parameters or associations to the host, such as host group, domain, and organization. The matcher must only be something the host has one of, for example config group cannot be used because the host can have many config groups but a host only has one location so location is a valid matcher.

Comment 8 Tomas Strachota 2016-11-09 12:38:28 UTC
*** Bug 1285706 has been marked as a duplicate of this bug. ***

Comment 9 Stephen Wadeley 2016-11-09 12:45:08 UTC
Hello

About this bit in comment 0: "it is mandatory to fill the matcher"

Is that still the case? The 6.2 web UI has that section hidden by default on my test VM. i.e. you need to expand that section to add a matcher.

I think some might just use the Default behavior to "Override the default value of the Puppet class parameter".


But maybe "Prioritize attribute order" is of no use unless you have configured a matcher.

If so, we need docs and web UI update.

Thank you

Comment 10 Stephen Wadeley 2016-11-09 13:02:12 UTC
Re this bit in the guide:

"The Prioritize attribute order section will appear if the Override option is selected"

That should be removed from "Configuring Smart Variables" section,
 it only works like that for the section "Configuring Smart Class Parameters".

There is on Override option in "Default behavior" above the "Key type" on the "Smart Variables" tab.

will fix now.

Comment 11 orabin 2016-11-09 13:13:18 UTC
It is mandatory to fill in the matcher when creating an override.

I'm not sure if comment 0 meant for overrides or in general.
It's fine to use the default value only and then there is no need to fill in any matchers.

"The Prioritize attribute order section will appear if the Override option is selected"
is relevant only for smart class parameters as you mentioned, in smart variable it always appears.

Comment 18 Stephen Wadeley 2016-11-14 10:11:54 UTC
Hello


The changes are now live on the customer portal.


https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/host-configuration-guide/82-parameters


Thank you


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