Opt in to RH insights #3288

maximiliankolb · 2024-09-17T14:51:52Z

What changes are you introducing?

add procedure to opt-in to uploading reports to RH cloud.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

on orcharhino, users register hosts with RHEL and non-RHEL OS, but they should only set the parameter for RHEL OS.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

I am okay with my commits getting squashed when you merge this PR.
I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

Foreman 3.12/Katello 4.14 (Satellite 6.16)
Foreman 3.11/Katello 4.13
Foreman 3.10/Katello 4.12
Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
Foreman 3.8/Katello 4.10
Foreman 3.7/Katello 4.9 (Satellite 6.14)
Foreman 3.6/Katello 4.8
Foreman 3.5/Katello 4.7 (Satellite 6.13; orcharhino 6.6/6.7)
We do not accept PRs for Foreman older than 3.5.

github-actions · 2024-09-17T14:54:31Z

The PR preview for c3d9859 is available at theforeman-foreman-documentation-preview-pr-3288.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

ekohl

Generally this reads well and from a technical point of view I'd say ACK.

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

guides/common/assembly_monitoring-hosts-by-using-red-hat-insights.adoc

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

guides/common/modules/proc_excluding-hosts-from-rh-cloud-and-insights-client-reports.adoc

maximiliankolb

Rebased to "master" and applied all feedback. In general, I question the hint about all the levels to set the parameter. If we mentation "yes, you can set it globally/for this subnet", then we do not really focus on the fact that it's supposed to differ on an per-OS level, namely RHEL and non-RHEL OS.

Ready for re-review.

guides/common/modules/proc_excluding-hosts-from-rh-cloud-and-insights-client-reports.adoc

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

ekohl · 2024-09-19T09:43:03Z

In general, I question the hint about all the levels to set the parameter. If we mentation "yes, you can set it globally/for this subnet", then we do not really focus on the fact that it's supposed to differ on an per-OS level, namely RHEL and non-RHEL OS.

To me it feels a bit redundant if you understand how host parameters work. I don't know if we have a documentation section on it. I don't think we do, but IMHO we should have something like that. Then you can refer to it.

maximiliankolb · 2024-09-19T10:12:33Z

In general, I question the hint about all the levels to set the parameter. If we mentation "yes, you can set it globally/for this subnet", then we do not really focus on the fact that it's supposed to differ on an per-OS level, namely RHEL and non-RHEL OS.

To me it feels a bit redundant if you understand how host parameters work. I don't know if we have a documentation section on it. I don't think we do, but IMHO we should have something like that. Then you can refer to it.

We have a list in the Provisioning Hosts guide: https://docs.theforeman.org/nightly/Provisioning_Hosts/index-katello.html#Host_Parameter_Hierarchy_provisioning

@ekohl Are you OK with removing the sentence about "you can also set this on level X" in both procedures and instead refer users to this reference?

ekohl · 2024-09-19T10:41:11Z

@ekohl Are you OK with removing the sentence about "you can also set this on level X" in both procedures and instead refer users to this reference?

Yes, that's what I was looking for.

I do see it says:

You can access host parameters when provisioning hosts

Host parameters are indeed used when provisioning hosts, but also in other cases. The ENC as used by Puppet comes to mind, but also REX and here with RH cloud.

Perhaps you can broaden that sentence?

Edit: I was looking for this in the Administrating hosts guide and couldn't find it. Perhaps out of scope for this PR, but should it be moved?

maximiliankolb

Rebased to "master", reworked commits, and added a reference to host parameter hierarchy.

Issue to eventually move the placement of the host parameter hierarchy: #3302

Ready for re-review.

sbernhard

Thank you!

Lennonka

I see that the original module you've based it on was a mess. Perhaps this would be an opportunity to improve it as well?

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

guides/common/modules/proc_excluding-hosts-from-rh-cloud-and-insights-client-reports.adoc

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

maximiliankolb

Rebased to "master" and applied most feedback. Rewriting "excluding hosts from RH Insights" is out of scope, but I can make further minor adjustments.

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

guides/common/modules/proc_excluding-hosts-from-rh-cloud-and-insights-client-reports.adoc

asteflova

Thanks for resolving my suggestions. Lena's comment threads are open so I'll pass the review to her.

Lennonka

I have done a sanity check in the web UI and we need to make a couple of adjustments.

Lennonka · 2024-10-07T10:19:00Z

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

