From 4eba9e67f3ea92237d4b440f9a07dfe3778b57f8 Mon Sep 17 00:00:00 2001 From: Avital Pinnick Date: Thu, 5 Dec 2024 18:10:41 +0200 Subject: [PATCH] Upstreamize VM subscriptions guide --- ...mbly_managing-virt-who-configurations.adoc | 23 ++++ ...assembly_overview-of-vm-subscriptions.adoc | 3 + .../assembly_troubleshooting-virt-who.adoc | 11 ++ guides/common/attributes-titles.adoc | 1 + ...con_deploying-virt-who-configurations.adoc | 10 ++ ...anaging-virtual-machine-subscriptions.adoc | 7 + .../modules/con_troubleshooting-virt-who.adoc | 4 + ...irtual-machine-subscriptions-overview.adoc | 19 +++ ...r-subscriptions-that-require-virt-who.adoc | 10 ++ .../proc_checking-virt-who-status.adoc | 21 +++ ...roc_creating-a-virt-who-configuration.adoc | 123 ++++++++++++++++++ ...a-virt-who-configuration-on-a-capsule.adoc | 40 ++++++ ...irt-who-configuration-on-a-hypervisor.adoc | 46 +++++++ ...nfiguration-on-a-separate-rhel-server.adoc | 72 ++++++++++ ...who-configuration-on-satellite-server.adoc | 17 +++ ...proc_editing-a-virt-who-configuration.adoc | 26 ++++ .../proc_enabling-rhsm-debug-logging.adoc | 26 ++++ ...roc_removing-a-virt-who-configuration.adoc | 16 +++ .../proc_testing-virt-who-configurations.adoc | 33 +++++ .../modules/ref_troubleshooting-virt-who.adoc | 75 +++++++++++ .../ref_virt-who-configuration-examples.adoc | 85 ++++++++++++ .../ref_virt-who-configuration-overview.adoc | 29 +++++ ...ef_virt-who-troubleshooting-scenarios.adoc | 28 ++++ .../Makefile | 1 + .../common | 1 + .../docinfo.html | 1 + .../docinfo.xml | 15 +++ .../images | 1 + .../master.adoc | 24 ++++ .../upstream_filename_to_satellite_link.json | 1 + 30 files changed, 769 insertions(+) create mode 100644 guides/common/assembly_managing-virt-who-configurations.adoc create mode 100644 guides/common/assembly_overview-of-vm-subscriptions.adoc create mode 100644 guides/common/assembly_troubleshooting-virt-who.adoc create mode 100644 guides/common/modules/con_deploying-virt-who-configurations.adoc create mode 100644 guides/common/modules/con_managing-virtual-machine-subscriptions.adoc create mode 100644 guides/common/modules/con_troubleshooting-virt-who.adoc create mode 100644 guides/common/modules/con_virtual-machine-subscriptions-overview.adoc create mode 100644 guides/common/modules/proc_checking-for-subscriptions-that-require-virt-who.adoc create mode 100644 guides/common/modules/proc_checking-virt-who-status.adoc create mode 100644 guides/common/modules/proc_creating-a-virt-who-configuration.adoc create mode 100644 guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-capsule.adoc create mode 100644 guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-hypervisor.adoc create mode 100644 guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-separate-rhel-server.adoc create mode 100644 guides/common/modules/proc_deploying-a-virt-who-configuration-on-satellite-server.adoc create mode 100644 guides/common/modules/proc_editing-a-virt-who-configuration.adoc create mode 100644 guides/common/modules/proc_enabling-rhsm-debug-logging.adoc create mode 100644 guides/common/modules/proc_removing-a-virt-who-configuration.adoc create mode 100644 guides/common/modules/proc_testing-virt-who-configurations.adoc create mode 100644 guides/common/modules/ref_troubleshooting-virt-who.adoc create mode 100644 guides/common/modules/ref_virt-who-configuration-examples.adoc create mode 100644 guides/common/modules/ref_virt-who-configuration-overview.adoc create mode 100644 guides/common/modules/ref_virt-who-troubleshooting-scenarios.adoc create mode 100644 guides/doc-Configuring_Virtual_Machine_Subscriptions/Makefile create mode 120000 guides/doc-Configuring_Virtual_Machine_Subscriptions/common create mode 120000 guides/doc-Configuring_Virtual_Machine_Subscriptions/docinfo.html create mode 100644 guides/doc-Configuring_Virtual_Machine_Subscriptions/docinfo.xml create mode 120000 guides/doc-Configuring_Virtual_Machine_Subscriptions/images create mode 100644 guides/doc-Configuring_Virtual_Machine_Subscriptions/master.adoc diff --git a/guides/common/assembly_managing-virt-who-configurations.adoc b/guides/common/assembly_managing-virt-who-configurations.adoc new file mode 100644 index 00000000000..c7f6fc4199e --- /dev/null +++ b/guides/common/assembly_managing-virt-who-configurations.adoc @@ -0,0 +1,23 @@ +include::modules/con_managing-virtual-machine-subscriptions.adoc[] + +include::modules/proc_checking-for-subscriptions-that-require-virt-who.adoc[leveloffset=+1] + +include::modules/proc_creating-a-virt-who-configuration.adoc[leveloffset=+1] + +include::modules/ref_virt-who-configuration-examples.adoc[leveloffset=+2] + +include::modules/con_deploying-virt-who-configurations.adoc[leveloffset=+1] + +// next steps - activation keys, system purpose attributes, register host + +include::modules/proc_deploying-a-virt-who-configuration-on-a-hypervisor.adoc[leveloffset=+2] + +include::modules/proc_deploying-a-virt-who-configuration-on-satellite-server.adoc[leveloffset=+2] + +include::modules/proc_deploying-a-virt-who-configuration-on-a-capsule.adoc[leveloffset=+2] + +include::modules/proc_deploying-a-virt-who-configuration-on-a-separate-rhel-server.adoc[leveloffset=+2] + +include::modules/proc_editing-a-virt-who-configuration.adoc[leveloffset=+1] + +include::modules/proc_removing-a-virt-who-configuration.adoc[leveloffset=+1] \ No newline at end of file diff --git a/guides/common/assembly_overview-of-vm-subscriptions.adoc b/guides/common/assembly_overview-of-vm-subscriptions.adoc new file mode 100644 index 00000000000..7724378f447 --- /dev/null +++ b/guides/common/assembly_overview-of-vm-subscriptions.adoc @@ -0,0 +1,3 @@ +include::modules/con_virtual-machine-subscriptions-overview.adoc[] + +include::modules/ref_virt-who-configuration-overview.adoc[leveloffset=+1] diff --git a/guides/common/assembly_troubleshooting-virt-who.adoc b/guides/common/assembly_troubleshooting-virt-who.adoc new file mode 100644 index 00000000000..aff8198030c --- /dev/null +++ b/guides/common/assembly_troubleshooting-virt-who.adoc @@ -0,0 +1,11 @@ +include::modules/con_troubleshooting-virt-who.adoc[] + +include::modules/proc_checking-virt-who-status.adoc[leveloffset=+1] + +include::modules/proc_enabling-rhsm-debug-logging.adoc[leveloffset=+1] + +include::modules/proc_testing-virt-who-configurations.adoc[leveloffset=+1] + +include::modules/ref_troubleshooting-virt-who.adoc[leveloffset=+1] + +include::modules/ref_virt-who-troubleshooting-scenarios.adoc[leveloffset=+1] \ No newline at end of file diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc index 2d5f1c4dd12..ac21e025d3a 100644 --- a/guides/common/attributes-titles.adoc +++ b/guides/common/attributes-titles.adoc @@ -6,6 +6,7 @@ :AppCentricDeploymentDocTitle: Deploying hosts by using application centric approach :ConfiguringLoadBalancerDocTitle: Configuring {SmartProxies} with a load balancer :ConfiguringUserAuthenticationDocTitle: Configuring authentication for {ProjectName} users +:ConfiguringVMSubscriptionsDocTitle: Configuring virtual machine subscriptions :ContentManagementDocTitle: Managing content :ConvertingHostRHELDocTitle: Converting a host to RHEL :DeployingAWSDocTitle: Deploying {ProjectName} on Amazon Web Services diff --git a/guides/common/modules/con_deploying-virt-who-configurations.adoc b/guides/common/modules/con_deploying-virt-who-configurations.adoc new file mode 100644 index 00000000000..c417f2700ef --- /dev/null +++ b/guides/common/modules/con_deploying-virt-who-configurations.adoc @@ -0,0 +1,10 @@ +[id="deploying-virt-who-configurations_{context}"] += Deploying virt-who configurations + +After you create a virt-who configuration, you download a script from the {ProjectWebUI} to deploy the configuration. + +The script installs virt-who and creates the local and global virt-who configuration files. + +For {oVirt}, {EL} Virtualization (KVM), and {OpenStack}, you deploy the configuration on the hypervisor specified in the file. + +For VMware vSphere, Microsoft Hyper-V, and Nutanix AHV, you deploy the configuration on {ProjectServer}, {SmartProxyServer}, or on a dedicated {EL} server. diff --git a/guides/common/modules/con_managing-virtual-machine-subscriptions.adoc b/guides/common/modules/con_managing-virtual-machine-subscriptions.adoc new file mode 100644 index 00000000000..c329c261d7d --- /dev/null +++ b/guides/common/modules/con_managing-virtual-machine-subscriptions.adoc @@ -0,0 +1,7 @@ += Managing virtual machine subscriptions + +You can check for subscriptions that require a virt-who configuration. + +Then, you create a virt-who configuration and deploy it on a hypervisor or virtualization manager. + +Optionally, you can edit or delete a virt-who configuration. \ No newline at end of file diff --git a/guides/common/modules/con_troubleshooting-virt-who.adoc b/guides/common/modules/con_troubleshooting-virt-who.adoc new file mode 100644 index 00000000000..1f2f1f83121 --- /dev/null +++ b/guides/common/modules/con_troubleshooting-virt-who.adoc @@ -0,0 +1,4 @@ +[id="troubleshooting-virt-who_{context}"] += Troubleshooting virt-who + +You can troubleshoot virt-who by checking the service status, logs, and by identifying configuration issues. \ 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 new file mode 100644 index 00000000000..65b3713d752 --- /dev/null +++ b/guides/common/modules/con_virtual-machine-subscriptions-overview.adoc @@ -0,0 +1,19 @@ +[id="virtual-machine-subscriptions-overview_{context}"] += Virtual machine subscriptions overview + +Virtual machines (VMs) require host-based subscriptions instead of physical subscriptions. +Many host-based subscriptions include entitlements for unlimited VMs. + +You can configure and deploy virt-who on your hypervisors. +virt-who queries the virtualization platform and reports hypervisor and VM information to {Project}. +You can view your subscription usage by using the Subscriptions service on the {RHCloud}. + +You can configure host-based subscriptions for {EL} VMs on the following virtualization platforms: + +* {oVirt} +* {EL} Virtualization (KVM) +* {OpenStack} +* VMware vSphere +* Microsoft Hyper-V +* Nutanix AHV: See the Red Hat Knowledgebase solution link:https://access.redhat.com/articles/6216971[How to configure virt-who for Nutanix AHV to work with Red Hat Satellite Server]. + 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 new file mode 100644 index 00000000000..36e3be0f38d --- /dev/null +++ b/guides/common/modules/proc_checking-for-subscriptions-that-require-virt-who.adoc @@ -0,0 +1,10 @@ +[id="checking-for-subscriptions-that-require-virt-who_{context}"] += Checking for subscriptions that require virt-who + +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 new file mode 100644 index 00000000000..cf320e89a9a --- /dev/null +++ b/guides/common/modules/proc_checking-virt-who-status.adoc @@ -0,0 +1,21 @@ +[id="checking-virt-who-status_{context}"] += Checking virt-who status + +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}: ++ +---- +$ hammer virt-who-config list +---- ++ +The output includes the date and time when each virt-who instance reported to {ProjectServer}. \ No newline at end of file diff --git a/guides/common/modules/proc_creating-a-virt-who-configuration.adoc b/guides/common/modules/proc_creating-a-virt-who-configuration.adoc new file mode 100644 index 00000000000..26df2cbcac9 --- /dev/null +++ b/guides/common/modules/proc_creating-a-virt-who-configuration.adoc @@ -0,0 +1,123 @@ +[id="creating-a-virt-who-configuration_{context}"] += Creating a virt-who configuration + +You can create a virt-who configuration by using the {ProjectWebUI} or the Hammer CLI tool. + +The virt-who configuration creates a `virt_who_reporter_[id]` user with the `Virt-who Reporter` role, which provides minimal permissions for virt-who reporting to {ProjectServer}. +This user cannot be manually configured or used to log in to {ProjectServer}. + +Local configuration values are stored in the `/etc/virt-who.d/_conf_name_.conf` file and apply only to the hypervisor or virtualization manager. + +Global configuration values, such as `Interval`, `Enable debugging output`, `HTTP Proxy`, and `Ignore Proxy`, apply to all virt-who configurations on the same server and are overwritten if you deploy a new virt-who configuration on that server. +Global configuration values are stored in the `/etc/sysconfig/virt-who` file. + +.Prerequisites + +* You have imported a subscription manifest that includes a host-based subscription into {ProjectServer}. +* {oVirt}, {EL} Virtualization (KVM), {OpenStack}: +** You have registered the hypervisor to {ProjectServer}. +** You have created a virt-who user with read-only access and a non-expiring password on each hypervisor. +* VMware vSphere: You have created a virt-who user with read-only access to all objects in the vCenter Data Center and a non-expiring password on the vCenter Server. +* Microsoft Hyper-V: +** You have enabled remote management on each hypervisor. +** You have created a virt-who user with read-only access and a non-expiring password on each hypervisor. + +.Procedure + +. In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. +. Click *Create Config*. +. Complete the following fields: +* *Name*: Configuration name. +* *Hypervisor Type*: +** {EL} Virtualization (KVM), {oVirt}, or {OpenStack}: *libvirt* +** VMware vSphere: *esx* +** Microsoft Hyper-V: *hyperv* +// * Note that the *rhevm* and *xen* hypervisor types are not supported, and the *kubevirt* hypervisor type is provided as a Technology Preview only. + +* VMware vSphere and Microsoft Hyper-V: +** *Hypervisor Server*: FQDN or IP address. +** *Hypervisor Username*: virt-who user name. +** *Hypervisor Password*: virt-who user password. +The password is encrypted when you deploy the configuration. + +* *Interval*: Virtual machine information reporting interval. +Because the virtual machines are granted temporary subscriptions for up to seven days, frequent queries are not required. +A 24-hour interval is suitable for most environments. + +* *Satellite server FQDN*. +* *Hypervisor ID*: Select *Hostname* or *UUID*. + +. Optional: You can set the following filters for hypervisors queried by virt-who: +* *Unlimited* (default): All hypervisors are queried. +* *Whitelist*: Specific hypervisors are included. +* *Blacklist*: Specific hypervisors are excluded. +* *Filter hosts*: Comma-separated list of included hypervisors. +* *Exclude hosts*: Comma-separated list of excluded hypervisors. ++ +-- +Specify the host name or UUID according to the hypervisor ID you selected. + +.Host names + +* You can use wildcards, regular expressions, and special characters in the host name. +* If you use regular expressions, you must escape the backslashes. +* If you use special characters, you must enclose the host name in quotation marks. +-- + +* vCenter Server only: +** *Filter host parents*: Comma-separated list of included cluster IDs. +** *Exclude host parents*: Comma-separated list of excluded cluster IDs. +For more information, see link:https://access.redhat.com/solutions/5696481[Using the "Filter Host Parents" and "Exclude Host Parents" Attributes with VMware Clusters] in the _Red{nbsp}Hat Knowledgebase_. + +. You can set the following output and proxy options: + +* *Enable debugging output*: Optional. +* *HTTP Proxy*. +Example: `http://_proxy.example.com_:3128`. ++ +To use no proxy, leave this field blank; this has the same result as entering `{asterisk}` in the *Ignore Proxy* field. +* *Ignore Proxy*: Comma-separated list of host names, IP addresses, or domains to bypass existing proxy settings. +. Click *Submit*. + +.CLI procedure + +* On {ProjectServer}, enter the `hammer virt-who-config create` command according to the following example: ++ +[options="nowrap" subs="+quotes"] +---- +$ hammer virt-who-config create \ +--name _My_virt-who_Configuration_ \ +--organizations "_My_Organization_" \ +--interval 720 \ <1> +--filtering-mode none \ <2> +--hypervisor-id hostname \ <3> +--hypervisor-type libvirt \ <4> +--hypervisor-server _{foreman-example-com}_ \ <5> +--hypervisor-username virt-who \ <6> +--proxy '_http://proxy.example.com_:3128' \ <7> +--satellite-url server.example.com +---- +-- +<1> Virtual machine information reporting interval, in minutes. +<2> Specify `none` for no filtering of hypervisors for virt-who queries. +Specify `whitelist` or `blacklist` to include or exclude hypervisors for virt-who queries. +<3> Specify `hostname`, `uuid`, or `hwuuid` for the hypervisor ID format. +* You can use `uuid` to avoid duplication if a hypervisor is renamed. ++ +* You can use `hwuuid` for configurations that apply to a virtualization manager instead of an individual hypervisor. ++ +[NOTE] +==== +You cannot change `hwuuid` to another option after virt-who starts running because this might cause duplicate entires in Subscription Manager. +==== + +<4> Specify the hypervisor type: +* {EL} Virtualization (KVM), {oVirt}, or {OpenStack}: `libvirt`. +* VMware vSphere: `esx`. +* Microsoft Hyper-V: `hyperv`. +<5> Specify the FQDN or IP address of the hypervisor or the vCenter Server. +<6> Specify the virt-who user name. ++ +For VMware vSphere or Microsoft Hyper-V, specify the virt-who user password: `--hypervisor-password `. +<7> Optional. +-- \ No newline at end of file diff --git a/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-capsule.adoc b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-capsule.adoc new file mode 100644 index 00000000000..babb257139b --- /dev/null +++ b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-capsule.adoc @@ -0,0 +1,40 @@ +[id="deploying-a-virt-who-configuration-on-a-capsule_{context}"] += Deploying a virt-who configuration on a {SmartProxyServer} + +For VMware vSphere and Microsoft Hyper-V, you can deploy the virt-who configuration on {SmartProxyServer}. + +Global configuration values apply to all virt-who configurations on the same {SmartProxyServer} and are overwritten if you deploy a new virt-who configuration. + +.Procedure + +. In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. +. Click a virt-who configuration. +. Click the *Deploy* tab. +. Under *Configuration script*, click *Download the script*. +. Copy the script to {SmartProxyServer}: ++ +[options="nowrap" subs="+quotes"] +---- +$ scp _deploy_virt_who_config_1_.sh root@_{smartproxy-example-com}_: +---- + +. Make the script executable: ++ +[options="nowrap" subs="+quotes"] +---- +$ chmod +x _deploy_virt_who_config_1_.sh +---- + +. Run the script: ++ +[options="nowrap" subs="+quotes"] +---- +$ sh _deploy_virt_who_config_1_.sh +---- + +. After the deployment is complete, delete the script: ++ +[options="nowrap" subs="+quotes"] +---- +$ rm _deploy_virt_who_config_1_ +---- diff --git a/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-hypervisor.adoc b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-hypervisor.adoc new file mode 100644 index 00000000000..4d16212df75 --- /dev/null +++ b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-hypervisor.adoc @@ -0,0 +1,46 @@ +[id="deploying-a-virt-who-configuration-on-a-hypervisor_{context}"] += Deploying a virt-who configuration on a hypervisor or a {SmartProxyServer} + +For {oVirt}, {EL} Virtualization (KVM), and {OpenStack}, you deploy the configuration on the hypervisor specified in the file. + +Global values apply only to this hypervisor. + +.Prerequisites + +* You have registered the hypervisor to {ProjectServer}. +* {oVirt}: You have updated {oVirt} to the latest version so that the minimum virt-who version is available. +virt-who is available by default on {oVirt}, but you cannot update virt-who by using the `rhel-7-server-rhvh-4-rpms` repository. + +.Procedure + +. In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. +. Click a virt-who configuration. +. Click the *Deploy* tab. +. Under *Configuration script*, click *Download the script*. +. Copy the script to the hypervisor: ++ +[options="nowrap" subs="+quotes"] +---- +$ scp _deploy_virt_who_config_1_.sh root@_hypervisor.example.com_: +---- + +. Make the script executable: ++ +[options="nowrap" subs="+quotes"] +---- +$ chmod +x _deploy_virt_who_config_1_.sh +---- + +. Run the script: ++ +[options="nowrap" subs="+quotes"] +---- +$ sh _deploy_virt_who_config_1_.sh +---- + +. After the deployment is complete, delete the script: ++ +[options="nowrap" subs="+quotes"] +---- +$ rm _deploy_virt_who_config_1_ +---- diff --git a/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-separate-rhel-server.adoc b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-separate-rhel-server.adoc new file mode 100644 index 00000000000..013e397b807 --- /dev/null +++ b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-a-separate-rhel-server.adoc @@ -0,0 +1,72 @@ +[id="deploying-a-virt-who-configuration-on-a-separate-rhel-server_{context}"] += Deploying a virt-who configuration on a dedicated {EL} server + +For VMware vSphere and Microsoft Hyper-V, you can deploy the virt-who configuration on a dedicated {EL} server. +The server can be physical or virtual. + +Global configuration values apply to all virt-who configurations on this server and are overwritten if you deploy a new virt-who configuration. + +.Procedure + +. On the {EL} server, install the {ProjectServer} CA certificate: ++ +[options="nowrap" subs="+quotes"] +---- +$ rpm -ivh http://__{server.example.com}__/pub/katello-ca-consumer-latest.noarch.rpm +---- + +. Register the {EL} server to {ProjectServer}: ++ +[options="nowrap" subs="+quotes"] +---- +$ subscription-manager register \ +--org=_organization_label_ \ +--auto-attach +---- + +. Add a TCP port for communication between virt-who and {ProjectServer} to the runtime configuration: ++ +[options="nowrap"] +---- +$ firewall-cmd --add-port="/tcp" <1> +---- +<1> Specify `443` for VMware vCenter or `5985` for Microsoft Hyper-V. + +. Add a TCP port for communication between virt-who and {ProjectServer} to the permanent configuration: ++ +[options="nowrap"] +---- +$ firewall-cmd --add-port="/tcp" --permanent +---- + +. In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. +. Click a virt-who configuration file. +. Click the *Deploy* tab. +. Under *Configuration script*, click *Download the script*. +. Copy the script to the {EL} server: ++ +[options="nowrap" subs="+quotes"] +---- +$ scp _deploy_virt_who_config_1_.sh root@_server.example.com_: +---- + +. Make the script executable: ++ +[options="nowrap" subs="+quotes"] +---- +$ chmod +x _deploy_virt_who_config_1_.sh +---- + +. Run the script: ++ +[options="nowrap" subs="+quotes"] +---- +$ sh _deploy_virt_who_config_1_.sh +---- + +. After the deployment is complete, delete the script: ++ +[options="nowrap" subs="+quotes"] +---- +$ rm _deploy_virt_who_config_1_ +---- diff --git a/guides/common/modules/proc_deploying-a-virt-who-configuration-on-satellite-server.adoc b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-satellite-server.adoc new file mode 100644 index 00000000000..49de0d7ee75 --- /dev/null +++ b/guides/common/modules/proc_deploying-a-virt-who-configuration-on-satellite-server.adoc @@ -0,0 +1,17 @@ +[id="deploying-a-virt-who-configuration-on-satellite-server_{context}"] += Deploying a virt-who configuration on {ProjectServer} + +For VMware vSphere and Microsoft Hyper-V, you deploy the virt-who configuration on {ProjectServer}. + +Global configuration values apply to all virt-who configurations on {ProjectServer} and are overwritten if you deploy a new virt-who configuration. + +.Prerequisites + +* Microsoft Hyper-V only: You have enabled remote management on the hypervisor. + +.Procedure + +. In the {ProjectWebUI}, navigate to *Infrastructure* > *Virt-who Configurations*. +. Click a virt-who configuration. +. Under *Hammer command*, click *Copy to clipboard*. +. Log in to {ProjectServer} and paste the Hammer command into your terminal. diff --git a/guides/common/modules/proc_editing-a-virt-who-configuration.adoc b/guides/common/modules/proc_editing-a-virt-who-configuration.adoc new file mode 100644 index 00000000000..95cb16ee39d --- /dev/null +++ b/guides/common/modules/proc_editing-a-virt-who-configuration.adoc @@ -0,0 +1,26 @@ +[id="editing-a-virt-who-configuration_{context}"] += Editing a virt-who configuration + +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*. +. Deploy the modified virt-who configuration. + +[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"] +---- +$ hammer virt-who-config update \ +--name _My_virt-who_Configuration_ \ +--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 new file mode 100644 index 00000000000..e10a7a98707 --- /dev/null +++ b/guides/common/modules/proc_enabling-rhsm-debug-logging.adoc @@ -0,0 +1,26 @@ +[id="enabling-rhasm-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. + +.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. + +.CLI procedure + +. On {ProjectServer}, run the `hammer virt-who-config update` command with the debug option: ++ +[options="nowrap" subs="+quotes"] +---- +$ 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 new file mode 100644 index 00000000000..e9b248c85d9 --- /dev/null +++ b/guides/common/modules/proc_removing-a-virt-who-configuration.adoc @@ -0,0 +1,16 @@ +[id="removing-an-existing-virt-who-configuration_{context}"] += Removing a virt-who configuration + +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: ++ +[options="nowrap" subs="+quotes"] ++ +---- +$ rm /etc/virt-who.d/_conf_name_.conf +---- diff --git a/guides/common/modules/proc_testing-virt-who-configurations.adoc b/guides/common/modules/proc_testing-virt-who-configurations.adoc new file mode 100644 index 00000000000..7ec9f467683 --- /dev/null +++ b/guides/common/modules/proc_testing-virt-who-configurations.adoc @@ -0,0 +1,33 @@ +[id="testing-virt-who-configurations_{context}"] += Testing virt-who configurations + +You can test virt-who configuration files, credentials, and connectivity by running the `virt-who` command on the host. + +.Procedure + +* On the {ProjectServer}, run the `virt-who` command: ++ +[source,terminal] +---- +$ virt-who --