diff --git a/guides/common/assembly_administering-hosts.adoc b/guides/common/assembly_administering-hosts.adoc index ea8b117b541..7879fb58512 100644 --- a/guides/common/assembly_administering-hosts.adoc +++ b/guides/common/assembly_administering-hosts.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: ASSEMBLY -include::modules/con_administering-hosts.adoc[] +include::modules/con_administering-hosts-in-project.adoc[] -include::modules/con_browsing-hosts-in-web-ui.adoc[leveloffset=+1] +include::modules/proc_browsing-hosts-in-web-ui.adoc[leveloffset=+1] -include::modules/proc_cloning-hosts.adoc[leveloffset=+1] +include::modules/proc_cloning-hosts-in-project.adoc[leveloffset=+1] include::modules/proc_associating-a-virtual-machine-from-a-hypervisor.adoc[leveloffset=+1] @@ -42,7 +42,7 @@ include::modules/proc_removing-a-host-from-server-by-using-web-ui.adoc[leveloffs include::modules/proc_removing-a-host-from-server-by-using-cli.adoc[leveloffset=+1] -include::modules/proc_disassociating-a-virtual-machine-without-removing-it-from-a-hypervisor.adoc[leveloffset=+1] +include::modules/proc_disassociating-a-vm-from-project-without-removing-it-from-a-hypervisor.adoc[leveloffset=+1] ifndef::satellite[] include::modules/proc_installing-the-snapshot-management-plugin.adoc[leveloffset=+1] diff --git a/guides/common/assembly_configuring-host-collections.adoc b/guides/common/assembly_configuring-host-collections.adoc index 19d83931c1e..5aab1787abc 100644 --- a/guides/common/assembly_configuring-host-collections.adoc +++ b/guides/common/assembly_configuring-host-collections.adoc @@ -20,9 +20,9 @@ include::modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.ado include::modules/proc_removing-a-host-from-a-host-collection.adoc[leveloffset=+1] -include::modules/con_adding-content-to-a-host-collection.adoc[leveloffset=+1] +include::modules/con_managing-host-content-with-host-collections.adoc[leveloffset=+1] -include::modules/proc_adding-packages-to-a-host-collection.adoc[leveloffset=+2] +include::modules/proc_installing-packages-on-hosts-in-a-host-collection.adoc[leveloffset=+2] include::modules/proc_viewing-installed-packages.adoc[leveloffset=+2] @@ -30,9 +30,9 @@ include::modules/proc_upgrading-a-package.adoc[leveloffset=+2] include::modules/proc_removing-a-package-from-a-host.adoc[leveloffset=+2] -include::modules/proc_adding-errata-to-a-host-collection.adoc[leveloffset=+2] +include::modules/proc_applying-errata-to-hosts-in-a-host-collection.adoc[leveloffset=+2] -include::modules/proc_adding-errata-to-a-host.adoc[leveloffset=+2] +include::modules/proc_applying-errata-to-a-host.adoc[leveloffset=+2] include::modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc[leveloffset=+2] @@ -42,6 +42,6 @@ include::modules/proc_viewing-errata-by-applicable-and-installable.adoc[leveloff include::modules/proc_generating-a-report-for-installable-and-applicable-errata.adoc[leveloffset=+2] -include::modules/proc_removing-content-from-a-host-collection.adoc[leveloffset=+2] +include::modules/proc_removing-content-from-hosts-in-a-host-collection.adoc[leveloffset=+2] include::modules/proc_changing-the-lifecycle-environment-or-content-view-of-a-host-collection.adoc[leveloffset=+2] diff --git a/guides/common/assembly_managing-packages.adoc b/guides/common/assembly_managing-packages.adoc index 52b9df55641..d7ae1e97a7d 100644 --- a/guides/common/assembly_managing-packages.adoc +++ b/guides/common/assembly_managing-packages.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY -include::modules/con_managing-packages.adoc[] +include::modules/con_managing-packages-in-project.adoc[] include::modules/proc_enabling-and-disabling-repositories-on-hosts.adoc[leveloffset=+1] diff --git a/guides/common/assembly_monitoring-hosts-by-using-insights-in-project.adoc b/guides/common/assembly_monitoring-hosts-by-using-insights-in-project.adoc index af9b9aed1ca..f64dd61b7f0 100644 --- a/guides/common/assembly_monitoring-hosts-by-using-insights-in-project.adoc +++ b/guides/common/assembly_monitoring-hosts-by-using-insights-in-project.adoc @@ -19,9 +19,9 @@ include::modules/proc_examining-recommendations-for-hosts.adoc[leveloffset=+1] include::modules/proc_remediating-issues-based-on-insights-recommendations.adoc[leveloffset=+1] -include::modules/proc_disabling-recommendations.adoc[leveloffset=+1] +include::modules/proc_disabling-recommendations-in-project.adoc[leveloffset=+1] -include::modules/proc_enabling-recommendations.adoc[leveloffset=+1] +include::modules/proc_enabling-recommendations-in-project.adoc[leveloffset=+1] include::modules/proc_examining-vulnerability-of-hosts.adoc[leveloffset=+1] diff --git a/guides/common/assembly_registering-hosts.adoc b/guides/common/assembly_registering-hosts.adoc index e6f7da42a74..d32d58487a9 100644 --- a/guides/common/assembly_registering-hosts.adoc +++ b/guides/common/assembly_registering-hosts.adoc @@ -5,7 +5,7 @@ include::modules/con_registering-hosts-and-setting-up-host-integration.adoc[] include::modules/ref_supported-clients-in-registration.adoc[leveloffset=+1] ifdef::satellite,orcharhino[] -include::modules/ref_registration-methods.adoc[leveloffset=+1] +include::modules/ref_host-registration-methods.adoc[leveloffset=+1] endif::[] // Global registration diff --git a/guides/common/assembly_template-writing-reference.adoc b/guides/common/assembly_template-writing-reference.adoc index faea1addafe..e8a9fb4bf9c 100644 --- a/guides/common/assembly_template-writing-reference.adoc +++ b/guides/common/assembly_template-writing-reference.adoc @@ -12,14 +12,14 @@ include::modules/ref_troubleshooting-erb-templates.adoc[leveloffset=+1] include::modules/ref_generic-project-specific-macros.adoc[leveloffset=+1] -include::modules/ref_template-macros.adoc[leveloffset=+1] +include::modules/ref_template-macros-reference.adoc[leveloffset=+1] -include::modules/ref_host-specific-variables.adoc[leveloffset=+1] +include::modules/ref_host-specific-variables-in-templates.adoc[leveloffset=+1] include::modules/ref_kickstart-specific-variables.adoc[leveloffset=+1] -include::modules/ref_conditional-statements.adoc[leveloffset=+1] +include::modules/ref_conditional-statements-in-erb.adoc[leveloffset=+1] -include::modules/proc_parsing-arrays.adoc[leveloffset=+1] +include::modules/proc_parsing-arrays-in-templates.adoc[leveloffset=+1] include::modules/ref_example-template-snippets.adoc[leveloffset=+1] diff --git a/guides/common/assembly_using-kernelcare.adoc b/guides/common/assembly_using-kernelcare.adoc index 97be08bcfb0..ce5b621f193 100644 --- a/guides/common/assembly_using-kernelcare.adoc +++ b/guides/common/assembly_using-kernelcare.adoc @@ -5,7 +5,7 @@ include::modules/con_using-the-kernelcare-plugin.adoc[] include::modules/proc_installing-the-kernelcare-plugin.adoc[leveloffset=+1] ifdef::katello,orcharhino[] -include::modules/con_kernelcare-client.adoc[leveloffset=+1] +include::modules/con_kernelcare-client-overview.adoc[leveloffset=+1] include::modules/ref_kernelcare-client-repositories.adoc[leveloffset=+1] endif::[] diff --git a/guides/common/modules/con_adding-content-to-a-host-collection.adoc b/guides/common/modules/con_adding-content-to-a-host-collection.adoc deleted file mode 100644 index 63cf932926b..00000000000 --- a/guides/common/modules/con_adding-content-to-a-host-collection.adoc +++ /dev/null @@ -1,7 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="Adding_Content_to_a_Host_Collection_{context}"] -= Adding content to a host collection - -[role="_abstract"] -These steps show how to add content to host collections in {ProjectName}. diff --git a/guides/common/modules/con_administering-hosts-in-project.adoc b/guides/common/modules/con_administering-hosts-in-project.adoc new file mode 100644 index 00000000000..1625a7f54e2 --- /dev/null +++ b/guides/common/modules/con_administering-hosts-in-project.adoc @@ -0,0 +1,7 @@ +:_mod-docs-content-type: CONCEPT + +[id="administering-hosts-in-{project-context}"] += Administering hosts in {Project} + +[role="_abstract"] +To manage your infrastructure from a single place, you can create, register, administer, and remove hosts in {Project}. diff --git a/guides/common/modules/con_administering-hosts.adoc b/guides/common/modules/con_administering-hosts.adoc deleted file mode 100644 index bf628865c06..00000000000 --- a/guides/common/modules/con_administering-hosts.adoc +++ /dev/null @@ -1,7 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="Administering_Hosts_{context}"] -= Administering hosts - -[role="_abstract"] -This chapter describes creating, registering, administering, and removing hosts. diff --git a/guides/common/modules/con_configuring-host-collections.adoc b/guides/common/modules/con_configuring-host-collections.adoc index 74309f2d481..c0fb74cc71b 100644 --- a/guides/common/modules/con_configuring-host-collections.adoc +++ b/guides/common/modules/con_configuring-host-collections.adoc @@ -4,7 +4,6 @@ = Configuring host collections [role="_abstract"] -A host collection in {Project} is a group of hosts. -With host collections, you can perform the same action on multiple hosts at once. -These actions include installing, removing, and updating packages, applying errata, and assigning content view environments. -For example, you can use host collections to group hosts by function, department, or business unit. +To group hosts and perform the same action on them at once, you can use host collections. +Available actions include managing packages, applying errata, or assigning content view environments. +Group hosts in a way that suits your workflow, such as by function, department, or business unit. diff --git a/guides/common/modules/con_configuring-network-interfaces.adoc b/guides/common/modules/con_configuring-network-interfaces.adoc index 0bf1b675d33..f1bda7d91ae 100644 --- a/guides/common/modules/con_configuring-network-interfaces.adoc +++ b/guides/common/modules/con_configuring-network-interfaces.adoc @@ -5,7 +5,7 @@ [role="_abstract"] {Project} supports specifying multiple network interfaces for a single host. -You can configure these interfaces when creating a new host or when editing an existing host. +This lets you add physical, virtual, bonded, bridge, or BMC interfaces as needed for your network layout. There are several types of network interfaces that you can attach to a host. When configuring an interface, select one of: diff --git a/guides/common/modules/con_converting-hosts-to-rhel.adoc b/guides/common/modules/con_converting-hosts-to-rhel.adoc index 75e26bf8637..e463ab0d937 100644 --- a/guides/common/modules/con_converting-hosts-to-rhel.adoc +++ b/guides/common/modules/con_converting-hosts-to-rhel.adoc @@ -4,4 +4,5 @@ = Converting hosts to {RHEL} [role="_abstract"] -You can convert {RHEL} derivative distributions into a supportable {RHEL} on a host while retaining installed applications and configurations. +You can convert {RHEL} derivative distributions, such as CentOS or Oracle Linux, to supported {RHEL} on a host while retaining installed applications and configurations. +This helps you move your hosts to {RHEL} without a full reinstall. diff --git a/guides/common/modules/con_host-global-status-overview.adoc b/guides/common/modules/con_host-global-status-overview.adoc index a7cb01d15f9..6c043abcf95 100644 --- a/guides/common/modules/con_host-global-status-overview.adoc +++ b/guides/common/modules/con_host-global-status-overview.adoc @@ -4,11 +4,12 @@ = Host global status overview [role="_abstract"] -The global status represents the overall status of a particular host. +You can use the host global status in {Project} to see at a glance whether a host is OK, needs attention (Warning), or has errors. +The status appears on the Hosts Overview page and helps you prioritize which hosts to investigate. -The status can have one of three possible values: *OK*, *Warning*, or *Error*. +The host global status can have one of three possible values: *OK*, *Warning*, or *Error*. You can find global status on the Hosts Overview page. -The status displays a small icon next to host name and has a color that corresponds with the status. +The status displays a small icon next to the host name and has a color that corresponds with the status. Hovering over the icon renders a tooltip with sub-status information to quickly find out more details. To view the global status for a host, in the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/con_host-groups-overview.adoc b/guides/common/modules/con_host-groups-overview.adoc index d1e666b3832..308a7c6020f 100644 --- a/guides/common/modules/con_host-groups-overview.adoc +++ b/guides/common/modules/con_host-groups-overview.adoc @@ -4,7 +4,8 @@ = Host groups overview [role="_abstract"] -A host group acts as a template for common host settings. +You can use host groups in {Project} as templates for common host settings. +Define the settings once and apply them to multiple hosts instead of configuring each host individually. ifdef::katello,orcharhino,satellite[] With host groups, you can define many settings for hosts, such as lifecycle environment, content view, or Ansible roles that are available to the hosts. diff --git a/guides/common/modules/con_host-management-and-monitoring-by-using-cockpit.adoc b/guides/common/modules/con_host-management-and-monitoring-by-using-cockpit.adoc index 227f14400b0..d41ac8fc477 100644 --- a/guides/common/modules/con_host-management-and-monitoring-by-using-cockpit.adoc +++ b/guides/common/modules/con_host-management-and-monitoring-by-using-cockpit.adoc @@ -4,7 +4,5 @@ = Host management and monitoring by using {the-Cockpit} [role="_abstract"] -You can use the {Cockpit} interactive web interface to perform actions and monitor {EL} hosts. -You can enable a remote-execution feature to integrate {Project} with {the-Cockpit}. -When you install {the-Cockpit} on a host that you manage with {Project}, you can view the {Cockpit} dashboards of that host from within the {ProjectWebUI}. -You can also use the features that are integrated with {the-Cockpit}, for example, {LoraxCompose}. +You can use the {Cockpit} web interface to perform actions and monitor {EL} hosts. +Enable {Cockpit} integration in {Project} to view host dashboards and use {Cockpit} features, such as {LoraxCompose}, from within the {ProjectWebUI}. diff --git a/guides/common/modules/con_host-substatus-overview.adoc b/guides/common/modules/con_host-substatus-overview.adoc index 7bfe85224b8..14e227248d7 100644 --- a/guides/common/modules/con_host-substatus-overview.adoc +++ b/guides/common/modules/con_host-substatus-overview.adoc @@ -4,14 +4,15 @@ = Host sub-status overview [role="_abstract"] -A sub-status monitors only a part of a host's capabilities. +You can use host sub-statuses in {Project} to see the status of specific areas of a host, such as configuration, build, or content. +Sub-statuses feed into the global host status and help you pinpoint what needs attention. To view the sub-statuses of a host, in the {ProjectWebUI}, navigate to *Hosts* > *All Hosts* and click on the host whose full status you want to inspect. You can view the global host status next to the name of the host and the host sub-statuses on the *Host status* card. Each sub-status has its own set of possible values that are mapped to the three global status values. -Below are listed sub-statuses that {Project} contains. +The following sub-statuses are available in {Project}: ifdef::foreman-el,foreman-deb,katello[] There can be more sub-statuses depending on which plugins you add to your {Project}. endif::[] diff --git a/guides/common/modules/con_job-template-examples-and-extensions.adoc b/guides/common/modules/con_job-template-examples-and-extensions.adoc index 23285fe37fb..cd21447340d 100644 --- a/guides/common/modules/con_job-template-examples-and-extensions.adoc +++ b/guides/common/modules/con_job-template-examples-and-extensions.adoc @@ -4,4 +4,4 @@ = Job template examples and extensions [role="_abstract"] -Use this section as a reference to help modify, customize, and extend your job templates to suit your requirements. +You can use these examples to modify, customize, and extend job templates for tasks such as restoring SELinux context, combining templates, or adding power actions. diff --git a/guides/common/modules/con_kernelcare-client.adoc b/guides/common/modules/con_kernelcare-client-overview.adoc similarity index 82% rename from guides/common/modules/con_kernelcare-client.adoc rename to guides/common/modules/con_kernelcare-client-overview.adoc index 931c16addf9..344c23e7193 100644 --- a/guides/common/modules/con_kernelcare-client.adoc +++ b/guides/common/modules/con_kernelcare-client-overview.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: CONCEPT -[id="KernelCare_Client_{context}"] -= KernelCare client +[id="kernelcare-client-overview"] += KernelCare client overview [role="_abstract"] After installing the KernelCare plugin, you must provide the KernelCare client to your hosts. diff --git a/guides/common/modules/con_managing-host-content-with-host-collections.adoc b/guides/common/modules/con_managing-host-content-with-host-collections.adoc new file mode 100644 index 00000000000..b2e7bc28a8d --- /dev/null +++ b/guides/common/modules/con_managing-host-content-with-host-collections.adoc @@ -0,0 +1,7 @@ +:_mod-docs-content-type: CONCEPT + +[id="managing-host-content-with-host-collections"] += Managing host content with host collections + +[role="_abstract"] +You can use host collections in {Project} to install packages, apply errata, or manage other content across all hosts in the collection. diff --git a/guides/common/modules/con_managing-packages-in-project.adoc b/guides/common/modules/con_managing-packages-in-project.adoc new file mode 100644 index 00000000000..fb4ca61d79c --- /dev/null +++ b/guides/common/modules/con_managing-packages-in-project.adoc @@ -0,0 +1,8 @@ +:_mod-docs-content-type: CONCEPT + +[id="managing-packages-in-{project-context}"] += Managing packages in {Project} + +[role="_abstract"] +You can use {Project} to install, upgrade, and remove packages and to enable or disable repositories on hosts. +Package actions use remote execution so you can manage software on hosts from a central place. diff --git a/guides/common/modules/con_managing-packages.adoc b/guides/common/modules/con_managing-packages.adoc deleted file mode 100644 index 159b1bcc011..00000000000 --- a/guides/common/modules/con_managing-packages.adoc +++ /dev/null @@ -1,9 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="managing-packages_{context}"] -= Managing packages - -[role="_abstract"] -You can use {Project} to install, upgrade, and remove packages and to enable or disable repositories on hosts. -Packages actions use 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}_. diff --git a/guides/common/modules/con_nested-host-groups.adoc b/guides/common/modules/con_nested-host-groups.adoc index 13647e1de78..d675cc98120 100644 --- a/guides/common/modules/con_nested-host-groups.adoc +++ b/guides/common/modules/con_nested-host-groups.adoc @@ -4,7 +4,7 @@ = Nested host groups [role="_abstract"] -You can create a hierarchy of host groups. +You can create a hierarchy of host groups so that child host groups inherit and override settings from parent host groups. Aim to have one base level host group that represents all hosts in your organization and provides general settings, and then nested groups that provide specific settings. diff --git a/guides/common/modules/con_overview-of-the-conversion-process.adoc b/guides/common/modules/con_overview-of-the-conversion-process.adoc index e23e46d5033..327e31293c7 100644 --- a/guides/common/modules/con_overview-of-the-conversion-process.adoc +++ b/guides/common/modules/con_overview-of-the-conversion-process.adoc @@ -4,7 +4,8 @@ = Overview of the conversion process [role="_abstract"] -{Project} provides *Convert2RHEL* utilities to simplify the conversion process. +You can use the Convert2RHEL utilities in {Project} to convert CentOS or Oracle Linux hosts to {RHEL}. +The process replaces packages with {RHEL} equivalents while retaining applications and configurations. The conversion process is similar to a minor release upgrade of {RHEL} in which every RPM package on the system is replaced. Third-party packages and non-Red Hat packages that are not available in {RHEL} are retained. diff --git a/guides/common/modules/con_registering-hosts-by-using-global-registration.adoc b/guides/common/modules/con_registering-hosts-by-using-global-registration.adoc index b9d98310fb2..7acdd921fd5 100644 --- a/guides/common/modules/con_registering-hosts-by-using-global-registration.adoc +++ b/guides/common/modules/con_registering-hosts-by-using-global-registration.adoc @@ -5,6 +5,7 @@ [role="_abstract"] You can register a host to {Project} by generating a `curl` or `wget` command on {Project} and running this command on hosts. + This method uses two provisioning templates: *Global Registration* template and *Linux host_init_config default* template. That gives you complete control over the host registration process. diff --git a/guides/common/modules/con_remote-execution-workflow.adoc b/guides/common/modules/con_remote-execution-workflow.adoc index eec73fe74f9..5b4e9c25562 100644 --- a/guides/common/modules/con_remote-execution-workflow.adoc +++ b/guides/common/modules/con_remote-execution-workflow.adoc @@ -4,7 +4,8 @@ = Remote execution workflow [role="_abstract"] -When you run a remote job on hosts, for every host, {Project} performs a series of actions to find a remote execution {SmartProxy} to use. +When you run a remote job on hosts, {Project} uses various strategies to select a remote execution {SmartProxy} for each host to balance the load across available {SmartProxies}. +Knowing how {Project} selects a {SmartProxy} helps you configure subnets and proxy assignments so remote jobs use the proxy you intend, and recognize why a job ran on a particular proxy. For custom Ansible roles that you create, or roles that you download, you must install the package containing the roles on your {SmartProxyServer}. Before you can use Ansible roles, you must import the roles into {Project} from the {SmartProxy} where they are installed. diff --git a/guides/common/modules/con_template-writing-reference.adoc b/guides/common/modules/con_template-writing-reference.adoc index 5ae380b26f6..0fb77185928 100644 --- a/guides/common/modules/con_template-writing-reference.adoc +++ b/guides/common/modules/con_template-writing-reference.adoc @@ -5,7 +5,7 @@ [role="_abstract"] Embedded Ruby (ERB) is a tool for generating text files based on templates that combine plain text with Ruby code. -This section provides an overview of {Project}-specific macros and variables that can be used in ERB templates along with some usage examples. +You can use the following {Project}-specific macros and variables in your ERB templates. When provisioning a host or running a remote job, the code in the ERB is executed and the variables are replaced with the host specific values. This process is referred to as *rendering*. diff --git a/guides/common/modules/con_transport-modes-for-remote-execution.adoc b/guides/common/modules/con_transport-modes-for-remote-execution.adoc index 4a3a87f6ea9..1ae78957447 100644 --- a/guides/common/modules/con_transport-modes-for-remote-execution.adoc +++ b/guides/common/modules/con_transport-modes-for-remote-execution.adoc @@ -4,10 +4,9 @@ = Transport modes for remote execution [role="_abstract"] -You can configure your {Project} to use two different modes of transport for remote job execution. - -The following transport modes are available for remote execution. -You can configure single {SmartProxy} to use either one mode or the other but not both. +You can configure {Project} to use push-based (SSH) or pull-based (MQTT) transport for remote job execution. +Each {SmartProxy} uses one mode. +Choose push for slightly better scalability in larger deployments or pull if your organization restricts the ports needed for SSH. Push-based transport:: On {SmartProxies} in `ssh` mode, remote execution uses the SSH service to transport job details. diff --git a/guides/common/modules/con_working-with-host-groups.adoc b/guides/common/modules/con_working-with-host-groups.adoc index 5d5acea29b5..6b0c469b3d1 100644 --- a/guides/common/modules/con_working-with-host-groups.adoc +++ b/guides/common/modules/con_working-with-host-groups.adoc @@ -4,4 +4,5 @@ = Working with host groups [role="_abstract"] -With {Project}, you can use host groups as a template for common host settings to apply these settings to multiple hosts. +To reduce repeated configuration when you manage many similar hosts, you can use host groups in {Project} as templates for shared host settings and apply them to many similar hosts. +You can also nest host groups so child groups inherit from a parent and add specifics only where needed. diff --git a/guides/common/modules/proc_accessing-the-template-writing-reference.adoc b/guides/common/modules/proc_accessing-the-template-writing-reference.adoc index 9c94b1476dc..013c67d6a9a 100644 --- a/guides/common/modules/proc_accessing-the-template-writing-reference.adoc +++ b/guides/common/modules/proc_accessing-the-template-writing-reference.adoc @@ -4,7 +4,7 @@ = Accessing the template writing reference in the {ProjectWebUI} [role="_abstract"] -You can access the template writing reference document in the {ProjectWebUI}. +You can open the template writing reference from the {ProjectWebUI} to look up ERB macros, variables, and syntax when writing or editing provisioning templates, job templates, or report templates. .Procedure . Log in to the {ProjectWebUI}. diff --git a/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc b/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc index 19ff2db8cf9..0d24554f089 100644 --- a/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc +++ b/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc @@ -4,7 +4,7 @@ = Adding a host to a host collection by using {ProjectWebUI} [role="_abstract"] -You can add a host to a host collection in the {ProjectWebUI}. +You can add a host to a host collection from the {ProjectWebUI}. Note that if you add a host to a host collection, the {Project} auditing system does not log the change. diff --git a/guides/common/modules/proc_adding-a-host-to-a-host-group.adoc b/guides/common/modules/proc_adding-a-host-to-a-host-group.adoc index e537a59bd2c..d701c58be0c 100644 --- a/guides/common/modules/proc_adding-a-host-to-a-host-group.adoc +++ b/guides/common/modules/proc_adding-a-host-to-a-host-group.adoc @@ -4,7 +4,7 @@ = Adding a host to a host group [role="_abstract"] -You can add a host to a host group in the {ProjectWebUI}. +You can add a host to a host group from the {ProjectWebUI} so that the host inherits the settings of the host group. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_adding-errata-to-a-host-collection.adoc b/guides/common/modules/proc_adding-errata-to-a-host-collection.adoc deleted file mode 100644 index fac08eb1b5b..00000000000 --- a/guides/common/modules/proc_adding-errata-to-a-host-collection.adoc +++ /dev/null @@ -1,19 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="Adding_Errata_to_a_Host_Collection_{context}"] -= Adding errata to a host collection - -[role="_abstract"] -The following procedure shows how to add errata to host collections. - -.Prerequisites -* The errata to be added should be available in one of the existing repositories or added prior to this procedure. -* Errata should be promoted to the environment where the hosts are assigned. - -.Procedure -. In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*. -. Select the host collection where the errata should be added. -. On the *Collection Actions* tab, click *Errata Installation*. -. Select the errata you want to add to the host collection and click *Install Selected* to use the default method. -Alternatively, select the drop-down icon to the right of the button to select a method to use. -Selecting the *via remote execution {endash} customize first* menu entry takes you to the *Job invocation* page where you can customize the action. diff --git a/guides/common/modules/proc_adding-errata-to-a-host.adoc b/guides/common/modules/proc_adding-errata-to-a-host.adoc deleted file mode 100644 index eb91229c55f..00000000000 --- a/guides/common/modules/proc_adding-errata-to-a-host.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="Adding_errata_to_a_single_host_{context}"] -= Adding errata to a single host - -[role="_abstract"] -Use the following procedure to add errata to a host. - -.Procedure -. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. -. Select the host you want to add errata to. -. Click *Content* and select the *Errata* tab. -. Select the errata you want to add to the host, or select the checkbox at the top of the list to add all installable errata. -Click the checkbox next to any errata you want to remove from a full list. -. Using the vertical ellipsis icon next to the errata you want to add to the host, select *Apply via Remote Execution* to use Remote Execution, or select *Apply via customized remote execution* if you want to customize the remote execution. -. Click *Submit*. diff --git a/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.adoc b/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.adoc index 11073ccf4af..197f11a9a12 100644 --- a/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.adoc +++ b/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.adoc @@ -4,7 +4,7 @@ = Adding hosts to a host collection in bulk by using Hammer CLI [role="_abstract"] -You can add multiple hosts to a host collection by using Hammer CLI. +You can add multiple hosts to a host collection at once by using Hammer CLI. Note that if you add a host to a host collection, the {Project} auditing system does not log the change. diff --git a/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui.adoc b/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui.adoc index 29027aea028..9c31e52db6e 100644 --- a/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui.adoc +++ b/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui.adoc @@ -4,7 +4,7 @@ = Adding hosts to a host collection in bulk by using {ProjectWebUI} [role="_abstract"] -You can add multiple hosts to a host collection from {ProjectWebUI}. +You can add multiple hosts to a host collection at once from the {ProjectWebUI}. Note that if you add a host to a host collection, the {Project} auditing system does not log the change. diff --git a/guides/common/modules/proc_altering-the-privilege-elevation-method.adoc b/guides/common/modules/proc_altering-the-privilege-elevation-method.adoc index e05bd242e33..18868eaa5d4 100644 --- a/guides/common/modules/proc_altering-the-privilege-elevation-method.adoc +++ b/guides/common/modules/proc_altering-the-privilege-elevation-method.adoc @@ -5,7 +5,6 @@ [role="_abstract"] By default, push-based remote execution uses `sudo` to switch from the SSH user to the effective user that executes the script on your host. -In some situations, you might require to use another method, such as `su` or `dzdo`. You can globally configure an alternative method in your {Project} settings. .Prerequisites diff --git a/guides/common/modules/proc_applying-errata-to-a-host.adoc b/guides/common/modules/proc_applying-errata-to-a-host.adoc new file mode 100644 index 00000000000..28d9248cff1 --- /dev/null +++ b/guides/common/modules/proc_applying-errata-to-a-host.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: PROCEDURE + +[id="applying-errata-to-a-host"] += Applying errata to a host + +[role="_abstract"] +To patch security vulnerabilities and bugs, you can apply errata to a host. + +.Procedure +. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. +. Select the host you want to apply errata to. +. Click *Content* and select the *Errata* tab. +. Select the errata you want to apply to the host, or select the checkbox at the top of the list to apply all installable errata. +Click the checkbox next to any errata you want to remove from a full list. +. Using the vertical ellipsis icon next to the errata you want to apply to the host, select *Apply via Remote Execution* to use Remote Execution, or select *Apply via customized remote execution* if you want to customize the remote execution. +. Click *Submit*. diff --git a/guides/common/modules/proc_applying-errata-to-hosts-by-using-cli.adoc b/guides/common/modules/proc_applying-errata-to-hosts-by-using-cli.adoc index 7994f327bea..85156326a69 100644 --- a/guides/common/modules/proc_applying-errata-to-hosts-by-using-cli.adoc +++ b/guides/common/modules/proc_applying-errata-to-hosts-by-using-cli.adoc @@ -4,7 +4,7 @@ = Applying errata to hosts by using CLI [role="_abstract"] -You can use Hammer CLI to review and apply errata to hosts. +You can use Hammer CLI to review and apply errata to hosts so that security and bugfix updates are installed on selected hosts. .Procedure . List all errata: 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 index 0a3d970e409..db4b02448c6 100644 --- 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 @@ -4,7 +4,7 @@ = Applying errata to hosts by using {ProjectWebUI} [role="_abstract"] -You can use {ProjectWebUI} to review and apply errata to hosts. +You can use the {ProjectWebUI} to review and apply errata to hosts so that security and bugfix updates are installed on selected hosts. .Prerequisites * Synchronize {ProjectName} repositories with the latest errata available from Red{nbsp}Hat. diff --git a/guides/common/modules/proc_applying-errata-to-hosts-in-a-host-collection.adoc b/guides/common/modules/proc_applying-errata-to-hosts-in-a-host-collection.adoc new file mode 100644 index 00000000000..9740018b4a2 --- /dev/null +++ b/guides/common/modules/proc_applying-errata-to-hosts-in-a-host-collection.adoc @@ -0,0 +1,19 @@ +:_mod-docs-content-type: PROCEDURE + +[id="applying-errata-to-hosts-in-a-host-collection"] += Applying errata to hosts in a host collection + +[role="_abstract"] +You can apply errata to all hosts in a host collection in one action using remote execution. + +.Prerequisites +* The errata to be applied should be available in one of the existing repositories, or the repository should be enabled on the host before this procedure. +* Errata should be promoted to the environment where the hosts are assigned. + +.Procedure +. In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*. +. Select the host collection where the errata should be applied. +. On the *Collection Actions* tab, click *Errata Installation*. +. Select the errata you want to apply to the hosts in the collection and click *Install Selected* to use the default method. +Alternatively, select the drop-down icon to the right of the button to select a method to use. +Selecting the *via remote execution {endash} customize first* menu entry takes you to the *Job invocation* page where you can customize the action. diff --git a/guides/common/modules/proc_assigning-a-host-to-a-specific-location.adoc b/guides/common/modules/proc_assigning-a-host-to-a-specific-location.adoc index 85594aaad64..4cd78b0d44e 100644 --- a/guides/common/modules/proc_assigning-a-host-to-a-specific-location.adoc +++ b/guides/common/modules/proc_assigning-a-host-to-a-specific-location.adoc @@ -4,7 +4,7 @@ = Assigning a host to a specific location [role="_abstract"] -Use this procedure to assign a host to a specific location. +You can assign a host to a different location so that the host is managed under the subnets, domains, and settings of that location. .Prerequisites * Your user account has the `assign_locations` permission. diff --git a/guides/common/modules/proc_assigning-a-host-to-a-specific-organization.adoc b/guides/common/modules/proc_assigning-a-host-to-a-specific-organization.adoc index 97591811a9a..36ba27d001c 100644 --- a/guides/common/modules/proc_assigning-a-host-to-a-specific-organization.adoc +++ b/guides/common/modules/proc_assigning-a-host-to-a-specific-organization.adoc @@ -4,7 +4,7 @@ = Assigning a host to a specific organization [role="_abstract"] -Use this procedure to assign a host to a specific organization. +You can assign a host to a different organization so that the host is managed under the content, permissions, and settings of that organization. [NOTE] ==== diff --git a/guides/common/modules/con_browsing-hosts-in-web-ui.adoc b/guides/common/modules/proc_browsing-hosts-in-web-ui.adoc similarity index 77% rename from guides/common/modules/con_browsing-hosts-in-web-ui.adoc rename to guides/common/modules/proc_browsing-hosts-in-web-ui.adoc index 3e113b7111d..e053ca3c45d 100644 --- a/guides/common/modules/con_browsing-hosts-in-web-ui.adoc +++ b/guides/common/modules/proc_browsing-hosts-in-web-ui.adoc @@ -1,4 +1,4 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: PROCEDURE [id="browsing-hosts-in-web-ui"] = Browsing hosts in {ProjectWebUI} @@ -14,16 +14,15 @@ ifdef::katello,orcharhino,satellite[] * *Host Collections* {endash} a list of user-defined collections of hosts used for bulk actions such as errata installation. endif::[] -To search for a host, type in the *Search* field, and use an asterisk ({asterisk}) to perform a partial string search. +.Procedure +. Search for a host: Type in the *Search* field, and use an asterisk ({asterisk}) to perform a partial string search. For example, if searching for a host named `{server-example-com}`, click the *All Hosts* page and type `server*` in the *Search* field. Alternatively, `{asterisk}ver{asterisk}` will also find the host `{server-example-com}`. - ++ [WARNING] ==== {ProjectServer} is listed as a host itself even if it is not self-registered. Do not delete {ProjectServer} from the list of hosts. ==== - -When you are on a particular host in the {ProjectWebUI}, you can navigate between hosts without leaving the page by using the host switcher. -Click *⇄* next to the hostname. +. Navigate between hosts: Click *⇄* next to the hostname. This displays a list of hosts in alphabetical order with a pagination arrow and a search bar to find the host you are looking for. diff --git a/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc b/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc index 371edbeb3dc..759d084b8af 100644 --- a/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc +++ b/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc @@ -4,8 +4,8 @@ = Changing the content source of a host [role="_abstract"] -A content source is a {SmartProxy} that a host consumes content from. -Use this procedure to change the content source for a host. +You can change the content source of a host so that the host consumes content from a different {SmartProxy}. +This helps you balance load or point the host to a closer or preferred content source. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_changing-the-environment-of-a-host.adoc b/guides/common/modules/proc_changing-the-environment-of-a-host.adoc index 0f35766be68..5fdc40f72b6 100644 --- a/guides/common/modules/proc_changing-the-environment-of-a-host.adoc +++ b/guides/common/modules/proc_changing-the-environment-of-a-host.adoc @@ -4,7 +4,7 @@ = Changing the environment of a host [role="_abstract"] -Use this procedure to change the environment of a host. +You can change the content view environments of a host if you need to alter which content the host can consume from {Project}. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_changing-the-host-group-of-a-host.adoc b/guides/common/modules/proc_changing-the-host-group-of-a-host.adoc index 085e22353b8..18dda5b851d 100644 --- a/guides/common/modules/proc_changing-the-host-group-of-a-host.adoc +++ b/guides/common/modules/proc_changing-the-host-group-of-a-host.adoc @@ -4,9 +4,12 @@ = Changing the host group of a host [role="_abstract"] -Use this procedure to change the Host Group of a host. +You can change the host group of a host so that the host inherits settings from the new host group. -If you reprovision a host after changing the host group, the fresh values that the host inherits from the host group will be applied. +[NOTE] +==== +If you reprovision the host, the fresh values that the host group inherits from the new host group are applied. +==== .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_changing-the-lifecycle-environment-or-content-view-of-a-host-collection.adoc b/guides/common/modules/proc_changing-the-lifecycle-environment-or-content-view-of-a-host-collection.adoc index 192e7705710..8173b2b91b1 100644 --- a/guides/common/modules/proc_changing-the-lifecycle-environment-or-content-view-of-a-host-collection.adoc +++ b/guides/common/modules/proc_changing-the-lifecycle-environment-or-content-view-of-a-host-collection.adoc @@ -4,7 +4,7 @@ = Changing the lifecycle environment or content view of a host collection [role="_abstract"] -The following procedure shows how to change the assigned lifecycle environment or content view of host collections. +You can change the lifecycle environment or content view assigned to a host collection so that all hosts in the host collection consume content from the new lifecycle environment or content view. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Host Collection*. diff --git a/guides/common/modules/proc_cloning-a-host-collection.adoc b/guides/common/modules/proc_cloning-a-host-collection.adoc index a8a26d0f281..f2ac8d131ce 100644 --- a/guides/common/modules/proc_cloning-a-host-collection.adoc +++ b/guides/common/modules/proc_cloning-a-host-collection.adoc @@ -4,7 +4,7 @@ = Cloning a host collection [role="_abstract"] -The following procedure shows how to clone a host collection. +You can clone a host collection to create a new collection with the same settings and membership, then adjust it as needed. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*. diff --git a/guides/common/modules/proc_cloning-hosts.adoc b/guides/common/modules/proc_cloning-hosts-in-project.adoc similarity index 75% rename from guides/common/modules/proc_cloning-hosts.adoc rename to guides/common/modules/proc_cloning-hosts-in-project.adoc index 7e34ee189ba..404530c0b33 100644 --- a/guides/common/modules/proc_cloning-hosts.adoc +++ b/guides/common/modules/proc_cloning-hosts-in-project.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: PROCEDURE -[id="Cloning_Hosts_{context}"] -= Cloning hosts +[id="cloning-hosts-in-{project-context}"] += Cloning hosts in {Project} [role="_abstract"] -You can clone existing hosts. +You can clone an existing host in {Project} to create a new host with the same configuration, then change the name and network settings. [NOTE] ==== diff --git a/guides/common/modules/proc_configuring-a-bmc-interface.adoc b/guides/common/modules/proc_configuring-a-bmc-interface.adoc index 012d0e9885e..3f4f58a565b 100644 --- a/guides/common/modules/proc_configuring-a-bmc-interface.adoc +++ b/guides/common/modules/proc_configuring-a-bmc-interface.adoc @@ -4,7 +4,8 @@ = Configuring a baseboard management controller (BMC) interface [role="_abstract"] -To control the power status of bare-metal hosts from {Project}, you can configure a baseboard management controller (BMC) interface for hosts that support this feature. +You can configure a baseboard management controller (BMC) interface for a host to control the power status of the host from {Project}. +This applies to bare-metal hosts that support BMC. .Prerequisites * Power management is enabled on {ProjectServer}. diff --git a/guides/common/modules/proc_configuring-a-bonded-interface-by-using-cli.adoc b/guides/common/modules/proc_configuring-a-bonded-interface-by-using-cli.adoc index 2e63a12e87c..e2bee68734b 100644 --- a/guides/common/modules/proc_configuring-a-bonded-interface-by-using-cli.adoc +++ b/guides/common/modules/proc_configuring-a-bonded-interface-by-using-cli.adoc @@ -4,7 +4,8 @@ = Configuring a bonded interface by using Hammer CLI [role="_abstract"] -You can combine multiple physical interfaces together by configuring a bonded interface for the host. +You can combine multiple physical interfaces by configuring a bonded interface for the host. +Bonding increases bandwidth and provides redundancy by making two or more network interface cards (NICs) act as one. [NOTE] ==== diff --git a/guides/common/modules/proc_configuring-a-bonded-interface-by-using-web-ui.adoc b/guides/common/modules/proc_configuring-a-bonded-interface-by-using-web-ui.adoc index 4ae57a534c0..13166cb35ba 100644 --- a/guides/common/modules/proc_configuring-a-bonded-interface-by-using-web-ui.adoc +++ b/guides/common/modules/proc_configuring-a-bonded-interface-by-using-web-ui.adoc @@ -4,7 +4,8 @@ = Configuring a bonded interface by using {ProjectWebUI} [role="_abstract"] -You can combine multiple physical interfaces together by configuring a bonded interface for the host. +You can combine multiple physical interfaces by configuring a bonded interface for the host. +Bonding increases bandwidth and provides redundancy by making two or more network interface cards (NICs) act as one. [NOTE] ==== diff --git a/guides/common/modules/proc_configuring-a-bridge-interface.adoc b/guides/common/modules/proc_configuring-a-bridge-interface.adoc index 21e0fe0c3cc..cba61d1c04a 100644 --- a/guides/common/modules/proc_configuring-a-bridge-interface.adoc +++ b/guides/common/modules/proc_configuring-a-bridge-interface.adoc @@ -4,7 +4,8 @@ = Configuring a bridge interface [role="_abstract"] -You can configure traffic forwarding between networks by configuring a bridge interface. +You can configure a bridge interface for a host to forward traffic between networks. +Use a bridge when you need to connect network segments or run virtual machines with external network access. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_configuring-a-keytab-for-kerberos-ticket-granting-tickets.adoc b/guides/common/modules/proc_configuring-a-keytab-for-kerberos-ticket-granting-tickets.adoc index cfb41664bbe..5179092ac4d 100644 --- a/guides/common/modules/proc_configuring-a-keytab-for-kerberos-ticket-granting-tickets.adoc +++ b/guides/common/modules/proc_configuring-a-keytab-for-kerberos-ticket-granting-tickets.adoc @@ -4,8 +4,8 @@ = Configuring a keytab for Kerberos ticket granting tickets [role="_abstract"] -Use this procedure to configure {Project} to use a keytab to obtain Kerberos ticket granting tickets. -If you do not set up a keytab, you must manually retrieve tickets. +You can configure {Project} to use a keytab so that it obtains Kerberos ticket-granting tickets (TGTs) automatically for remote execution. +This avoids manually retrieving tickets and enables remote jobs to use Kerberos authentication. .Procedure . Find the ID of the `foreman-proxy` user: diff --git a/guides/common/modules/proc_configuring-a-physical-interface.adoc b/guides/common/modules/proc_configuring-a-physical-interface.adoc index 7342a09d2fd..8b180a5d495 100644 --- a/guides/common/modules/proc_configuring-a-physical-interface.adoc +++ b/guides/common/modules/proc_configuring-a-physical-interface.adoc @@ -4,7 +4,7 @@ = Configuring a physical interface [role="_abstract"] -You can configure a physical interface for a host. +You can configure a physical network interface for a host to set the MAC address, device identifier, and network or DNS settings. .Procedure diff --git a/guides/common/modules/proc_configuring-a-virtual-interface.adoc b/guides/common/modules/proc_configuring-a-virtual-interface.adoc index f6f23c44320..26152764642 100644 --- a/guides/common/modules/proc_configuring-a-virtual-interface.adoc +++ b/guides/common/modules/proc_configuring-a-virtual-interface.adoc @@ -4,8 +4,8 @@ = Configuring a virtual interface [role="_abstract"] -You can configure a virtual interface for a host. -This can be either a VLAN or an alias interface. +You can configure a virtual interface for a host as a VLAN or an alias. +Use a VLAN to connect to separate network segments on one physical interface, or use an alias to add another IP address to an existing interface. * A VLAN interface allows the host to connect to separate network segments using a single physical interface. * An alias interface is an additional IP address attached to an existing interface. diff --git a/guides/common/modules/proc_configuring-project-server-for-cloud-connection.adoc b/guides/common/modules/proc_configuring-project-server-for-cloud-connection.adoc index e40b9f7ed45..415b5a5502d 100644 --- a/guides/common/modules/proc_configuring-project-server-for-cloud-connection.adoc +++ b/guides/common/modules/proc_configuring-project-server-for-cloud-connection.adoc @@ -5,6 +5,7 @@ [role="_abstract"] You can configure {ProjectServer} to connect to the {RHCloud} by using remote execution. +This enables inventory upload and cloud-based features such as {Insights} for your hosts. .Prerequisites * You have added the SSH key to authorized keys on your {ProjectServer}. diff --git a/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-cli.adoc b/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-cli.adoc index 1d5467d2e6f..71253de4654 100644 --- a/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-cli.adoc +++ b/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-cli.adoc @@ -4,8 +4,8 @@ = Configuring the fallback to any {SmartProxy} remote execution setting by using Hammer CLI [role="_abstract"] -You can enable the *Fallback to Any {SmartProxy}* setting to configure {Project} to search for remote execution {SmartProxies} from the list of {SmartProxies} that are assigned to hosts. -This can be useful if you need to run remote jobs on hosts that have no subnets configured or if the subnets of the hosts are assigned to {SmartProxies} that do not have the remote execution feature enabled. +You can enable the *Fallback to Any {SmartProxy}* setting so that {Project} can use other {SmartProxies} assigned to hosts when no remote execution {SmartProxy} is found for the host subnets. +This is useful for hosts with no subnets or when their subnets use {SmartProxies} without remote execution enabled. If the *Fallback to Any {SmartProxy}* setting is enabled, {Project} adds another set of {SmartProxies} to select the remote execution {SmartProxy} from. {Project} also selects the most lightly loaded {SmartProxy} from the set of all {SmartProxies} assigned to the host, such as the following: diff --git a/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-web-ui.adoc b/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-web-ui.adoc index b395c0783cc..a4c99bb9a68 100644 --- a/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-web-ui.adoc +++ b/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-by-using-web-ui.adoc @@ -4,8 +4,8 @@ = Configuring the fallback to any {SmartProxy} remote execution setting by using {ProjectWebUI} [role="_abstract"] -You can enable the *Fallback to Any {SmartProxy}* setting to configure {Project} to search for remote execution {SmartProxies} from the list of {SmartProxies} that are assigned to hosts. -This can be useful if you need to run remote jobs on hosts that have no subnets configured or if the subnets of the hosts are assigned to {SmartProxies} that do not have the remote execution feature enabled. +You can enable the *Fallback to Any {SmartProxy}* setting so that {Project} can use other {SmartProxies} assigned to hosts when no remote execution {SmartProxy} is found for the host subnets. +This is useful for hosts with no subnets or when their subnets use {SmartProxies} without remote execution enabled. If the *Fallback to Any {SmartProxy}* setting is enabled, {Project} adds another set of {SmartProxies} to select the remote execution {SmartProxy} from. {Project} also selects the most lightly loaded {SmartProxy} from the set of all {SmartProxies} assigned to the host, such as the following: diff --git a/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-cli.adoc b/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-cli.adoc index e7ace089521..c24b23ab7ac 100644 --- a/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-cli.adoc +++ b/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-cli.adoc @@ -4,8 +4,8 @@ = Configuring the global {SmartProxy} remote execution setting by using Hammer CLI [role="_abstract"] -By default, {Project} searches for remote execution {SmartProxies} in hosts' organizations and locations regardless of whether {SmartProxies} are assigned to hosts' subnets or not. -You can disable the *Enable Global {SmartProxy}* setting if you want to limit the search to the {SmartProxies} that are assigned to hosts' subnets. +You can enable the *Enable Global {SmartProxy}* setting so that {Project} can use any remote execution {SmartProxy} in the organization and location of the host when none is found for the subnets of the host. +You can disable it to limit job execution to {SmartProxies} assigned to the subnets of the host only. If the *Enable Global {SmartProxy}* setting is enabled, {Project} adds another set of {SmartProxies} to select the remote execution {SmartProxy} from. {Project} also selects the most lightly loaded remote execution {SmartProxy} from the set of all {SmartProxies} in the host's organization and location to execute a remote job. diff --git a/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-web-ui.adoc b/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-web-ui.adoc index c5994e88a9d..05c6099759d 100644 --- a/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-web-ui.adoc +++ b/guides/common/modules/proc_configuring-the-global-smartproxy-remote-execution-setting-by-using-web-ui.adoc @@ -4,8 +4,8 @@ = Configuring the global {SmartProxy} remote execution setting by using {ProjectWebUI} [role="_abstract"] -By default, {Project} searches for remote execution {SmartProxies} in hosts' organizations and locations regardless of whether {SmartProxies} are assigned to hosts' subnets or not. -You can disable the *Enable Global {SmartProxy}* setting if you want to limit the search to the {SmartProxies} that are assigned to hosts' subnets. +You can enable the *Enable Global {SmartProxy}* setting so that {Project} can use any remote execution {SmartProxy} in the organization and location of the host when none is found for the subnets of the host. +You can disable it to limit job execution to {SmartProxies} assigned to the subnets of the host only. If the *Enable Global {SmartProxy}* setting is enabled, {Project} adds another set of {SmartProxies} to select the remote execution {SmartProxy} from. {Project} also selects the most lightly loaded remote execution {SmartProxy} from the set of all {SmartProxies} in the host's organization and location to execute a remote job. diff --git a/guides/common/modules/proc_converting-a-host-to-rhel.adoc b/guides/common/modules/proc_converting-a-host-to-rhel.adoc index 40e1e198eec..92f0b488b15 100644 --- a/guides/common/modules/proc_converting-a-host-to-rhel.adoc +++ b/guides/common/modules/proc_converting-a-host-to-rhel.adoc @@ -4,9 +4,8 @@ = Converting a host to {RHEL} [role="_abstract"] -The *Convert2RHEL* utilities in {Project} contain an Ansible role and Ansible Playbook. -You use the Ansible role to generate conversion data on {ProjectServer}, which includes enabling required repositories and creating products, activation keys, and host groups. -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. +You can convert a host to {RHEL} by using the Convert2RHEL Ansible role and playbook in {Project}. +The role prepares conversion data on {ProjectServer}, and the playbook runs the conversion on the host. .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_. diff --git a/guides/common/modules/proc_creating-a-host-collection-by-using-cli.adoc b/guides/common/modules/proc_creating-a-host-collection-by-using-cli.adoc index 071dffcb520..45dfdaa2810 100644 --- a/guides/common/modules/proc_creating-a-host-collection-by-using-cli.adoc +++ b/guides/common/modules/proc_creating-a-host-collection-by-using-cli.adoc @@ -4,7 +4,7 @@ = Creating a host collection by using Hammer CLI [role="_abstract"] -The following procedure shows how to create host collections by using Hammer CLI. +You can create a host collection by using Hammer CLI to group hosts and perform bulk actions such as package updates or errata installation. .Procedure * Create a host collection: 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 index 7ccf9028c8e..2cc6fae15c3 100644 --- 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 @@ -4,7 +4,7 @@ = Creating a host collection by using {ProjectWebUI} [role="_abstract"] -The following procedure shows how to create host collections from {ProjectWebUI}. +You can create a host collection from the {ProjectWebUI} to group hosts and perform bulk actions such as package updates or errata installation. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*. diff --git a/guides/common/modules/proc_creating-a-host-group-by-using-cli.adoc b/guides/common/modules/proc_creating-a-host-group-by-using-cli.adoc index 5bfb3e71334..8a9bdfbcfe0 100644 --- a/guides/common/modules/proc_creating-a-host-group-by-using-cli.adoc +++ b/guides/common/modules/proc_creating-a-host-group-by-using-cli.adoc @@ -4,7 +4,7 @@ = Creating a host group by using Hammer CLI [role="_abstract"] -Create a host group to be able to apply host settings to multiple hosts. +You can create a host group by using Hammer CLI to use as a template for common host settings. .Procedure * Create a host group: diff --git a/guides/common/modules/proc_creating-a-host-group-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-host-group-by-using-web-ui.adoc index 761374fb8a0..551c7adae82 100644 --- a/guides/common/modules/proc_creating-a-host-group-by-using-web-ui.adoc +++ b/guides/common/modules/proc_creating-a-host-group-by-using-web-ui.adoc @@ -4,7 +4,7 @@ = Creating a host group by using {ProjectWebUI} [role="_abstract"] -Create a host group to be able to apply host settings to multiple hosts. +You can create a host group from the {ProjectWebUI} to use as a template for common host settings. .Procedure . In the {ProjectWebUI}, navigate to *Configure* > *Host Groups* and click *Create Host Group*. diff --git a/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc b/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc index 6eed4ec387c..e437eb8ea21 100644 --- a/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc +++ b/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc @@ -4,7 +4,8 @@ = Creating a host group for each lifecycle environment [role="_abstract"] -Use this procedure to create a host group for the Library lifecycle environment and add nested host groups for other lifecycle environments. +You can create a host group for the Library lifecycle environment and nested host groups for other lifecycle environments. +This organizes hosts by lifecycle stage, for example Development, Testing, and Production. .Procedure * To create a host group for each lifecycle environment, run the following Bash script: diff --git a/guides/common/modules/proc_creating-a-job-template-by-using-cli.adoc b/guides/common/modules/proc_creating-a-job-template-by-using-cli.adoc index 92d98cf288f..00a2eba7c8f 100644 --- a/guides/common/modules/proc_creating-a-job-template-by-using-cli.adoc +++ b/guides/common/modules/proc_creating-a-job-template-by-using-cli.adoc @@ -4,7 +4,7 @@ = Creating a job template by using Hammer CLI [role="_abstract"] -Use this procedure to create a job template by using Hammer CLI. +You can create a job template by using Hammer CLI to define a reusable script or Ansible task that you can run on hosts via remote execution. .Procedure * Create a job template using a template-definition file: diff --git a/guides/common/modules/proc_creating-a-job-template-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-job-template-by-using-web-ui.adoc index 0ba4ddead11..41cebd4f27d 100644 --- a/guides/common/modules/proc_creating-a-job-template-by-using-web-ui.adoc +++ b/guides/common/modules/proc_creating-a-job-template-by-using-web-ui.adoc @@ -4,7 +4,7 @@ = Creating a job template by using {ProjectWebUI} [role="_abstract"] -Use this procedure to create a job template from the {ProjectWebUI}. +You can create a job template from the {ProjectWebUI} to define a reusable script or Ansible task that you can run on hosts via remote execution. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Job templates*. diff --git a/guides/common/modules/proc_creating-a-report-template.adoc b/guides/common/modules/proc_creating-a-report-template.adoc index 480ce327534..057e32503d3 100644 --- a/guides/common/modules/proc_creating-a-report-template.adoc +++ b/guides/common/modules/proc_creating-a-report-template.adoc @@ -37,4 +37,4 @@ If this field remains undefined, the users receive a free-text field in which th .Additional resources * xref:Template_Writing_Reference_{context}[] -* xref:Template_Macros_{context}[] +* xref:template-macros-reference[] diff --git a/guides/common/modules/proc_disabling-cockpit-on-project.adoc b/guides/common/modules/proc_disabling-cockpit-on-project.adoc index fd7883b3251..e5868523ac9 100644 --- a/guides/common/modules/proc_disabling-cockpit-on-project.adoc +++ b/guides/common/modules/proc_disabling-cockpit-on-project.adoc @@ -4,7 +4,7 @@ = Disabling {the-Cockpit} on {Project} [role="_abstract"] -Perform the following procedure if you want to disable {the-Cockpit} on {Project}. +You can disable {the-Cockpit} on {ProjectServer} when you no longer need to access {Cockpit} features for hosts from the {ProjectWebUI}. .Procedure * Disable {the-Cockpit} on your {ProjectServer}: diff --git a/guides/common/modules/proc_disabling-recommendations.adoc b/guides/common/modules/proc_disabling-recommendations-in-project.adoc similarity index 92% rename from guides/common/modules/proc_disabling-recommendations.adoc rename to guides/common/modules/proc_disabling-recommendations-in-project.adoc index b79254890ba..076101795d2 100644 --- a/guides/common/modules/proc_disabling-recommendations.adoc +++ b/guides/common/modules/proc_disabling-recommendations-in-project.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="disabling-recommendations"] -= Disabling recommendations +[id="disabling-recommendations-in-{project-context}"] += Disabling recommendations in {Project} [role="_abstract"] You can disable recommendations per organization or per host. diff --git a/guides/common/modules/proc_disassociating-a-virtual-machine-without-removing-it-from-a-hypervisor.adoc b/guides/common/modules/proc_disassociating-a-vm-from-project-without-removing-it-from-a-hypervisor.adoc similarity index 73% rename from guides/common/modules/proc_disassociating-a-virtual-machine-without-removing-it-from-a-hypervisor.adoc rename to guides/common/modules/proc_disassociating-a-vm-from-project-without-removing-it-from-a-hypervisor.adoc index 57f744d8a4e..ae485cb810c 100644 --- a/guides/common/modules/proc_disassociating-a-virtual-machine-without-removing-it-from-a-hypervisor.adoc +++ b/guides/common/modules/proc_disassociating-a-vm-from-project-without-removing-it-from-a-hypervisor.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="Disassociating_a_Virtual_Machine_without_Removing_It_from_a_Hypervisor_{context}"] -= Disassociating a virtual machine from {Project} without removing it from a hypervisor +[id="disassociating-a-vm-from-{project-context}-without-removing-it-from-a-hypervisor"] += Disassociating a VM from {Project} without removing it from a hypervisor [role="_abstract"] You can disassociate a virtual machine (VM) from {Project} if you no longer want to manage it. diff --git a/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-cli.adoc b/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-cli.adoc index bf42d208b21..6bab88a3a76 100644 --- a/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-cli.adoc +++ b/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-cli.adoc @@ -5,7 +5,7 @@ [role="_abstract"] You can edit the system purpose attributes for your {RHEL} host by using Hammer CLI. -System purpose allows you to set the intended use of a system on your network and improves reporting accuracy in the Subscriptions service of the Red Hat Hybrid Cloud Console. +Setting system purpose defines the intended use of the system on your network and improves reporting accuracy in the Subscriptions service of the Red Hat Hybrid Cloud Console. .Prerequisites * The host that you want to edit must be registered with the subscription-manager. diff --git a/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-web-ui.adoc b/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-web-ui.adoc index e923df43ae3..2159258a696 100644 --- a/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-web-ui.adoc +++ b/guides/common/modules/proc_editing-the-system-purpose-of-a-host-by-using-web-ui.adoc @@ -4,8 +4,8 @@ = Editing the system purpose of a host by using {ProjectWebUI} [role="_abstract"] -You can edit the system purpose attributes for your {RHEL} host from the {ProjectWebUI} -System purpose allows you to set the intended use of a system on your network and improves reporting accuracy in the Subscriptions service of the Red Hat Hybrid Cloud Console. +You can edit the system purpose attributes for your {RHEL} host from the {ProjectWebUI}. +Setting system purpose defines the intended use of the system on your network and improves reporting accuracy in the Subscriptions service of the Red Hat Hybrid Cloud Console. .Prerequisites * The host that you want to edit must be registered with the subscription-manager. diff --git a/guides/common/modules/proc_editing-the-system-purpose-of-multiple-hosts.adoc b/guides/common/modules/proc_editing-the-system-purpose-of-multiple-hosts.adoc index 317ecb1f06e..2b38c52b360 100644 --- a/guides/common/modules/proc_editing-the-system-purpose-of-multiple-hosts.adoc +++ b/guides/common/modules/proc_editing-the-system-purpose-of-multiple-hosts.adoc @@ -4,7 +4,8 @@ = Editing the system purpose of multiple hosts [role="_abstract"] -You can edit the system purpose attributes of {RHEL} hosts. +You can edit the system purpose attributes of multiple {RHEL} hosts at once from the {ProjectWebUI}. +Setting system purpose defines the intended use of the systems on your network and improves reporting accuracy in the Subscriptions service of the Red Hat Hybrid Cloud Console. .Prerequisites * The hosts that you want to edit must be registered with the subscription-manager. diff --git a/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc b/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc index 8e17ea8f596..9435f67bb0a 100644 --- a/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc +++ b/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc @@ -4,7 +4,8 @@ = Enabling and disabling repositories on hosts [role="_abstract"] -Use this procedure to enable and disable repositories on hosts. +You can enable or disable repositories on a host from the {ProjectWebUI} to control which package sources the host can use. +This affects which packages are available for installation or upgrade on the host. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*, diff --git a/guides/common/modules/proc_enabling-cockpit-on-server.adoc b/guides/common/modules/proc_enabling-cockpit-on-server.adoc index c86ead01f2c..c56438a8b4f 100644 --- a/guides/common/modules/proc_enabling-cockpit-on-server.adoc +++ b/guides/common/modules/proc_enabling-cockpit-on-server.adoc @@ -4,8 +4,7 @@ = Enabling {the-Cockpit} on {Project} [role="_abstract"] -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}. +You can enable {the-Cockpit} on {ProjectServer} so that you can access {Cockpit} features for your hosts from within the {ProjectWebUI}. .Procedure * Enable {the-Cockpit} on your {ProjectServer}: diff --git a/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc b/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc index 359f30b5207..8f79c40e2c5 100644 --- a/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc +++ b/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc @@ -4,7 +4,8 @@ = Enabling custom repositories on hosts [role="_abstract"] -You can enable all custom repositories on hosts. +You can enable custom repositories on a host from the {ProjectWebUI}. +This allows the host to install packages or consume other content from repositories you have added to {Project}. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts* and select a host. diff --git a/guides/common/modules/proc_enabling-recommendations.adoc b/guides/common/modules/proc_enabling-recommendations-in-project.adoc similarity index 92% rename from guides/common/modules/proc_enabling-recommendations.adoc rename to guides/common/modules/proc_enabling-recommendations-in-project.adoc index ef2cf6f7564..083ebb169bf 100644 --- a/guides/common/modules/proc_enabling-recommendations.adoc +++ b/guides/common/modules/proc_enabling-recommendations-in-project.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: PROCEDURE -[id="enabling-recommendations"] -= Enabling recommendations +[id="enabling-recommendations-in-{project-context}"] += Enabling recommendations in {Project} [role="_abstract"] If you have previously disabled recommendations, you can re-enable them per organization or per host. diff --git a/guides/common/modules/proc_examining-recommendations-for-hosts.adoc b/guides/common/modules/proc_examining-recommendations-for-hosts.adoc index 19c1bf10018..bac9cff01ed 100644 --- a/guides/common/modules/proc_examining-recommendations-for-hosts.adoc +++ b/guides/common/modules/proc_examining-recommendations-for-hosts.adoc @@ -4,7 +4,8 @@ = Examining recommendations for hosts [role="_abstract"] -You can view the recommendations for RHEL hosts in the {ProjectWebUI}. +You can view {Insights} recommendations for {RHEL} hosts in the {ProjectWebUI}. +Use the list to identify configuration issues and prioritize which issues to remediate. ifdef::insights-in-project[] .Prerequisites diff --git a/guides/common/modules/proc_filter-errata-by-type-severity.adoc b/guides/common/modules/proc_filter-errata-by-type-severity.adoc index 60daef7fb5e..0e853a547fc 100644 --- a/guides/common/modules/proc_filter-errata-by-type-severity.adoc +++ b/guides/common/modules/proc_filter-errata-by-type-severity.adoc @@ -4,7 +4,7 @@ = Filter errata by type and severity [role="_abstract"] -Use the following procedure to filter errata by type or severity. +You can filter errata by type or severity to focus on security updates, bug fixes, or enhancements when planning or applying errata. .Procedure . In the {ProjectWebUI}, navigate to *Hosts > All Hosts* and click the name of the host. diff --git a/guides/common/modules/proc_generating-a-report-for-installable-and-applicable-errata.adoc b/guides/common/modules/proc_generating-a-report-for-installable-and-applicable-errata.adoc index bb0630e8729..7ce186e4298 100644 --- a/guides/common/modules/proc_generating-a-report-for-installable-and-applicable-errata.adoc +++ b/guides/common/modules/proc_generating-a-report-for-installable-and-applicable-errata.adoc @@ -4,7 +4,7 @@ = Generating a report for installable and applicable errata [role="_abstract"] -Use the following procedure to generate a report of installable or applicable errata on hosts. +You can generate a report of installable or applicable errata on hosts to review update status across your environment before applying errata. .Procedure . In the {ProjectWebUI}, navigate to *Monitor* > *Reports* > *Report Templates*. diff --git a/guides/common/modules/proc_generating-host-monitoring-reports-by-using-cli.adoc b/guides/common/modules/proc_generating-host-monitoring-reports-by-using-cli.adoc index 427f0904e05..51111984c13 100644 --- a/guides/common/modules/proc_generating-host-monitoring-reports-by-using-cli.adoc +++ b/guides/common/modules/proc_generating-host-monitoring-reports-by-using-cli.adoc @@ -4,7 +4,7 @@ = Generating host monitoring reports by using Hammer CLI [role="_abstract"] -To view the report templates, use the `hammer report-template` command. +You can generate host monitoring reports by using Hammer CLI so that you can view host data, such as installed packages or compliance status, in a report template. To schedule reports, configure a cron job. .Procedure diff --git a/guides/common/modules/proc_generating-host-monitoring-reports-by-using-web-ui.adoc b/guides/common/modules/proc_generating-host-monitoring-reports-by-using-web-ui.adoc index 6002496a0bf..285a756df5f 100644 --- a/guides/common/modules/proc_generating-host-monitoring-reports-by-using-web-ui.adoc +++ b/guides/common/modules/proc_generating-host-monitoring-reports-by-using-web-ui.adoc @@ -4,8 +4,8 @@ = Generating host monitoring reports by using {ProjectWebUI} [role="_abstract"] -To view the report templates in the {ProjectWebUI}, navigate to *Monitor* > *Reports* > *Report Templates*. -You can also schedule reports from the {ProjectWebUI}. +You can generate host monitoring reports from the {ProjectWebUI} so that you can view host data, such as installed packages or compliance status, in a report template. +You can also schedule reports or send them by e-mail. .Procedure . In the {ProjectWebUI}, navigate to *Monitor* > *Reports* > *Report Templates*. diff --git a/guides/common/modules/proc_importing-all-available-ansible-playbooks.adoc b/guides/common/modules/proc_importing-all-available-ansible-playbooks.adoc index 849811ad9f8..736008e9917 100644 --- a/guides/common/modules/proc_importing-all-available-ansible-playbooks.adoc +++ b/guides/common/modules/proc_importing-all-available-ansible-playbooks.adoc @@ -4,7 +4,7 @@ = Importing all available Ansible Playbooks [role="_abstract"] -You can import all the available Ansible Playbooks to {Project} from collections installed on {SmartProxy}. +When Ansible collections on your {SmartProxy} hold playbooks you want to run from {Project}, you can import all available Ansible Playbooks to {Project} in one step. When you import an Ansible Playbook, {Project} creates job templates from the imported playbooks and places the templates in the `Ansible Playbook - Imported` job category. If you have a custom collection, place it in `/etc/ansible/collections/ansible_collections/_My_Namespace_/_My_Collection_`. diff --git a/guides/common/modules/proc_importing-an-ansible-playbook-by-name.adoc b/guides/common/modules/proc_importing-an-ansible-playbook-by-name.adoc index 437a84e3c99..d66ab82ab2c 100644 --- a/guides/common/modules/proc_importing-an-ansible-playbook-by-name.adoc +++ b/guides/common/modules/proc_importing-an-ansible-playbook-by-name.adoc @@ -5,6 +5,7 @@ [role="_abstract"] You can import Ansible Playbooks by name to {Project} from collections installed on {SmartProxy}. +{Project} creates a job template from each playbook so you can run it on hosts via remote execution without writing the template manually. When you import an Ansible Playbook, {Project} creates a job template from the imported playbook and places the template in the `Ansible Playbook - Imported` job category. If you have a custom collection, place it in `/etc/ansible/collections/ansible_collections/_My_Namespace_/_My_Collection_`. diff --git a/guides/common/modules/proc_installing-packages-on-a-host.adoc b/guides/common/modules/proc_installing-packages-on-a-host.adoc index cec0827cd95..ae080e8702d 100644 --- a/guides/common/modules/proc_installing-packages-on-a-host.adoc +++ b/guides/common/modules/proc_installing-packages-on-a-host.adoc @@ -4,8 +4,8 @@ = Installing packages on a host [role="_abstract"] -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. +You can review and install packages on a host from the {ProjectWebUI} so that the host has the software it needs. +Available packages depend on the content view environments assigned to the host. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_adding-packages-to-a-host-collection.adoc b/guides/common/modules/proc_installing-packages-on-hosts-in-a-host-collection.adoc similarity index 78% rename from guides/common/modules/proc_adding-packages-to-a-host-collection.adoc rename to guides/common/modules/proc_installing-packages-on-hosts-in-a-host-collection.adoc index f8bcf478377..fbce0458c21 100644 --- a/guides/common/modules/proc_adding-packages-to-a-host-collection.adoc +++ b/guides/common/modules/proc_installing-packages-on-hosts-in-a-host-collection.adoc @@ -1,18 +1,18 @@ :_mod-docs-content-type: PROCEDURE -[id="Adding_Packages_to_a_Host_Collection_{context}"] -= Adding packages to a host collection +[id="installing-packages-on-hosts-in-a-host-collection"] += Installing packages on hosts in a host collection [role="_abstract"] -The following procedure shows how to add packages to host collections. +You can install packages on all hosts in a host collection in one action. .Prerequisites -* The content to be added should be available in one of the existing repositories or added prior to this procedure. +* The packages or package groups you want to install should be available in one of the existing repositories or added before this procedure. * Content should be promoted to the environment where the hosts are assigned. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*. -. Select the host collection where the package should be added. +. Select the host collection on which you want to install the package. . On the *Collection Actions* tab, click *Package Installation, Removal, and Update*. . To update all packages, click *Update All Packages* to use the default method. Alternatively, select the drop-down icon to the right of the button to select a method to use. diff --git a/guides/common/modules/proc_installing-the-kernelcare-package-on-hosts.adoc b/guides/common/modules/proc_installing-the-kernelcare-package-on-hosts.adoc index 3d3a659cf2b..f79d8980399 100644 --- a/guides/common/modules/proc_installing-the-kernelcare-package-on-hosts.adoc +++ b/guides/common/modules/proc_installing-the-kernelcare-package-on-hosts.adoc @@ -8,7 +8,7 @@ You can use `kernelcare` to patch the Linux kernel on hosts without rebooting th .Prerequisites * Your hosts have access to the KernelCare repository. -For more information, see xref:KernelCare_Client_{context}[]. +For more information, see xref:kernelcare-client-overview[]. .Procedure . In the {ProjectWebUI}, navigate to *Monitor* > *Jobs* and click *Run job*. diff --git a/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc b/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc index 511afdf0ded..2b6e25b4ed5 100644 --- a/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc +++ b/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc @@ -4,7 +4,8 @@ = Managing and monitoring hosts using {the-Cockpit} [role="_abstract"] -You can access the {Cockpit} UI through the {ProjectWebUI} and use the functionality to manage and monitor hosts in {Project}. +You can access the {Cockpit} UI through the {ProjectWebUI} to manage and monitor {EL} hosts. +Use it to view dashboards, run commands, or use integrated features such as {LoraxCompose}. .Prerequisites * You have enabled {the-Cockpit} in {Project}. diff --git a/guides/common/modules/proc_managing-packages-on-a-host-by-using-api.adoc b/guides/common/modules/proc_managing-packages-on-a-host-by-using-api.adoc index d78d8e03a9e..96005b7c6f8 100644 --- a/guides/common/modules/proc_managing-packages-on-a-host-by-using-api.adoc +++ b/guides/common/modules/proc_managing-packages-on-a-host-by-using-api.adoc @@ -4,7 +4,7 @@ = Managing packages on a host by using API [role="_abstract"] -You can install, upgrade, or remove packages on a host by using {Project} API. +You can install, upgrade, or remove packages on a host by using the {Project} API for automation, scripts, or integration with other tools. The example below uses the `katello_package_install` action to install a package. You can also use package actions `katello_package_upgrade` to upgrade or `katello_package_remove` to remove packages. diff --git a/guides/common/modules/proc_migrating-a-host-from-red-hat-network.adoc b/guides/common/modules/proc_migrating-a-host-from-red-hat-network.adoc index e6188365066..ea640a97bbd 100644 --- a/guides/common/modules/proc_migrating-a-host-from-red-hat-network.adoc +++ b/guides/common/modules/proc_migrating-a-host-from-red-hat-network.adoc @@ -4,6 +4,8 @@ = Migrating a host from Red Hat Network (RHN) or Satellite 5 to {Project} [role="_abstract"] +You can migrate a host from Red Hat Network (RHN) or Satellite 5 to {Project} by using the bootstrap script. + The bootstrap script detects the presence of `/etc/syconfig/rhn/systemid` and a valid connection to RHN as an indicator that the system is registered to a legacy platform. The script then calls `rhn-classic-migrate-to-rhsm` to migrate the system from RHN. By default, the script does not delete the system's legacy profile due to auditing reasons. diff --git a/guides/common/modules/proc_parsing-arrays.adoc b/guides/common/modules/proc_parsing-arrays-in-templates.adoc similarity index 91% rename from guides/common/modules/proc_parsing-arrays.adoc rename to guides/common/modules/proc_parsing-arrays-in-templates.adoc index d2c3f6ee4a3..f8ab7ac01f4 100644 --- a/guides/common/modules/proc_parsing-arrays.adoc +++ b/guides/common/modules/proc_parsing-arrays-in-templates.adoc @@ -1,12 +1,11 @@ :_mod-docs-content-type: PROCEDURE -[id="Parsing_Arrays_{context}"] -= Parsing arrays +[id="parsing-arrays-in-templates"] += Parsing arrays in templates [role="_abstract"] While writing or modifying templates, you might encounter variables that return arrays. -For example, host variables related to network interfaces, such as `@host.interfaces` or `@host.bond_interfaces`, return interface data grouped in an array. -To extract a parameter value of a specific interface, use Ruby methods to parse the array. +Use Ruby methods to parse arrays so that you can extract parameter values from specific entries, such as interface data from `@host.interfaces`. The following procedure is an example that you can use to find the relevant methods to parse arrays in your template. In this example, a report template is used, but the steps are applicable to other templates. diff --git a/guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc b/guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc index ff7af3c8ec7..feb952ea81d 100644 --- a/guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc +++ b/guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc @@ -4,7 +4,7 @@ = Providing an alternative FQDN for the host [role="_abstract"] -If the host's host name is not an FQDN, or is not RFC-compliant (containing a character such as an underscore), the script will fail at the host name validation stage. +If the host name of the host is not an FQDN, or is not RFC-compliant (containing a character such as an underscore), the script will fail at the host name validation stage. If you cannot update the host to use an FQDN that is accepted by {Project}, you can use the bootstrap script to specify an alternative FQDN. .Procedure diff --git a/guides/common/modules/proc_removing-a-host-collection.adoc b/guides/common/modules/proc_removing-a-host-collection.adoc index b635c169a43..71fb48bfa9f 100644 --- a/guides/common/modules/proc_removing-a-host-collection.adoc +++ b/guides/common/modules/proc_removing-a-host-collection.adoc @@ -4,7 +4,8 @@ = Removing a host collection [role="_abstract"] -Use the following procedure to remove a host collection from {Project}. +You can remove a host collection from {Project} when you no longer need that grouping. +The hosts in the collection are not deleted. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*. diff --git a/guides/common/modules/proc_removing-a-host-from-a-host-collection.adoc b/guides/common/modules/proc_removing-a-host-from-a-host-collection.adoc index dda18727b87..b605e0dd753 100644 --- a/guides/common/modules/proc_removing-a-host-from-a-host-collection.adoc +++ b/guides/common/modules/proc_removing-a-host-from-a-host-collection.adoc @@ -4,7 +4,7 @@ = Removing a host from a host collection [role="_abstract"] -The following procedure shows how to remove hosts from host collections. +Remove hosts from a host collection to update membership without deleting the host from {Project}. Note that if you remove a host from a host collection, the host collection record in the database is not modified so the {Project} auditing system does not log the change. diff --git a/guides/common/modules/proc_removing-a-host-from-server-by-using-cli.adoc b/guides/common/modules/proc_removing-a-host-from-server-by-using-cli.adoc index 66958b4e6cf..314eb39514e 100644 --- a/guides/common/modules/proc_removing-a-host-from-server-by-using-cli.adoc +++ b/guides/common/modules/proc_removing-a-host-from-server-by-using-cli.adoc @@ -4,7 +4,8 @@ = Removing a host from {Project} by using Hammer CLI [role="_abstract"] -Use this procedure to remove a host from {Project} by using Hammer CLI. +You can remove a host from {Project} by using Hammer CLI when you decommission the host or no longer need to manage it. +The host is permanently deleted from the {Project} database. include::snip_warning-destroy-vm-on-host-delete.adoc[] diff --git a/guides/common/modules/proc_removing-a-host-from-server-by-using-web-ui.adoc b/guides/common/modules/proc_removing-a-host-from-server-by-using-web-ui.adoc index 182df0a5d5f..03786b3d688 100644 --- a/guides/common/modules/proc_removing-a-host-from-server-by-using-web-ui.adoc +++ b/guides/common/modules/proc_removing-a-host-from-server-by-using-web-ui.adoc @@ -4,7 +4,8 @@ = Removing a host from {Project} by using {ProjectWebUI} [role="_abstract"] -Use this procedure to remove a host from {Project} from the {ProjectWebUI}. +You can remove a host from {Project} from the {ProjectWebUI} when you decommission the host or no longer need to manage it. +The host is permanently deleted from the {Project} database. include::snip_warning-destroy-vm-on-host-delete.adoc[] diff --git a/guides/common/modules/proc_removing-a-package-from-a-host.adoc b/guides/common/modules/proc_removing-a-package-from-a-host.adoc index 9ba1a6da8ae..5cc5f42694f 100644 --- a/guides/common/modules/proc_removing-a-package-from-a-host.adoc +++ b/guides/common/modules/proc_removing-a-package-from-a-host.adoc @@ -4,7 +4,7 @@ = Removing a package from a host [role="_abstract"] -Use the following procedure to remove an installed package from a host. +To uninstall software or resolve dependency issues, you can remove a package from a host. .Procedure . In the {ProjectWebUI}, navigate to *Hosts > All Hosts* and select the host containing the package you want to remove. diff --git a/guides/common/modules/proc_removing-content-from-a-host-collection.adoc b/guides/common/modules/proc_removing-content-from-hosts-in-a-host-collection.adoc similarity index 75% rename from guides/common/modules/proc_removing-content-from-a-host-collection.adoc rename to guides/common/modules/proc_removing-content-from-hosts-in-a-host-collection.adoc index b2218d632c9..75878d586d1 100644 --- a/guides/common/modules/proc_removing-content-from-a-host-collection.adoc +++ b/guides/common/modules/proc_removing-content-from-hosts-in-a-host-collection.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: PROCEDURE -[id="Removing_Content_From_a_Host_Collection_{context}"] -= Removing content from a host collection +[id="removing-content-from-hosts-in-a-host-collection"] += Removing content from hosts in a host collection [role="_abstract"] -The following procedure shows how to remove packages from host collections. +Remove packages or package groups from hosts in a host collection to keep collection content in sync with your requirements. .Procedure . Click *Hosts* > *Host Collections*. diff --git a/guides/common/modules/proc_removing-packages-from-a-host.adoc b/guides/common/modules/proc_removing-packages-from-a-host.adoc index ad2e55367c4..86f479ac24b 100644 --- a/guides/common/modules/proc_removing-packages-from-a-host.adoc +++ b/guides/common/modules/proc_removing-packages-from-a-host.adoc @@ -4,7 +4,7 @@ = Removing packages from a host [role="_abstract"] -You can remove packages from a host in the {ProjectWebUI}. +You can remove packages from a host from the {ProjectWebUI} to uninstall software or resolve dependency conflicts. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_restarting-applications-on-a-host.adoc b/guides/common/modules/proc_restarting-applications-on-a-host.adoc index 0423bfdd920..42747c3204e 100644 --- a/guides/common/modules/proc_restarting-applications-on-a-host.adoc +++ b/guides/common/modules/proc_restarting-applications-on-a-host.adoc @@ -4,11 +4,12 @@ = Restarting applications on a host [role="_abstract"] -Use this procedure to restart applications from the {ProjectWebUI}. +You can restart applications on a host from the {ProjectWebUI} when the host reports pending restarts, for example after package updates. +{Project} uses remote execution to restart applications on the host. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. -. Click the name of the hosts you want to modify. +. Click the name of the host you want to modify. . Select the *Traces* tab. . Select applications that you want to restart. . Select *Restart via remote execution* from the *Restart app* list. 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 index aa4625b53ce..4ea029c6317 100644 --- 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 @@ -4,7 +4,8 @@ = Scheduling a recurring Ansible job for a host group [role="_abstract"] -You can schedule a recurring job to run Ansible roles on host groups. +You can schedule a recurring Ansible job to run on a host group at a set interval. +This is useful for regular tasks such as compliance checks, patching, or configuration drift remediation across all hosts that are assigned to this host group. .Prerequisites * Ensure that you have assigned at least one Ansible role to your host group. 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 index 1af84643785..0657a876c91 100644 --- 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 @@ -4,7 +4,8 @@ = Scheduling a recurring Ansible job for a host [role="_abstract"] -You can schedule a recurring job to run Ansible roles on hosts. +You can schedule a recurring Ansible job to run on a host at a set interval. +This is useful for regular tasks such as compliance checks, patching, or configuration drift remediation. .Prerequisites * Ensure you have the `view_foreman_tasks`, `view_job_invocations`, and `view_recurring_logics` permissions. diff --git a/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-pull-mode.adoc b/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-pull-mode.adoc index 448f47701a8..1f146cffcbd 100644 --- a/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-pull-mode.adoc +++ b/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-pull-mode.adoc @@ -5,9 +5,10 @@ [role="_abstract"] By default, {Project} uses the `/run` directory on hosts for remote execution jobs in pull mode. -If the `/run` directory on your host is mounted with the `noexec` flag, {Project} cannot execute remote execution job scripts in this directory. You can use the Yggdrasil service to set an alternative directory for executing remote execution jobs in pull mode. +If the `/run/` directory on your host is mounted with the `noexec` flag, {Project} cannot execute remote execution job scripts in this directory. + .Prerequisite * Determine which version of the `yggdrasil` package is installed on the host: ifdef::satellite[] diff --git a/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-push-mode.adoc b/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-push-mode.adoc index 5bf1f065c6e..1a3ba29cde3 100644 --- a/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-push-mode.adoc +++ b/guides/common/modules/proc_setting-an-alternative-directory-for-remote-execution-jobs-in-push-mode.adoc @@ -6,9 +6,10 @@ ifeval::["{context}" == "managing-hosts"] [role="_abstract"] By default, {Project} uses the `/var/tmp` directory on hosts for remote execution jobs in push mode. -If the `/var/tmp` directory on your host is mounted with the `noexec` flag, {Project} cannot execute remote execution job scripts in this directory. You can use `{foreman-installer}` to set an alternative directory for executing remote execution jobs in push mode. +If the `/var/tmp/` directory on your host is mounted with the `noexec` flag, {Project} cannot execute remote execution job scripts in this directory. + :rex-default-working-dir: /var/tmp :installer-change-working-dir-opt: --foreman-proxy-plugin-remote-execution-script-remote-working-dir :rex-target-machine: host diff --git a/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-cli.adoc b/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-cli.adoc index ab38436e4d2..e5279ca32b5 100644 --- a/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-cli.adoc +++ b/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-cli.adoc @@ -4,7 +4,8 @@ = Setting permissions for the bootstrap script by using Hammer CLI [role="_abstract"] -Use this procedure to configure a {Project} user with the permissions required to run the bootstrap script by using Hammer CLI. +You can configure a {Project} user with the permissions required to run the bootstrap script by using Hammer CLI. +This allows the user to register hosts with the script without granting full administrative access. .Procedure . Create a role with the minimum permissions required by the bootstrap script. diff --git a/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-web-ui.adoc b/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-web-ui.adoc index 4c65a26878d..bdf938b19be 100644 --- a/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-web-ui.adoc +++ b/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script-by-using-web-ui.adoc @@ -4,7 +4,8 @@ = Setting permissions for the bootstrap script by using {ProjectWebUI} [role="_abstract"] -Use this procedure to configure a {Project} user with the permissions required to run the bootstrap script from the {ProjectWebUI}. +You can configure a {Project} user with the permissions required to run the bootstrap script from the {ProjectWebUI}. +This allows the user to register hosts with the script without granting full administrative access. .Procedure . In the {ProjectWebUI}, navigate to *Administer* > *Users*. diff --git a/guides/common/modules/proc_upgrading-a-package.adoc b/guides/common/modules/proc_upgrading-a-package.adoc index 8b60af5b91a..f8aaead3cf4 100644 --- a/guides/common/modules/proc_upgrading-a-package.adoc +++ b/guides/common/modules/proc_upgrading-a-package.adoc @@ -4,7 +4,7 @@ = Upgrading a package [role="_abstract"] -Use the following procedure to view the installed packages of a host. +You can upgrade an installed package on a host to a newer version from the {ProjectWebUI} to get bug fixes or new features. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts* and select the name of the host that contains the package you want to upgrade. 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 index 411bc4707be..37f03789710 100644 --- a/guides/common/modules/proc_upgrading-hosts-to-next-major-release.adoc +++ b/guides/common/modules/proc_upgrading-hosts-to-next-major-release.adoc @@ -5,8 +5,9 @@ [role="_abstract"] You can use a job template to upgrade your {EL} hosts to the next major release. +This helps you keep hosts on a supported release and can be run across multiple hosts by using remote execution. -Below upgrade paths are possible: +{Team} supports the following upgrade paths: * {EL} 7 to {EL} 8 * {EL} 8 to {EL} 9 diff --git a/guides/common/modules/proc_upgrading-packages-on-a-host.adoc b/guides/common/modules/proc_upgrading-packages-on-a-host.adoc index ab53e7a4455..fc3e0f04022 100644 --- a/guides/common/modules/proc_upgrading-packages-on-a-host.adoc +++ b/guides/common/modules/proc_upgrading-packages-on-a-host.adoc @@ -4,7 +4,7 @@ = Upgrading packages on a host [role="_abstract"] -You can upgrade packages on a host in bulk in the {ProjectWebUI}. +You can upgrade packages on a host in bulk from the {ProjectWebUI}. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_using-the-api-to-obtain-ssh-keys-for-remote-execution.adoc b/guides/common/modules/proc_using-the-api-to-obtain-ssh-keys-for-remote-execution.adoc index 1e615efb57d..ea116abd87b 100644 --- a/guides/common/modules/proc_using-the-api-to-obtain-ssh-keys-for-remote-execution.adoc +++ b/guides/common/modules/proc_using-the-api-to-obtain-ssh-keys-for-remote-execution.adoc @@ -4,7 +4,10 @@ = Using the {Project} API to obtain SSH keys for remote execution [role="_abstract"] -To use the {Project} API to download the public key from {SmartProxy}, complete this procedure on each target host. +You can obtain the {Project} SSH key from {SmartProxy} and add it to the `authorized_keys` on the host so that remote execution jobs can run on the host using SSH. +Use this when you cannot use the standard distribution method, for example in automated or scripted setups. + +Perform these steps on each target host where you want to run remote execution jobs. .Procedure . On the target host, create the `~/.ssh` directory to store the SSH key: diff --git a/guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc b/guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc index 6f9222280ec..308152cfbe5 100644 --- a/guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc +++ b/guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc @@ -4,7 +4,7 @@ = Viewing errata by applicable and installable [role="_abstract"] -Use the following procedure to view errata by applicable or installable. +You can view errata by applicable or installable status to see which updates affect your hosts and which are ready to install. .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. diff --git a/guides/common/modules/proc_viewing-installed-packages.adoc b/guides/common/modules/proc_viewing-installed-packages.adoc index 397f267706a..616462465c6 100644 --- a/guides/common/modules/proc_viewing-installed-packages.adoc +++ b/guides/common/modules/proc_viewing-installed-packages.adoc @@ -4,7 +4,7 @@ = Viewing installed packages [role="_abstract"] -Use the following procedure to view the installed packages of a host. +You can view the installed packages on a host to see what is present or to plan package or errata actions. .Procedure . In the {ProjectWebUI}, navigate to *Hosts > All Hosts* and select the name of the host. diff --git a/guides/common/modules/ref_advanced-bootstrap-script-configuration.adoc b/guides/common/modules/ref_advanced-bootstrap-script-configuration.adoc index 8d1c6fe0bf2..6e9ad58ad53 100644 --- a/guides/common/modules/ref_advanced-bootstrap-script-configuration.adoc +++ b/guides/common/modules/ref_advanced-bootstrap-script-configuration.adoc @@ -4,7 +4,7 @@ = Advanced bootstrap script configuration [role="_abstract"] -This section has more examples for using the bootstrap script to register or migrate a host. +Use these advanced bootstrap script examples to register or migrate hosts with custom options and minimum required permissions. [WARNING] ==== diff --git a/guides/common/modules/ref_ansible-variables-for-conversion.adoc b/guides/common/modules/ref_ansible-variables-for-conversion.adoc index 8a82ee13d20..f73e373e458 100644 --- a/guides/common/modules/ref_ansible-variables-for-conversion.adoc +++ b/guides/common/modules/ref_ansible-variables-for-conversion.adoc @@ -4,7 +4,8 @@ = Ansible variables for conversion [role="_abstract"] -Before you run the Ansible role to generate conversion data, configure values of the following required Ansible variables. +Configure the required Ansible variables for the Convert2RHEL role before you run it to generate conversion data on {ProjectServer}. +This reference lists the variables and their intended values. {Project} imports most of the required Ansible variables from the `{ansible-namespace}.convert2rhel` role. However, some variables are not imported. diff --git a/guides/common/modules/ref_conditional-statements.adoc b/guides/common/modules/ref_conditional-statements-in-erb.adoc similarity index 91% rename from guides/common/modules/ref_conditional-statements.adoc rename to guides/common/modules/ref_conditional-statements-in-erb.adoc index 0ad66e710f2..aa0dc8b3b8c 100644 --- a/guides/common/modules/ref_conditional-statements.adoc +++ b/guides/common/modules/ref_conditional-statements-in-erb.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: REFERENCE -[id="Conditional_Statements_{context}"] -= Conditional statements +[id="conditional-statements-in-erb"] += Conditional statements in ERB [role="_abstract"] In your templates, you might perform different actions depending on which value exists. diff --git a/guides/common/modules/ref_generic-project-specific-macros.adoc b/guides/common/modules/ref_generic-project-specific-macros.adoc index 84fc68f6203..be474d68a87 100644 --- a/guides/common/modules/ref_generic-project-specific-macros.adoc +++ b/guides/common/modules/ref_generic-project-specific-macros.adoc @@ -4,8 +4,7 @@ = Generic {Project}-specific macros [role="_abstract"] -This section lists {Project}-specific macros for ERB templates. -You can use the macros listed in the following table across all kinds of templates. +You can use {Project}-specific macros in your ERB templates to generate URLs, indent code, and reuse common patterns across templates. .Generic macros [options="header"] diff --git a/guides/common/modules/ref_registration-methods.adoc b/guides/common/modules/ref_host-registration-methods.adoc similarity index 82% rename from guides/common/modules/ref_registration-methods.adoc rename to guides/common/modules/ref_host-registration-methods.adoc index 26f82572aa1..076b1639899 100644 --- a/guides/common/modules/ref_registration-methods.adoc +++ b/guides/common/modules/ref_host-registration-methods.adoc @@ -1,17 +1,16 @@ :_mod-docs-content-type: REFERENCE -[id="registration-methods_{context}"] -= Registration methods +[id="host-registration-methods"] += Host registration methods [role="_abstract"] -You can use the following ifdef::orcharhino[] -method +You can register hosts to {Project} using global registration. endif::[] ifndef::orcharhino[] -methods +You can register hosts to {Project} using different methods. +Choose the method that fits your environment, for example global registration for most hosts or the bootstrap script for legacy workflows. endif::[] -to register hosts to {Project}: Global registration:: You generate a registration command from {Project} and run this command on an unlimited number of hosts to register them by using provisioning templates over the {Project} API. diff --git a/guides/common/modules/ref_host-specific-variables.adoc b/guides/common/modules/ref_host-specific-variables-in-templates.adoc similarity index 93% rename from guides/common/modules/ref_host-specific-variables.adoc rename to guides/common/modules/ref_host-specific-variables-in-templates.adoc index c7eb4a797a9..e3a18a43576 100644 --- a/guides/common/modules/ref_host-specific-variables.adoc +++ b/guides/common/modules/ref_host-specific-variables-in-templates.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: REFERENCE -[id="Host_Specific_Variables_{context}"] -= Host-specific variables +[id="host-specific-variables-in-templates"] += Host-specific variables in templates [role="_abstract"] -The following variables enable using host data within templates. +You can use host-specific variables in templates to access host data such as architecture and operating system. Note that job templates accept only `@host` variables. @@ -14,7 +14,7 @@ Note that job templates accept only `@host` variables. |Name |Description |`@host.architecture` |The architecture of the host. |`@host.bond_interfaces` |Returns an array of all bonded interfaces. -See xref:Parsing_Arrays_{context}[]. +See xref:parsing-arrays-in-templates[]. |`@host.capabilities` |The method of system provisioning, can be either build (for example Kickstart) or image. |`@host.certname` |The SSL certificate name of the host. |`@host.diskLayout` |The disk layout of the host. @@ -29,15 +29,15 @@ For example to access the 'ipaddress' fact from the output, specify @host.facts[ For example, use host_enc['parameters']['lifecycle_environment'] to get the lifecycle environment of a host. |`@host.image_build?` |Returns `true` if the host is provisioned using an image. |`@host.interfaces` |Contains an array of all available host interfaces including the primary interface. -See xref:Parsing_Arrays_{context}[]. +See xref:parsing-arrays-in-templates[]. |`@host.interfaces_with_identifier('IDs')` |Returns array of interfaces with given identifier. You can pass an array of multiple identifiers as an input, for example @host.interfaces_with_identifier(['eth0', 'eth1']). -See xref:Parsing_Arrays_{context}[]. +See xref:parsing-arrays-in-templates[]. |`@host.ip` |The IP address of the host. |`@host.location` |The location of the host. |`@host.mac` |The MAC address of the host. |`@host.managed_interfaces` |Returns an array of managed interfaces (excluding BMC and bonded interfaces). -See xref:Parsing_Arrays_{context}[]. +See xref:parsing-arrays-in-templates[]. |`@host.medium` |The assigned operating system installation medium. |`@host.name` |The full name of the host. |`@host.operatingsystem.family` |The operating system family. diff --git a/guides/common/modules/ref_kickstart-specific-variables.adoc b/guides/common/modules/ref_kickstart-specific-variables.adoc index 9606555f1fb..84028c8448b 100644 --- a/guides/common/modules/ref_kickstart-specific-variables.adoc +++ b/guides/common/modules/ref_kickstart-specific-variables.adoc @@ -4,7 +4,7 @@ = Kickstart-specific variables [role="_abstract"] -The following variables are designed to be used within Kickstart provisioning templates. +You can use Kickstart-specific variables in provisioning templates to inject host data and installation options. .Kickstart-specific variables [options="header"] diff --git a/guides/common/modules/ref_template-macros.adoc b/guides/common/modules/ref_template-macros-reference.adoc similarity index 85% rename from guides/common/modules/ref_template-macros.adoc rename to guides/common/modules/ref_template-macros-reference.adoc index 7008bcb29ff..44350dc4242 100644 --- a/guides/common/modules/ref_template-macros.adoc +++ b/guides/common/modules/ref_template-macros-reference.adoc @@ -1,17 +1,18 @@ :_mod-docs-content-type: REFERENCE -[id="Template_Macros_{context}"] -= Template macros +[id="template-macros-reference"] += Template macros reference [role="_abstract"] -If you want to write custom templates, you can use some of the following macros. -For more information about the available macros for report templates, in the {ProjectWebUI}, navigate to *Monitor* > *Reports* > *Report Templates*, and click *Create Template*. -In the Create Template window, click the *Help* tab. +You can use macros in ERB templates to add user inputs, load host data, and perform other tasks when writing provisioning, job, or report templates. +Availability and options vary by template type. -For more information about the available macros for job templates, in the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Job templates*, and click the *New Job Template*. -In the New Job Template window, click the *Help* tab. +For more information about the macros available for each template type, navigate to the following pages in the {ProjectWebUI}: -Depending on the template type, some of the following macros have different requirements. +* *Monitor* > *Reports* > *Report Templates* > *Create Template* for report templates +* *Hosts* > *Templates* > *Job templates* > *New Job Template* for job templates + +Click the *Help* tab on these pages for more details. input:: Using the `input` macro, you can customize the input data that the template can work with.