+ifdef::katello,foreman-el,foreman-deb[]
+Red Hat Insights is a service by Red Hat for {RHEL} hosts.
+Ensure to set this parameter for {RHEL} hosts only.
+If you set the parameter on any non-{RHEL} operating systems, it automatically uploads new reports to the {RHCloud}.


Suggested change

If you set the parameter on any non-{RHEL} operating systems, it automatically uploads new reports to the {RHCloud}.

If you set the parameter on any non-{RHEL} operating systems, {Project} automatically uploads new reports to the {RHCloud}.

This line seems confusing to me.

Does it mean that Foreman will be able to install Insights client on Debian/Ubuntu for example? If not, are the reports even generated? Is the host still included in the inventory upload? If not, then what is there to upload?
cc @chris1984 @jeremylenz Can you please help answer these questions? ^^

Also, it depends on the Inventory Upload setting whether Foreman uploads the inventory data automatically or not. It isn't hard coded.

The Insights client will not be installed on Debian / Ubuntu since the corresponding snippet has a verification if the host is running RHEL.

For the inventory upload, however, Foreman RH-Cloud searches for hosts with the parameter host_registration_insights != false independent of the fact when the parameter was actually set or if the insights client is indeed installed.

The facts it uploads to RH Hybrid Cloud Console like the (potentially obfuscated) IP address, hostname seem to be taken from the Foreman database since in our tests they appear in the inventory in RH HCC even for Debian or Ubuntu hosts.

The query loading the host information is in lib/foreman_inventory_upload/generators/queries.rb inside the rh-cloud plugin if somebody wants to have a closer look.

As far as I understand {Project} uploads an insights report if one is available and a base set of facts whereof IP and hostname can be obfuscated and packages can be excluded. The latter is not relevant for Debian or Ubuntu since they have deb_packages instead of packages.

I hope that helps in finding a wording for that line and answering your questions.

Applied Lena's suggestion.

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

This makes Vale happy.

maximiliankolb

Rebased to "master" and applied all feedback. Kindly asking for a re-review.

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

maximiliankolb · 2024-10-07T13:28:36Z

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

+ifdef::katello,foreman-el,foreman-deb[]
+Red Hat Insights is a service by Red Hat for {RHEL} hosts.
+Ensure to set this parameter for {RHEL} hosts only.
+If you set the parameter on any non-{RHEL} operating systems, it automatically uploads new reports to the {RHCloud}.


Applied Lena's suggestion.

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

Keep opt-out for Satellite; show opt-in procedure for non-Satellite builds. * Add reference to host parameter hierarchy * Drop trailing colon before procedure * Enable RH Insights for RHEL hosts only for upstream * Remove self-referential sentence * Rephrase introduction to enabling RH Insights * Reworded additional resources * Use active voice

maximiliankolb

Applied both suggestions by Lena.

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc

Lennonka

LGTM. Thank you!

maximiliankolb · 2024-10-08T07:13:10Z

Merged to "master" and cherry-picked:
bd9d5c7..1f88c99 3.12 -> 3.12
1959055..0373afc 3.11 -> 3.11

pr-processor bot added the Not yet reviewed label Sep 17, 2024

ekohl reviewed Sep 17, 2024

View reviewed changes

pr-processor bot removed the Not yet reviewed label Sep 17, 2024

sbernhard reviewed Sep 18, 2024

View reviewed changes

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc Outdated Show resolved Hide resolved

sbernhard reviewed Sep 18, 2024

View reviewed changes

guides/common/modules/proc_excluding-hosts-from-rh-cloud-and-insights-client-reports.adoc Outdated Show resolved Hide resolved

maximiliankolb force-pushed the opt_in_to_rh_insights branch from 120f1fc to 087d4b1 Compare September 19, 2024 09:19

maximiliankolb commented Sep 19, 2024

View reviewed changes

maximiliankolb force-pushed the opt_in_to_rh_insights branch from 087d4b1 to b3fbef0 Compare September 20, 2024 08:49

maximiliankolb mentioned this pull request Sep 20, 2024

Rethink placement of "Host parameter hierarchy" reference #3302

Open

maximiliankolb commented Sep 20, 2024

View reviewed changes

maximiliankolb added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Sep 20, 2024

sbernhard approved these changes Sep 26, 2024

View reviewed changes

maximiliankolb added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Sep 30, 2024

maximiliankolb requested a review from asteflova October 2, 2024 06:06

Lennonka requested changes Oct 2, 2024

View reviewed changes

pr-processor bot added the Waiting on contributor Requires an action from the author label Oct 2, 2024

asteflova reviewed Oct 3, 2024

View reviewed changes

