Skip to content

Commit

Permalink
Add procedure to opt-in to RH cloud reports
Browse files Browse the repository at this point in the history
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
  • Loading branch information
maximiliankolb committed Oct 8, 2024
1 parent a10ea56 commit 8986a6d
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ endif::[]

include::modules/ref_access-to-information-from-insights-in-project.adoc[leveloffset=+1]

// By default, Satellite sets "host_registration_insights" to true
// https://github.com/RedHatSatellite/foreman_theme_satellite/blob/develop/db/migrate/20201118090534_insights_param.rb
ifdef::satellite[]
include::modules/proc_excluding-hosts-from-rh-cloud-and-insights-client-reports.adoc[leveloffset=+1]
endif::[]

ifndef::satellite[]
include::modules/proc_enabling-rh-cloud-and-insights-client-reports-on-hosts.adoc[leveloffset=+1]
endif::[]

include::modules/proc_deploying-red-hat-insights-by-using-the-ansible-role.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[id="enabling-rh-cloud-and-insights-client-reports-on-hosts_{context}"]
= Enabling RH Cloud and Insights client reports on hosts

You can enable the Red Hat Insights client on hosts and have {Project} upload hosts inventory to the Insights service in the {RHCloud}.

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, {Project} automatically uploads new reports to the {RHCloud} when enabled in RH Cloud {Project} settings.
endif::[]

.Procedure
. In the {ProjectWebUI}, navigate to *Host* > *Provisioning Setup* > *Operating Systems*.
. Select any {RHEL} operating systems for which you want to change the value.
. On the *Parameters* tab, add the `host_registration_insights` parameter, select the *boolean* type, and set the value to *True*.
. Click *Submit* to save the parameter.

.Additional resources
* You can set this parameter at any level.
For more information, see {ProvisioningDocURL}Host_Parameter_Hierarchy_provisioning[Host parameter hierarchy] in _{ProvisioningDocTitle}_.
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@
You can set the `host_registration_insights` parameter to *False* to omit _rh-cloud_ and _insights-client_ reports.
{Project} will exclude the hosts from _rh-cloud_ reports and block _insights-client_ from uploading a report to the cloud.

Use the following procedure to change the value of `host_registration_insights` parameter:

.Procedure
. In the {ProjectWebUI}, navigate to *Host* > *All Hosts*.
. Select any host for which you want to change the value.
. On the *Parameters* tab, click on the edit button of `host_registration_insights`.
. Set the value to *False*.

This parameter can also be set at the organization, hostgroup, subnet, and domain level.
Also, it automatically prevents new reports from being uploaded as long as they are associated with the entity.

If you set the parameter to false on a host that is already reported on the https://console.redhat.com/[Red Hat Hybrid Cloud Console], it will be still removed automatically from the inventory.
However, this process can take some time to complete.

.Additional resources
* You can set this parameter at any level.
For more information, see {ProvisioningDocURL}Host_Parameter_Hierarchy_provisioning[Host parameter hierarchy] in _{ProvisioningDocTitle}_.

0 comments on commit 8986a6d

Please sign in to comment.