Bug 2049595

Summary: missing information about puppet attributes in API/CLI
Product: Red Hat Satellite Reporter: tstrych
Component: PuppetAssignee: Oleh Fedorenko <ofedoren>
Status: CLOSED ERRATA QA Contact: Vladimír Sedmík <vsedmik>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 6.11.0CC: oezr, ofedoren, vsedmik, zhunting
Target Milestone: 6.12.0Keywords: Triaged, UserExperience
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-11-16 13:33:25 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 tstrych 2022-02-02 12:20:47 UTC
Description of problem:
Consist from 2 parts. Missing Apidoc and hammer documentation. 
First part missing apidoc is regression from 6.10 and second part with hammer is not.

Version-Release number of selected component (if applicable):
Sat 7.0 snap 7 rhel 7

How reproducible:
Always

Steps to Reproduce:
1. enable puppet on the satellite [0]
1.5 hammer -r (another bug, #BZ2039696) 
2. hammer host create/update shows: (look below in actual results)

second part:
3. open apidoc an look at create/edit host, (described in actual results)

Actual results:
# hammer host create --help | grep puppet_attributes
 --config-group[s|-ids] LIST               Deprecated in favor of host/puppet_attributes/config_group_names/ids
 --environment[-id] VALUE                  Deprecated in favor of host/puppet_attributes/environment_name/id
 --puppetclass[es|-ids] LIST               Deprecated in favor of host/puppet_attributes/puppetclass_names/ids

# hammer host update --help | grep puppet_attributes
 --config-group[s|-ids] LIST                 Deprecated in favor of host/puppet_attributes/config_group_names/ids
 --environment[-id] VALUE                    Deprecated in favor of host/puppet_attributes/environment_name/id
 --puppetclass[es|-ids] LIST                 Deprecated in favor of host/puppet_attributes/puppetclass_names/ids

second part:
create/update host apidoc - 
    i) missing depreceted one - host[puppetclass_ids], host[config_group_ids], host[config_group_ids] - mentioned regression from 6.10
    ii) missing new one - puppet_attributes

Expected results:
A) hammer shows the not deprecated options of puppet_attributes
B) apidoc shows the deprecated and non-deprecated puppet options 


Additional info:
is there some other entity except host that can use puppet (config groups, environment or puppetclasses) as option inside subaction like (create/edit/...) if so I guess the documentation will be missing there as well.

[0] - satellite-installer --enable-foreman-plugin-puppet \
--enable-foreman-cli-puppet \
--foreman-proxy-puppet true \
--foreman-proxy-puppetca true \
--foreman-proxy-content-puppet true \
--enable-puppet \
--puppet-server true \
--puppet-server-foreman-ssl-ca /etc/pki/katello/puppet/puppet_client_ca.crt \
--puppet-server-foreman-ssl-cert /etc/pki/katello/puppet/puppet_client.crt \
--puppet-server-foreman-ssl-key /etc/pki/katello/puppet/puppet_client.key

Comment 1 tstrych 2022-02-02 12:22:22 UTC
Maybe it is Host component hard to say from my point of view.

Comment 2 Ondřej Ezr 2022-02-03 12:24:44 UTC
The message could be improved, but the new attributes are there as --puppet-class[es|-ids], --puppet-environment

see `hammer host create --help | grep puppet`

The message is hard to cover both API and hammer names of the attributes, but we can try to do something about it.

Comment 7 Oleh Fedorenko 2022-05-06 12:58:14 UTC
Created redmine issue https://projects.theforeman.org/issues/34873 from this bug

Comment 9 Bryan Kearney 2022-05-06 16:04:35 UTC
Upstream bug assigned to ofedoren

Comment 10 Bryan Kearney 2022-05-06 16:04:36 UTC
Upstream bug assigned to ofedoren

Comment 11 Bryan Kearney 2022-05-13 16:04:26 UTC
Moving this bug to POST for triage into Satellite since the upstream issue https://projects.theforeman.org/issues/34873 has been resolved.

Comment 16 errata-xmlrpc 2022-11-16 13:33:25 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Important: Satellite 6.12 Release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2022:8506