Review prerequisites in Managing hosts (#4718)

aneta-petrova · Lennonka · aneta-petrova · commit 3edc670d9351 · 2026-03-31T21:13:09.000+02:00
Update prerequisites to comply with conventions from various style guides --------- Co-authored-by: Lena Ansorgová <zuansorg@redhat.com> (cherry picked from commit 7d50ad2)
diff --git a/guides/common/modules/proc_altering-the-privilege-elevation-method.adoc b/guides/common/modules/proc_altering-the-privilege-elevation-method.adoc
@@ -15,7 +15,8 @@ If the SSH user and effective user for push-based transport are non-root users,
 
 .Prerequisites
 * Your user account has a role assigned that grants the `view_settings` and `edit_settings` permissions.
-* If you want to use `dzdo` for Ansible jobs, ensure the `community.general` Ansible collection, which contains the required *dzdo* become plugin, is installed.
+* If you use `dzdo` for Ansible jobs, the `community.general` Ansible collection must be installed.
+This collection contains the required *dzdo* become plugin.
 For more information, see https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html[Installing collections] in _Ansible documentation_.
 
 .Procedure
diff --git a/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc b/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc
@@ -7,11 +7,11 @@
 You can use {ProjectWebUI} to review and apply errata to hosts.
 
 .Prerequisites
-* Synchronize {ProjectName} repositories with the latest errata available from Red{nbsp}Hat.
+* {ProjectName} repositories are synchronized with the latest errata available from Red{nbsp}Hat.
 For more information, see {ContentManagementDocURL}repository-synchronization[Repository synchronization] in _{ContentManagementDocTitle}_.
-* Register the hosts to an environment and content view on {ProjectServer}.
+* The hosts are registered to an environment and content view on {ProjectServer}.
 For more information, see {ManagingHostsDocURL}Registering_Hosts_by_Using_Global_Registration_managing-hosts[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_.
-* Configure the host for remote execution.
+* The host is configured for remote execution.
 For more information about running remote execution jobs, see {ManagingHostsDocURL}configuring-and-setting-up-remote-jobs[Configuring and setting up remote jobs] in _{ManagingHostsDocTitle}_.
 
 .Procedure
diff --git a/guides/common/modules/proc_configuring-a-bmc-interface.adoc b/guides/common/modules/proc_configuring-a-bmc-interface.adoc
@@ -9,7 +9,7 @@ To control the power status of bare-metal hosts from {Project}, you can configur
 .Prerequisites
 * Power management is enabled on {ProjectServer}.
 For more information, see {InstallingServerDocURL}enabling-power-management-on-hosts_{project-context}[Enabling power management on hosts] in _{InstallingServerDocTitle}_.
-* If you want to use {SmartProxyServer} instead of {ProjectServer}, ensure that power management is enabled on your {SmartProxyServer}.
+* If you use {SmartProxyServer} instead of {ProjectServer}, power management must be enabled on your {SmartProxyServer}.
 For more information, see {InstallingSmartProxyDocURL}enabling-power-management-on-hosts_{project-context}[Enabling power management on hosts] in _{InstallingSmartProxyDocTitle}_.
 * You know the MAC address, IP address, and other details of the BMC interface on the host, and authentication credentials for that interface.
 +
diff --git a/guides/common/modules/proc_converting-a-host-to-rhel.adoc b/guides/common/modules/proc_converting-a-host-to-rhel.adoc
@@ -9,14 +9,14 @@ You use the Ansible role to generate conversion data on {ProjectServer}, which i
 Then you perform the actual conversion on the host by using the Ansible Playbook, which installs the Convert2RHEL CLI tool on the host and runs it.
 
 .Prerequisites
-* Review {RHELDocsBaseURL}8/html-single/converting_from_a_linux_distribution_to_rhel_using_the_convert2rhel_utility/index#con_supported-conversion-paths_converting-from-a-linux-distribution-to-rhel[Supported conversion paths] in _{RHEL}{nbsp}8 Converting from a Linux distribution to RHEL using the Convert2RHEL utility_.
-* Ensure you have a subscription manifest uploaded to your {Project} and that there are sufficient {RHEL} entitlements allocated for the conversions you intend.
+* You have reviewed the {RHELDocsBaseURL}8/html-single/converting_from_a_linux_distribution_to_rhel_using_the_convert2rhel_utility/index#con_supported-conversion-paths_converting-from-a-linux-distribution-to-rhel[supported conversion paths] in _{RHEL}{nbsp}8 Converting from a Linux distribution to RHEL using the Convert2RHEL utility_.
+* A subscription manifest is uploaded to your {Project} with sufficient {RHEL} entitlements allocated for the conversions you intend.
 Alternatively, you can use Ansible variables to tell the role to import the manifest from disk.
 The manifest must be imported to the organization to which you will register hosts for conversion.
 +
 You can update your allocations and download the updated manifest from the https://access.redhat.com[Red Hat Customer Portal].
 For more information, see {RHDocsBaseURL}subscription_central/1-latest/html-single/creating_and_managing_manifests_for_a_connected_satellite_server/index#proc-exporting-downloading-manifest-satellite-connected[Exporting and downloading a manifest] in _Creating and managing manifests for a connected Satellite Server_.
-* Ensure that you have enabled and synchronized Red Hat repositories in {Project} for the minor {RHEL} version to which you convert your hosts.
+* Red Hat repositories are enabled and synchronized in {Project} for the minor {RHEL} version to which you convert your hosts.
 For more information, see {ContentManagementDocURL}enabling-red-hat-repositories-by-using-web-ui[Enabling Red Hat Repositories] and {ContentManagementDocURL}repository-synchronization[Repository synchronization] in _{ContentManagementDocTitle}_.
 
 .Procedure
diff --git a/guides/common/modules/proc_creating-a-host-collection-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-host-collection-by-using-web-ui.adoc
@@ -6,6 +6,9 @@
 [role="_abstract"]
 The following procedure shows how to create host collections from {ProjectWebUI}.
 
+.Prerequisites
+* Your user account has a role that grants the `create_host_collections` permission.
+
 .Procedure
 . In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*.
 . Click *New Host Collection*.
diff --git a/guides/common/modules/proc_disabling-recommendations.adoc b/guides/common/modules/proc_disabling-recommendations.adoc
@@ -10,7 +10,7 @@ You can disable recommendations per organization or per host.
 .Prerequisites
 * Your {Project} account has a role that grants the following permissions: `view_foreman_rh_cloud`, `view_insights_hits`, `view_advisor`, and `edit_advisor`.
 You can get these permissions with the `ForemanRhCloud` built-in role.
-* Ensure an organization and location are selected in the top bar of the {ProjectWebUI}.
+* An organization and location are selected in the top bar of the {ProjectWebUI}.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *{Insights}* > *Recommendations*.
diff --git a/guides/common/modules/proc_enabling-cockpit-on-server.adoc b/guides/common/modules/proc_enabling-cockpit-on-server.adoc
@@ -7,6 +7,9 @@
 By default, {Cockpit} integration is disabled in {Project}.
 If you want to access {Cockpit} features for your hosts from within {Project}, you must first enable {the-Cockpit} on {ProjectServer}.
 
+.Prerequisites
+* You have root or sudo access on {ProjectServer}.
+
 .Procedure
 * Enable {the-Cockpit} on your {ProjectServer}:
 +
diff --git a/guides/common/modules/proc_enabling-recommendations.adoc b/guides/common/modules/proc_enabling-recommendations.adoc
@@ -9,7 +9,7 @@ If you have previously disabled recommendations, you can re-enable them per orga
 .Prerequisites
 * Your {Project} account has a role that grants the following permissions: `view_foreman_rh_cloud`, `view_insights_hits`, `view_advisor`, and `edit_advisor`.
 You can get these permissions with the `ForemanRhCloud` built-in role.
-* Ensure an organization and location are selected in the top bar of the {ProjectWebUI}.
+* An organization and location are selected in the top bar of the {ProjectWebUI}.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *{Insights}* > *Recommendations*.
diff --git a/guides/common/modules/proc_importing-report-templates-using-the-api.adoc b/guides/common/modules/proc_importing-report-templates-using-the-api.adoc
@@ -8,7 +8,7 @@ You can use the {Project} API to import report templates into {Project}.
 Importing report templates using the {Project} API automatically parses the report template metadata and assigns organizations and locations.
 
 .Prerequisites
-* Create a template using `.erb` syntax or export a template from another {Project}.
+* A template is created using `.erb` syntax or exported from another {Project}.
 +
 For more information about writing templates, see xref:Template_Writing_Reference_{context}[].
 +
diff --git a/guides/common/modules/proc_importing-report-templates.adoc b/guides/common/modules/proc_importing-report-templates.adoc
@@ -8,7 +8,7 @@ You can import a report template into the body of a new template that you want t
 Note that using the {ProjectWebUI}, you can only import templates individually.
 
 .Prerequisites
-* You must have exported templates from {Project} to import them to use in new templates.
+* Templates are exported from {Project} for use in new templates.
 For more information see xref:exporting-report-templates-by-using-web-ui[] and xref:exporting-report-templates-by-using-cli[].
 
 .Procedure
diff --git a/guides/common/modules/proc_installing-packages-on-a-host.adoc b/guides/common/modules/proc_installing-packages-on-a-host.adoc
@@ -7,6 +7,9 @@
 Use this procedure to review and install packages on a host using the {ProjectWebUI}.
 The list of packages available for installation depends on the content view environments assigned to the host.
 
+.Prerequisites
+* The host is assigned to a content view and lifecycle environment.
+
 .Procedure
 . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
 . Select a host.
diff --git a/guides/common/modules/proc_live-patching-hosts-using-kernelcare.adoc b/guides/common/modules/proc_live-patching-hosts-using-kernelcare.adoc
@@ -9,8 +9,8 @@ By default, `kcarectl` checks for updates every four hours.
 If the automatic installation of patches is disabled or if you want to install patches manually at a certain time, you can start the process using a remote execution job.
 
 .Prerequisites
-* Ensure your hosts have the `kernelcare` package installed.
-* Ensure your hosts have access to the internet to connect to cloudlinux.com.
+* Your hosts have the `kernelcare` package installed.
+* Your hosts have internet access to connect to cloudlinux.com.
 +
 If your host is in a disconnected environment, you can use ePortal by Tuxcare to provide Linux kernel patches.
 For more information, see https://docs.tuxcare.com/eportal/[docs.tuxcare.com/eportal].
diff --git a/guides/common/modules/proc_minimizing-collected-data.adoc b/guides/common/modules/proc_minimizing-collected-data.adoc
@@ -58,7 +58,7 @@ Review and adjust these settings to control what data {Project} shares.
 
 .Prerequisites
 * Your user account has a role that grants the `edit_settings` permission.
-* Ensure that you delete existing data in {Insights} Inventory before switching to minimal reporting.
+* Existing data in {Insights} Inventory has been deleted before switching to minimal reporting.
 To remove existing data of a system, navigate to *Inventory* > *Systems* in the {RHCloud}, select the system, and click *Delete*.
 * You have selected an organization and location.       
 
diff --git a/guides/common/modules/proc_running-ansible-roles-in-check-mode.adoc b/guides/common/modules/proc_running-ansible-roles-in-check-mode.adoc
@@ -7,10 +7,10 @@
 You can run Ansible roles in check mode through the {ProjectWebUI}.
 
 .Prerequisites
-* You must configure your deployment to run Ansible roles.
+* Your {Project} is configured to run Ansible roles.
 For more information, see xref:Configuring_Your_{project-context}_to_Run_Ansible_Roles_{context}[].
-* You must have assigned the Ansible roles to the host group.
-* You must have at least one host in your host group.
+* The Ansible roles are assigned to the host group.
+* At least one host is in your host group.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *Hosts* *>* *All Hosts*.
diff --git a/guides/common/modules/proc_running-ansible-roles-on-a-host-group.adoc b/guides/common/modules/proc_running-ansible-roles-on-a-host-group.adoc
@@ -7,10 +7,10 @@
 You can run Ansible roles on a host group through the {ProjectWebUI}.
 
 .Prerequisites
-* You must configure your deployment to run Ansible roles.
+* Your {Project} is configured to run Ansible roles.
 For more information, see xref:Configuring_Your_{project-context}_to_Run_Ansible_Roles_{context}[].
-* You must have assigned the Ansible roles to the host group.
-* You must have at least one host in your host group.
+* The Ansible roles are assigned to the host group.
+* At least one host is in your host group.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *Configure* > *Host Groups*.
diff --git a/guides/common/modules/proc_running-ansible-roles-on-a-host.adoc b/guides/common/modules/proc_running-ansible-roles-on-a-host.adoc
@@ -7,9 +7,9 @@
 You can run Ansible roles on a host through the {ProjectWebUI}.
 
 .Prerequisites
-* You must configure your deployment to run Ansible roles.
+* Your {Project} is configured to run Ansible roles.
 For more information, see xref:Configuring_Your_{project-context}_to_Run_Ansible_Roles_{context}[].
-* You must have assigned the Ansible roles to the host.
+* The Ansible roles are assigned to the host.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
diff --git a/guides/common/modules/proc_scheduling-a-recurring-ansible-job-for-a-host-group.adoc b/guides/common/modules/proc_scheduling-a-recurring-ansible-job-for-a-host-group.adoc
@@ -7,8 +7,8 @@
 You can schedule a recurring job to run Ansible roles on host groups.
 
 .Prerequisites
-* Ensure that you have assigned at least one Ansible role to your host group.
-* Ensure that you have assigned at least one host to your host group.
+* At least one Ansible role is assigned to your host group.
+* At least one host is assigned to your host group.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *Configure* > *Host Groups*.
diff --git a/guides/common/modules/proc_scheduling-a-recurring-ansible-job-for-a-host.adoc b/guides/common/modules/proc_scheduling-a-recurring-ansible-job-for-a-host.adoc
@@ -7,8 +7,8 @@
 You can schedule a recurring job to run Ansible roles on hosts.
 
 .Prerequisites
-* Ensure you have the `view_foreman_tasks`, `view_job_invocations`, and `view_recurring_logics` permissions.
-* Ensure you have assigned at least one Ansible role to your host.
+* Your user account has the `view_foreman_tasks`, `view_job_invocations`, and `view_recurring_logics` permissions.
+* At least one Ansible role is assigned to your host.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
diff --git a/guides/common/modules/proc_upgrading-hosts-to-next-major-release.adoc b/guides/common/modules/proc_upgrading-hosts-to-next-major-release.adoc
@@ -13,23 +13,23 @@ Below upgrade paths are possible:
 * {EL} 9 to {EL} 10
 
 .Prerequisites
-* Ensure that your {EL} hosts meet the requirements for the upgrade.
+* Your {EL} hosts meet the requirements for the upgrade.
 ifndef::orcharhino[]
 ** For {EL} 7 to {EL} 8 upgrade, see {RHELDocsBaseURL}8/html/upgrading_from_rhel_7_to_rhel_8/planning-an-upgrade_upgrading-from-rhel-7-to-rhel-8[Planning an upgrade] in _Upgrading from RHEL 7 to RHEL 8_.
 ** For {EL} 8 to {EL} 9 upgrade, see {RHELDocsBaseURL}9/html/upgrading_from_rhel_8_to_rhel_9/planning-an-upgrade-to-rhel-9_upgrading-from-rhel-8-to-rhel-9[Planning an upgrade to RHEL 9] in _Upgrading from RHEL 8 to RHEL 9_.
 ** For {EL} 9 to {EL} 10 upgrade, see {RHELDocsBaseURL}10/html/upgrading_from_rhel_9_to_rhel_10/planning-an-upgrade-to-rhel-10[Planning an upgrade to RHEL 10] in _Upgrading from RHEL 9 to RHEL 10_.
 endif::[]
-* Prepare your {EL} hosts for the upgrade.
+* Your {EL} hosts are prepared for the upgrade.
 ifndef::orcharhino[]
 ** For {EL} 7 to {EL} 8 upgrade, see {RHELDocsBaseURL}8/html-single/upgrading_from_rhel_7_to_rhel_8/index#preparing-a-rhel-7-system-for-the-upgrade_upgrading-from-rhel-7-to-rhel-8[Preparing a RHEL 7 system for the upgrade] in _Upgrading from RHEL 7 to RHEL 8_.
 ** For {EL} 8 to {EL} 9 upgrade, see {RHELDocsBaseURL}9/html/upgrading_from_rhel_8_to_rhel_9/assembly_preparing-for-the-upgrade_upgrading-from-rhel-8-to-rhel-9#preparing-a-rhel-8-system-for-the-upgrade_upgrading-from-rhel-8-to-rhel-9[Preparing a RHEL 8 system for the upgrade] in _Upgrading from RHEL 8 to RHEL 9_.
 ** For {EL} 9 to {EL} 10 upgrade, see {RHELDocsBaseURL}10/html/upgrading_from_rhel_9_to_rhel_10/preparing-for-the-upgrade#preparing-a-rhel-9-system-for-the-upgrade[Preparing a RHEL 9 system for the upgrade] in _Upgrading from RHEL 9 to RHEL 10_.
 endif::[]
 ifndef::satellite,orcharhino[]
-* Enable remote execution feature on {Project}.
+* Remote execution is enabled on {Project}.
 For more information, see xref:configuring-and-setting-up-remote-jobs[].
 endif::[]
-* Distribute {Project} SSH keys to the hosts that you want to upgrade.
+* {Project} SSH keys are distributed to the hosts that you want to upgrade.
 For more information, see xref:Distributing_SSH_Keys_for_Remote_Execution_{context}[].
 
 .Procedure
diff --git a/guides/common/modules/proc_viewing-patched-kernel-version.adoc b/guides/common/modules/proc_viewing-patched-kernel-version.adoc
@@ -7,7 +7,7 @@
 You can use a job template to view the patched kernel version on hosts.
 
 .Prerequisites
-* Ensure the `kernelcare` package is installed on your hosts.
+* The `kernelcare` package is installed on your hosts.
 For more information, see xref:Installing_the_KernelCare_Package_on_Hosts_{context}[].
 
 .Procedure
diff --git a/guides/common/modules/snip_registering-a-host-prerequisites.adoc b/guides/common/modules/snip_registering-a-host-prerequisites.adoc
@@ -1,16 +1,17 @@
 :_mod-docs-content-type: SNIPPET
 
 * Your {Project} account has the *Register hosts* role assigned or a role with equivalent permissions.
-* You must have root privileges on the host that you want to register.
-* You must have installed either `curl` or `wget` on the host that you want to register.
-* You have configured your host for registration.
+* Root privileges are available on the host that you want to register.
+* Either `curl` or `wget` is installed on the host that you want to register.
+* Your host is configured for registration.
 For more information, see xref:Configuring_a_Host_for_Registration_{context}[].
 ifdef::satellite,orcharhino,katello[]
 +
 include::snip_prerequisite-activation-key-available.adoc[]
 endif::[]
 ifdef::satellite[]
-* Optional: If you want to register your host to {Insights}, you must synchronize the `{RepoRHEL8BaseOS}` and `{RepoRHEL8AppStream}` repositories and make them available in the activation key that you use.
+* Optional: If you want to register your host to {Insights}, the *BaseOS* and *AppStream* RPM repositories must be synchronized and made available in the activation key that you use.
+For example, for RHEL{nbsp}8 hosts, `{RepoRHEL8BaseOS}` and `{RepoRHEL8AppStream}` repositories are required.
 This is required to install the `insights-client` package on your host.
 endif::[]
 ifdef::katello,orcharhino,satellite[]
@@ -21,7 +22,7 @@ endif::[]
 +
 include::snip_prerequisite-configured-smart-proxy-registration-provisioning.adoc[]
 ifdef::katello,orcharhino,satellite[]
-* If your {ProjectServer} or {SmartProxyServer} is behind an HTTP proxy, configure the Subscription Manager on your host to use the HTTP proxy for connection.
+* If your {ProjectServer} or {SmartProxyServer} is behind an HTTP proxy, Subscription Manager on your host is configured to use the HTTP proxy for connection.
 endif::[]
 ifdef::satellite[]
 For more information, see https://access.redhat.com/solutions/65300[How to access Red Hat Subscription Manager (RHSM) through a firewall or proxy] in the _Red{nbsp}Hat Knowledgebase_.

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ To control the power status of bare-metal hosts from {Project}, you can configur`
`9`	`9`	`.Prerequisites`
`10`	`10`	`* Power management is enabled on {ProjectServer}.`
`11`	`11`	`For more information, see {InstallingServerDocURL}enabling-power-management-on-hosts_{project-context}[Enabling power management on hosts] in _{InstallingServerDocTitle}_.`
`12`		`-* If you want to use {SmartProxyServer} instead of {ProjectServer}, ensure that power management is enabled on your {SmartProxyServer}.`
	`12`	`+* If you use {SmartProxyServer} instead of {ProjectServer}, power management must be enabled on your {SmartProxyServer}.`
`13`	`13`	`For more information, see {InstallingSmartProxyDocURL}enabling-power-management-on-hosts_{project-context}[Enabling power management on hosts] in _{InstallingSmartProxyDocTitle}_.`
`14`	`14`	`* You know the MAC address, IP address, and other details of the BMC interface on the host, and authentication credentials for that interface.`
`15`	`15`	`+`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`	`By default, {Cockpit} integration is disabled in {Project}.`
`8`	`8`	`If you want to access {Cockpit} features for your hosts from within {Project}, you must first enable {the-Cockpit} on {ProjectServer}.`
`9`	`9`
	`10`	`+.Prerequisites`
	`11`	`+* You have root or sudo access on {ProjectServer}.`
	`12`	`+`
`10`	`13`	`.Procedure`
`11`	`14`	`* Enable {the-Cockpit} on your {ProjectServer}:`
`12`	`15`	`+`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ You can use the {Project} API to import report templates into {Project}.`
`8`	`8`	`Importing report templates using the {Project} API automatically parses the report template metadata and assigns organizations and locations.`
`9`	`9`
`10`	`10`	`.Prerequisites`
`11`		-* Create a template using `.erb` syntax or export a template from another {Project}.
	`11`	+* A template is created using `.erb` syntax or exported from another {Project}.
`12`	`12`	`+`
`13`	`13`	`For more information about writing templates, see xref:Template_Writing_Reference_{context}[].`
`14`	`14`	`+`