From 37f3007ea4f30a0b5db7abdfda7a3532aa151a9b Mon Sep 17 00:00:00 2001 From: Avital Pinnick Date: Sun, 5 Jan 2025 14:45:03 +0200 Subject: [PATCH] peer review changes --- .../assembly_managing-virt-who-configurations.adoc | 1 - .../con_managing-virt-who-configurations.adoc | 1 + ..._provisioning-virtual-machines-on-kubevirt.adoc | 10 ++-------- .../modules/con_troubleshooting-virt-who.adoc | 2 +- ...con_virtual-machine-subscriptions-overview.adoc | 14 +++----------- ...ng-for-subscriptions-that-require-virt-who.adoc | 1 - .../modules/proc_checking-virt-who-status.adoc | 4 +--- .../proc_editing-a-virt-who-configuration.adoc | 3 --- .../modules/proc_enabling-rhsm-debug-logging.adoc | 7 +++---- .../proc_removing-a-virt-who-configuration.adoc | 1 - ...proc_virt-who-does-not-report-to-satellite.adoc | 2 +- .../ref_virt-who-troubleshooting-scenarios.adoc | 4 +++- guides/common/modules/snip_technology-preview.adoc | 12 ++++++++++++ .../master.adoc | 2 +- 14 files changed, 28 insertions(+), 36 deletions(-) create mode 100644 guides/common/modules/snip_technology-preview.adoc diff --git a/guides/common/assembly_managing-virt-who-configurations.adoc b/guides/common/assembly_managing-virt-who-configurations.adoc index 50af8111ee2..21b92720db4 100644 --- a/guides/common/assembly_managing-virt-who-configurations.adoc +++ b/guides/common/assembly_managing-virt-who-configurations.adoc @@ -19,4 +19,3 @@ include::modules/proc_deploying-a-virt-who-configuration-on-a-separate-rhel-serv include::modules/proc_editing-a-virt-who-configuration.adoc[leveloffset=+1] include::modules/proc_removing-a-virt-who-configuration.adoc[leveloffset=+1] - diff --git a/guides/common/modules/con_managing-virt-who-configurations.adoc b/guides/common/modules/con_managing-virt-who-configurations.adoc index a4bcd2325bf..5a503664842 100644 --- a/guides/common/modules/con_managing-virt-who-configurations.adoc +++ b/guides/common/modules/con_managing-virt-who-configurations.adoc @@ -1,3 +1,4 @@ +[id="managing-virt-who-configurations"] = Managing virt-who configurations You can check for subscriptions that require a virt-who configuration. diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc index 4df4c31c236..3cab223effb 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc @@ -10,14 +10,8 @@ You can create a compute resource for {KubeVirt} so that you can provision and m ifdef::satellite[] Note that template provisioning is not supported for this release. -[IMPORTANT] -==== -The {KubeVirt} compute resource is a Technology Preview feature only. -Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. -Red Hat does not recommend using them in production. -These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. -For more information about the support scope of Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/. -==== +:FeatureName: The {KubeVirt} compute resource +include::snip_technology-preview.adoc[] endif::[] .Prerequisites diff --git a/guides/common/modules/con_troubleshooting-virt-who.adoc b/guides/common/modules/con_troubleshooting-virt-who.adoc index d0403e1c3e2..759407943cd 100644 --- a/guides/common/modules/con_troubleshooting-virt-who.adoc +++ b/guides/common/modules/con_troubleshooting-virt-who.adoc @@ -3,4 +3,4 @@ You can troubleshoot virt-who by checking the service status, logs, and by identifying configuration issues. -For more information, see link:https://docs.redhat.com/en/documentation/subscription_central/1-latest/html/getting_started_with_rhel_system_registration/adv-reg-rhel-config-vm-sub_#virt-who-troubleshooting-methods_[Virt-who troubleshooting methods] and link:https://docs.redhat.com/en/documentation/subscription_central/1-latest/html/getting_started_with_rhel_system_registration/adv-reg-rhel-config-vm-sub_#virt-who-troubleshooting-scenarios_[Virt-who troubleshooting scenarios] in _Getting Started with RHEL System Registration_ in the Subscription Central documentation. \ No newline at end of file +For more information, see link:{RHDocsBaseURL}subscription_central/1-latest/html/getting_started_with_rhel_system_registration/adv-reg-rhel-config-vm-sub_#virt-who-troubleshooting-methods_[Virt-who troubleshooting methods] and link:{RHDocsBaseURL}subscription_central/1-latest/html/getting_started_with_rhel_system_registration/adv-reg-rhel-config-vm-sub_#virt-who-troubleshooting-scenarios_[Virt-who troubleshooting scenarios] in _Getting Started with RHEL System Registration_ in the Subscription Central documentation. \ No newline at end of file diff --git a/guides/common/modules/con_virtual-machine-subscriptions-overview.adoc b/guides/common/modules/con_virtual-machine-subscriptions-overview.adoc index a3a818844c8..89bc8bd06fc 100644 --- a/guides/common/modules/con_virtual-machine-subscriptions-overview.adoc +++ b/guides/common/modules/con_virtual-machine-subscriptions-overview.adoc @@ -17,17 +17,9 @@ You can configure host-based subscriptions for {EL} VMs on the following virtual * Microsoft Hyper-V * Nutanix AHV * {KubeVirt} + ifdef::satellite[] -+ -[IMPORTANT] -==== -The {KubeVirt} hypervisor is a Technology Preview feature only. -Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. -Red Hat does not recommend using them in production. -These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. -For more information about the support scope of Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/. -==== +:FeatureName: The {KubeVirt} hypervisor +include::snip_technology-preview.adoc[] endif::[] - - diff --git a/guides/common/modules/proc_checking-for-subscriptions-that-require-virt-who.adoc b/guides/common/modules/proc_checking-for-subscriptions-that-require-virt-who.adoc index 36e3be0f38d..d0c050cd319 100644 --- a/guides/common/modules/proc_checking-for-subscriptions-that-require-virt-who.adoc +++ b/guides/common/modules/proc_checking-for-subscriptions-that-require-virt-who.adoc @@ -4,7 +4,6 @@ You can check for subscriptions that require virt-who configuration. .Procedure - . In the {ProjectWebUI}, navigate to *Content* > *Subscriptions*. . Check the *Requires Virt-Who* column of the subscriptions list. If a tick is displayed, you must configure virt-who to use that subscription. diff --git a/guides/common/modules/proc_checking-virt-who-status.adoc b/guides/common/modules/proc_checking-virt-who-status.adoc index cf320e89a9a..91f81cf234f 100644 --- a/guides/common/modules/proc_checking-virt-who-status.adoc +++ b/guides/common/modules/proc_checking-virt-who-status.adoc @@ -4,15 +4,13 @@ You can check the status of virt-who by using the {ProjectWebUI} or the Hammer CLI tool. .Procedure - . In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. . Check the *Status* column of each virt-who instance. + The `OK` status indicates that virt-who is successfully connecting to {ProjectServer} and reporting the virtual machines managed by each hypervisor. .CLI procedure - -* To list the status of all virt-who instances by using the CLI, enter the following command on {ProjectServer}: +* List the status of all virt-who instances by entering the following command on {ProjectServer}: + ---- $ hammer virt-who-config list diff --git a/guides/common/modules/proc_editing-a-virt-who-configuration.adoc b/guides/common/modules/proc_editing-a-virt-who-configuration.adoc index 95cb16ee39d..b5379096aba 100644 --- a/guides/common/modules/proc_editing-a-virt-who-configuration.adoc +++ b/guides/common/modules/proc_editing-a-virt-who-configuration.adoc @@ -4,7 +4,6 @@ You can edit a virt-who configuration by using either the {ProjectWebUI} or the Hammer CLI. .Procedure - . In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. . Select *Edit* in the *Actions* column of a virt-who configuration. . Edit the fields and then click *Submit*. @@ -12,7 +11,6 @@ You can edit a virt-who configuration by using either the {ProjectWebUI} or the [id="cli-modifying-virt-who-configuration_{context}"] .CLI procedure - . On {ProjectServer}, use the `hammer virt-who-config update` command to edit the virt-who configuration according to the following example: + [options="nowrap" subs="+quotes,verbatim"] @@ -22,5 +20,4 @@ $ hammer virt-who-config update \ --new-name _My_new_virt-who_Configuration_ \ --interval 1440 ---- - . Deploy the modified virt-who configuration. diff --git a/guides/common/modules/proc_enabling-rhsm-debug-logging.adoc b/guides/common/modules/proc_enabling-rhsm-debug-logging.adoc index e10a7a98707..9753a7ead80 100644 --- a/guides/common/modules/proc_enabling-rhsm-debug-logging.adoc +++ b/guides/common/modules/proc_enabling-rhsm-debug-logging.adoc @@ -1,20 +1,20 @@ -[id="enabling-rhasm-debug logging_{context}"] +[id="enabling-rhsm-debug-logging_{context}"] = Enabling debug logging You can enable debug logging for the `/var/log/rhsm/rhsm.log` file by using the {ProjectWebUI} or the Hammer CLI tool. After you resolve the problem, you must disable debug logging and redeploy the virt-who configuration. +To use the CLI instead of the {ProjectWebUI}, see the xref:cli-enabling-rhsm-debug-logging[]. .Procedure - . In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. . Select *Edit* in the *Actions* column of a virt-who configuration. . Select *Enable debugging output*. . Click *Submit*. . Redeploy the virt-who configuration on the target host. +[id="cli-enabling-rhsm-debug-logging"] .CLI procedure - . On {ProjectServer}, run the `hammer virt-who-config update` command with the debug option: + [options="nowrap" subs="+quotes"] @@ -22,5 +22,4 @@ After you resolve the problem, you must disable debug logging and redeploy the v $ hammer virt-who-config update \ --debug true ---- - . Redeploy the virt-who configuration on the target host. diff --git a/guides/common/modules/proc_removing-a-virt-who-configuration.adoc b/guides/common/modules/proc_removing-a-virt-who-configuration.adoc index e9b248c85d9..09c0909c22c 100644 --- a/guides/common/modules/proc_removing-a-virt-who-configuration.adoc +++ b/guides/common/modules/proc_removing-a-virt-who-configuration.adoc @@ -4,7 +4,6 @@ You can remove a virt-who configuration by deleting the configuration in the {ProjectWebUI} and then by deleting the configuration file from the hypervisor or the virtualization manager. .Procedure - . In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. . Select *Delete* from the *Actions* column of the virt-who configuration. . On the hypervisor or virtualization manager, remove the configuration file by running the following command: diff --git a/guides/common/modules/proc_virt-who-does-not-report-to-satellite.adoc b/guides/common/modules/proc_virt-who-does-not-report-to-satellite.adoc index f8dad803972..7aff4f02661 100644 --- a/guides/common/modules/proc_virt-who-does-not-report-to-satellite.adoc +++ b/guides/common/modules/proc_virt-who-does-not-report-to-satellite.adoc @@ -1,4 +1,4 @@ -[id="virt-who-does-not-report-to-satellite_{context}"] +[id="virt-who-does-not-report-to-{project-context}-server_{context}"] = virt-who does not report to {ProjectServer} virt-who might not report to {ProjectServer} if {ProjectServer} is configured to use a proxy server in `rhsm.conf` while virt-who is configured not to use a proxy server in `/etc/sysconfig/virt-who`. diff --git a/guides/common/modules/ref_virt-who-troubleshooting-scenarios.adoc b/guides/common/modules/ref_virt-who-troubleshooting-scenarios.adoc index 52e27726c40..6a1f7ee7e09 100644 --- a/guides/common/modules/ref_virt-who-troubleshooting-scenarios.adoc +++ b/guides/common/modules/ref_virt-who-troubleshooting-scenarios.adoc @@ -3,7 +3,9 @@ .Virt-who fails to connect to the virtualization platform -If virt-who fails to connect to the hypervisor or virtualization manager, check the Red{nbsp}Hat Subscription{nbsp}Manager log file `/var/log/rhsm/rhsm.log`. If you find the message `No route to host`, the hypervisor might be listening on the wrong port. In this case, modify the virt-who configuration and append the correct port number to the *Hypervisor Server* value. +If virt-who fails to connect to the hypervisor or virtualization manager, check the Red{nbsp}Hat Subscription{nbsp}Manager log file `/var/log/rhsm/rhsm.log`. +If you find the message `No route to host`, the hypervisor might be listening on the wrong port. +In this case, modify the virt-who configuration and append the correct port number to the *Hypervisor Server* value. You must redeploy the virt-who configuration after modifying it. diff --git a/guides/common/modules/snip_technology-preview.adoc b/guides/common/modules/snip_technology-preview.adoc new file mode 100644 index 00000000000..9c1acea0a89 --- /dev/null +++ b/guides/common/modules/snip_technology-preview.adoc @@ -0,0 +1,12 @@ +// When including this file, ensure that {FeatureName} is set immediately before +// the include. Otherwise it will result in an incorrect replacement. + +[IMPORTANT] +==== +[subs="attributes+"] +{FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. + +For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. +==== +// Undefine {FeatureName} attribute, so that any mistakes are easily spotted +:!FeatureName: diff --git a/guides/doc-Configuring_Virt-Who-VM-Subscriptions/master.adoc b/guides/doc-Configuring_Virt-Who-VM-Subscriptions/master.adoc index 83c10b0cce9..746385754fe 100644 --- a/guides/doc-Configuring_Virt-Who-VM-Subscriptions/master.adoc +++ b/guides/doc-Configuring_Virt-Who-VM-Subscriptions/master.adoc @@ -21,4 +21,4 @@ include::common/assembly_overview-of-vm-subscriptions.adoc[leveloffset=+1] include::common/assembly_managing-virt-who-configurations.adoc[leveloffset=+1] include::common/assembly_troubleshooting-virt-who.adoc[leveloffset=+1] - +endif::[]