maximiliankolb force-pushed the opt_in_to_rh_insights branch from b3fbef0 to 9635059 Compare October 4, 2024 07:04

pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Oct 4, 2024

maximiliankolb commented Oct 4, 2024

View reviewed changes

pr-processor bot removed the Needs re-review label Oct 4, 2024

maximiliankolb requested review from Lennonka and asteflova October 4, 2024 07:04

asteflova reviewed Oct 4, 2024

View reviewed changes

Lennonka requested changes Oct 7, 2024

View reviewed changes

pr-processor bot added the Waiting on contributor Requires an action from the author label Oct 7, 2024

Use if in favor of as long as

536e78b

This makes Vale happy.

maximiliankolb force-pushed the opt_in_to_rh_insights branch from 9635059 to 5b2f0ec Compare October 7, 2024 13:33

maximiliankolb commented Oct 7, 2024

View reviewed changes

pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Oct 7, 2024

Lennonka requested changes Oct 7, 2024

View reviewed changes

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc Outdated Show resolved Hide resolved

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc Outdated Show resolved Hide resolved

pr-processor bot added Waiting on contributor Requires an action from the author and removed Needs re-review labels Oct 7, 2024

maximiliankolb force-pushed the opt_in_to_rh_insights branch from 5b2f0ec to c3d9859 Compare October 7, 2024 14:47

pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Oct 7, 2024

maximiliankolb commented Oct 7, 2024

View reviewed changes

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc Outdated Show resolved Hide resolved

guides/common/modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc Outdated Show resolved Hide resolved

pr-processor bot removed the Needs re-review label Oct 7, 2024

Lennonka approved these changes Oct 7, 2024

View reviewed changes

maximiliankolb merged commit 8986a6d into theforeman:master Oct 8, 2024
9 checks passed

maximiliankolb deleted the opt_in_to_rh_insights branch October 8, 2024 07:08

maximiliankolb added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Oct 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Opt in to RH insights #3288

Opt in to RH insights #3288

maximiliankolb commented Sep 17, 2024

github-actions bot commented Sep 17, 2024 •

edited

Loading

ekohl left a comment

maximiliankolb left a comment

ekohl commented Sep 19, 2024

maximiliankolb commented Sep 19, 2024

ekohl commented Sep 19, 2024 •

edited

Loading

maximiliankolb left a comment

sbernhard left a comment

Lennonka left a comment

maximiliankolb left a comment

asteflova left a comment

Lennonka left a comment

Lennonka Oct 7, 2024

knoppi Oct 7, 2024

maximiliankolb Oct 7, 2024

maximiliankolb left a comment

maximiliankolb Oct 7, 2024

maximiliankolb left a comment

Lennonka left a comment

maximiliankolb commented Oct 8, 2024

	If you set the parameter on any non-{RHEL} operating systems, it automatically uploads new reports to the {RHCloud}.
	If you set the parameter on any non-{RHEL} operating systems, {Project} automatically uploads new reports to the {RHCloud}.

Opt in to RH insights #3288

Opt in to RH insights #3288

Conversation

maximiliankolb commented Sep 17, 2024

What changes are you introducing?

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

github-actions bot commented Sep 17, 2024 • edited Loading

ekohl left a comment

Choose a reason for hiding this comment

maximiliankolb left a comment

Choose a reason for hiding this comment

ekohl commented Sep 19, 2024

maximiliankolb commented Sep 19, 2024

ekohl commented Sep 19, 2024 • edited Loading

maximiliankolb left a comment

Choose a reason for hiding this comment

sbernhard left a comment

Choose a reason for hiding this comment

Lennonka left a comment

Choose a reason for hiding this comment

maximiliankolb left a comment

Choose a reason for hiding this comment

asteflova left a comment

Choose a reason for hiding this comment

Lennonka left a comment

Choose a reason for hiding this comment

Lennonka Oct 7, 2024

Choose a reason for hiding this comment

knoppi Oct 7, 2024

Choose a reason for hiding this comment

maximiliankolb Oct 7, 2024

Choose a reason for hiding this comment

maximiliankolb left a comment

Choose a reason for hiding this comment

maximiliankolb Oct 7, 2024

Choose a reason for hiding this comment

maximiliankolb left a comment

Choose a reason for hiding this comment

Lennonka left a comment

Choose a reason for hiding this comment

maximiliankolb commented Oct 8, 2024

github-actions bot commented Sep 17, 2024 •

edited

Loading

ekohl commented Sep 19, 2024 •

edited

Loading