Skip to content

Commit

Permalink
Upstreamize VM subscriptions guide
Browse files Browse the repository at this point in the history
  • Loading branch information
apinnick committed Feb 6, 2025
1 parent ac7ea60 commit c619b92
Show file tree
Hide file tree
Showing 33 changed files with 852 additions and 9 deletions.
54 changes: 54 additions & 0 deletions guides/common/assembly_configuring-virt-who-hyperv.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
:configuring-virt-who-hyperv:
:parent-context: {context}

:context: hyperv-virt-who
:hyperv-virt-who:
:provider: Microsoft Hyper-V
:targets: {ProjectServer}, {SmartProxyServer}, or on a dedicated {EL} server
include::modules/con_configuring-virt-who-for-provider.adoc[]

:hypervisor-ui: Microsoft Hyper-V (hyperv)
:hypervisor-cli: hyperv
:target-name: hypervisor.example.com
:username: virt_who_user
include::modules/proc_creating-a-virt-who-configuration.adoc[leveloffset=+1]
:!hyperv-virt-who:

:context: hyperv-projectserver
:hyperv-projectserver:
:a-target: {ProjectServer}
:the-target: {ProjectServer}
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!hyperv-projectserver:

:context: hyperv-smartproxy
:hyperv-smartproxy:
:a-target: {SmartProxyServer}
:the-target: {SmartProxyServer}
:target-name: {smartproxy-example-com}
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!hyperv-smartproxy:

:context: hyperv-el
:hyperv-el:
:target: {EL} server
:a-target: a dedicated {target}
:the-target: the {target}
:port: 5985
:target-name: server.example.com
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!hyperv-el:

:!provider:
:!targets:
:!hypervisor-ui:
:!hypervisor-cli:
:!a-target:
:!the-target:
:!port:
:!target-name:
:!provider:

:context: {parent-context}
:!parent-context:
:!configuring-virt-who-hyperv:
37 changes: 37 additions & 0 deletions guides/common/assembly_configuring-virt-who-kubevirt.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
:configuring-virt-who-kubevirt:
:parent-context: {context}

:context: kubevirt-virt-who
:kubevirt-virt-who:
:provider: {KubeVirt}
:targets: hypervisor
include::modules/con_configuring-virt-who-for-provider.adoc[]

:hypervisor-ui: Container-native virtualization
:hypervisor-cli: cnv
:target-name: hypervisor.example.com
:username: virt_who_user
include::modules/proc_creating-a-virt-who-configuration.adoc[leveloffset=+1]
:!kubevirt-virt-who:

:context: kubevirt-hypervisor
:kubevirt-hypervisor:
:a-target: a hypervisor
:the-target: the hypervisor
:target-name: hypervisor.example.com
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!kubevirt-hypervisor:

:!provider:
:!targets:
:!hypervisor-ui:
:!hypervisor-cli:
:!a-target:
:!the-target:
:!port:
:!target-name:
:!provider:

:context: {parent-context}
:!parent-context:
:!configuring-virt-who-kubevirt:
37 changes: 37 additions & 0 deletions guides/common/assembly_configuring-virt-who-kvm.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
:configuring-virt-who-kvm:
:parent-context: {context}

:context: kvm-virt-who
:kvm-virt-who:
:provider: {EL} Virtualization
:targets: hypervisors
include::modules/con_configuring-virt-who-for-provider.adoc[]

:hypervisor-ui: libvirt
:hypervisor-cli: libvirt
:target-name: qemu+ssh://root@libvirt.example.com/system
:username: root
include::modules/proc_creating-a-virt-who-configuration.adoc[leveloffset=+1]
:!kvm-virt-who:

:context: kvm-hypervisor
:kvm-hypervisor:
:a-target: a hypervisor
:the-target: the hypervisor
:target-name: hypervisor.example.com
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!kvm-hypervisor:

:!provider:
:!targets:
:!hypervisor-ui:
:!hypervisor-cli:
:!a-target:
:!the-target:
:!port:
:!target-name:
:!provider:

:context: {parent-context}
:!parent-context:
:!configuring-virt-who-kvm:
53 changes: 53 additions & 0 deletions guides/common/assembly_configuring-virt-who-nutanix.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
:configuring-virt-who-nutanix:
:parent-context: {context}

:context: nutanix-virt-who
:nutanix-virt-who:
:provider: Nutanix AHV
:targets: {ProjectServer}, {SmartProxyServer}, or on a dedicated {EL} server
include::modules/con_configuring-virt-who-for-provider.adoc[]

:hypervisor-ui: Nutanix AHV (ahv)
:hypervisor-cli: ahv
:target-name: prism.example.com
:username: prism_user
include::modules/proc_creating-a-virt-who-configuration.adoc[leveloffset=+1]
:!nutanix-virt-who:

:context: nutanix-projectserver
:nutanix-projectserver:
:a-target: {ProjectServer}
:the-target: {ProjectServer}
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!nutanix-projectserver:

:context: nutanix-smartproxy
:nutanix-smartproxy:
:a-target: {SmartProxyServer}
:the-target: {SmartProxyServer)
:target-name: {smartproxy-example-com}
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!nutanix-smartproxy:

:context: nutanix-el
:nutanix-el:
:a-target: a dedicated {EL} server
:the-target: the {EL} server
:port: 443
:target-name: server.example.com
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!nutanix-el:

:!provider:
:!targets:
:!hypervisor-ui:
:!hypervisor-cli:
:!a-target:
:!the-target:
:!port:
:!target-name:
:!provider:

:context: {parent-context}
:!parent-context:
:!configuring-virt-who-nutanix:
37 changes: 37 additions & 0 deletions guides/common/assembly_configuring-virt-who-openstack.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
:configuring-virt-who-openstack:
:parent-context: {context}

:context: openstack-virt-who
:openstack-virt-who:
:provider: {OpenStack}
:targets: hypervisor
include::modules/con_configuring-virt-who-for-provider.adoc[]

:hypervisor-ui: libvirt
:hypervisor-cli: libvirt
:target-name: qemu:///system
:username: virt_who_user
include::modules/proc_creating-a-virt-who-configuration.adoc[leveloffset=+1]
:!openstack-virt-who:

:context: openstack-hypervisor
:openstack-hypervisor:
:a-target: a hypervisor
:the-target: the hypervisor
:target-name: hypervisor.example.com
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!openstack-hypervisor:

:!provider:
:!targets:
:!hypervisor-ui:
:!hypervisor-cli:
:!a-target:
:!the-target:
:!port:
:!target-name:
:!provider:

:context: {parent-context}
:!parent-context:
:!configuring-virt-who-openstack:
53 changes: 53 additions & 0 deletions guides/common/assembly_configuring-virt-who-vmware.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
:configuring-virt-who-vmware:
:parent-context: {context}

:context: vmware-virt-who
:vmware-virt-who:
:provider: VMware vSphere
:targets: {ProjectServer}, {SmartProxyServer}, or on a dedicated {EL} server
include::modules/con_configuring-virt-who-for-provider.adoc[]

:hypervisor-ui: VMware vSphere / vCenter (esx)
:hypervisor-cli: esx
:target-name: vcenter.example.com
:username: username_vcenter@example.com
include::modules/proc_creating-a-virt-who-configuration.adoc[leveloffset=+1]
:!vmware-virt-who:

:context: vmware-projectserver
:vmware-projectserver:
:a-target: {ProjectServer}
:the-target: {ProjectServer}
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!vmware-projectserver:

:context: vmware-smartproxy
:vmware-smartproxy:
:a-target: {SmartProxyServer}
:the-target: {SmartProxyServer}
:target-name: {smartproxy-example-com}
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!vmware-smartproxy:

:context: vmware-el
:vmware-el:
:a-target: a dedicated {EL} server
:the-target: the {EL} server
:port: 443
:target-name: server.example.com
include::modules/proc_deploying-a-virt-who-configuration-on-target-server.adoc[leveloffset=+1]
:!vmware-el:

:!provider:
:!targets:
:!hypervisor-ui:
:!hypervisor-cli:
:!a-target:
:!the-target:
:!port:
:!target-name:
:!provider:

:context: {parent-context}
:!parent-context:
:!configuring-virt-who-vmware:
5 changes: 5 additions & 0 deletions guides/common/assembly_overview-of-vm-subscriptions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
include::modules/con_virtual-machine-subscriptions-overview.adoc[]

include::modules/ref_virt-who-configuration-overview.adoc[leveloffset=+1]

include::modules/proc_checking-for-subscriptions-that-require-virt-who.adoc[leveloffset=+1]
9 changes: 9 additions & 0 deletions guides/common/assembly_troubleshooting-virt-who.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
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_virt-who-does-not-report-to-satellite.adoc[leveloffset=+1]

include::modules/ref_troubleshooting-virt-who.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions guides/common/attributes-satellite.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
:APIDocURL: {BaseURL}using_the_satellite_rest_api/index#
:ConfiguringLoadBalancerDocURL: {BaseURL}configuring_capsules_with_a_load_balancer/index#
:ConfiguringUserAuthenticationDocURL: {BaseURL}configuring_authentication_for_red_hat_satellite_users/index#
:ConfiguringVMSubscriptionsDocURL: {BaseURL}configuring_virt-who_for_virtual_machine_subscriptions/index#
:ContentManagementDocURL: {BaseURL}managing_content/index#
:InstallingServerDisconnectedDocURL: {BaseURL}installing_satellite_server_in_a_disconnected_network_environment/index#
:InstallingServerDocURL: {BaseURL}installing_satellite_server_in_a_connected_network_environment/index#
Expand Down
2 changes: 1 addition & 1 deletion guides/common/attributes-titles.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
:AppCentricDeploymentDocTitle: Deploying hosts by using application centric approach
:ConfiguringLoadBalancerDocTitle: Configuring {SmartProxies} with a load balancer
:ConfiguringUserAuthenticationDocTitle: Configuring authentication for {ProjectName} users
:ConfiguringVMSubscriptionsDocTitle: Configuring virt-who for virtual machine subscriptions
:ContentManagementDocTitle: Managing content
:ConvertingHostRHELDocTitle: Converting a host to RHEL
:DeployingAWSDocTitle: Deploying {ProjectName} on Amazon Web Services
Expand Down Expand Up @@ -34,7 +35,6 @@
:UpgradingDisconnectedPreviousDocTitle: Upgrading disconnected {ProjectName} to {ProjectVersionPrevious}

// Not upstreamed
:ConfiguringVMSubscriptionsDocTitle: Configuring virtual machine subscriptions
:ConversionsToolkitDocTitle: Converting hosts to RHEL by using Satellite conversions toolkit

// Overrides for titles per product
Expand Down
13 changes: 13 additions & 0 deletions guides/common/modules/con_configuring-virt-who-for-provider.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[id="deploying-virt-who-configuration_{context}"]
= Configuring virt-who for {provider}

You create a virt-who configuration for {provider} by using the {ProjectWebUI} or the CLI on {ProjectServer}.

Then, you deploy the generated script or Hammer command on the {targets}.

ifdef::kubevirt-virt-who[]
ifdef::satellite[]
:FeatureName: The {KubeVirt} hypervisor
include::snip_technology-preview.adoc[]
endif::[]
endif::[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[id="managing-virt-who-configurations"]
= Managing virt-who configurations

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.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions guides/common/modules/con_troubleshooting-virt-who.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[id="troubleshooting-virt-who"]
= Troubleshooting virt-who

You can troubleshoot virt-who by checking the service status, logs, and by identifying configuration issues.

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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[id="virtual-machine-subscriptions-overview"]
= Virt-who and virtual machine subscriptions

Virtual machines (VMs) require host-based {EL} subscriptions instead of physical subscriptions.
Many host-based subscriptions include entitlements for unlimited VMs.

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 virt-who for the following virtualization platforms:

* {EL} Virtualization (KVM)
* VMware vSphere
ifndef::orcharhino[]
* Nutanix AHV
endif::[]
* Microsoft Hyper-V
ifndef::orcharhino[]
* {OpenStack}
endif::[]
* {KubeVirt}

ifdef::satellite[]
:FeatureName: The {KubeVirt} hypervisor
include::snip_technology-preview.adoc[]
endif::[]
Loading

0 comments on commit c619b92

Please sign in to comment.