Add oVirt docs

guides/common/assembly_provisioning-virtual-machines-ovirt.adoc

@@ -0,0 +1,31 @@
+:compute-resource-id: ovirt
+:compute-resource: oVirt
+:ovirt-provisioning:
+
+include::modules/con_provisioning-virtual-machines-on-ovirt.adoc[]
+
+include::modules/ref_prerequisites-for-ovirt-provisioning.adoc[leveloffset=+1]
+
+include::modules/proc_installing-the-ovirt-plugin.adoc[leveloffset=+1]
+
+include::modules/proc_adding-a-ovirt-connection-to-project-server-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_adding-a-ovirt-connection-to-project-server-by-using-cli.adoc[leveloffset=+1]
+
+include::modules/proc_preparing-cloud-init-images-in-ovirt.adoc[leveloffset=+1]
+
+include::modules/proc_adding-compute-resource-images-to-project-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_adding-compute-resource-images-to-project-by-using-cli.adoc[leveloffset=+1]
+
+include::modules/proc_adding-ovirt-details-to-a-compute-profile-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_adding-ovirt-details-to-a-compute-profile-by-using-cli.adoc[leveloffset=+1]
+
+include::modules/proc_creating-hosts-on-compute-resource-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_creating-hosts-on-compute-resource-by-using-cli.adoc[leveloffset=+1]
+
+:!compute-resource-id:
+:!compute-resource:
+:!ovirt-provisioning:

guides/common/modules/con_overview-of-hosts-in-project.adoc

@@ -9,13 +9,13 @@ Hosts can be physical or virtual.
 
 You can deploy virtual hosts on any platform supported by {ProjectName},
 ifndef::satellite,orcharhino[]
-such as Amazon EC2, Google Compute Engine, KVM, libvirt, Microsoft Azure, OpenStack, Proxmox, Rackspace Cloud Services, or VMware vSphere.
+such as Amazon EC2, Google Compute Engine, KVM, libvirt, Microsoft Azure, OpenStack, oVirt, Proxmox, Rackspace Cloud Services, or VMware vSphere.
 endif::[]
 ifdef::satellite[]
 such as Amazon EC2, Google Compute Engine, KVM, libvirt, Microsoft Azure, OpenStack, Rackspace Cloud Services, or VMware vSphere.
 endif::[]
 ifdef::orcharhino[]
-such as Amazon EC2, Google Compute Engine, libvirt, Microsoft Azure, Proxmox, and VMware vSphere.
+such as Amazon EC2, Google Compute Engine, libvirt, Microsoft Azure, Oracle Linux Virtualization Manager, oVirt, Proxmox, RHV, and VMware vSphere.
 endif::[]
 
 With {Project}, you can manage hosts at scale, including monitoring, provisioning, remote execution,

guides/common/modules/con_provisioning-virtual-machines-on-ovirt.adoc

@@ -0,0 +1,15 @@
+:_mod-docs-content-type: CONCEPT
+
+[id="provisioning-virtual-machines-on-ovirt"]
+= Provisioning virtual machines on oVirt
+
+[role="_abstract"]
+oVirt is an enterprise-grade server and desktop virtualization platform.
+In {ProjectName}, you can manage virtualization functions through oVirt's REST API.
+This includes creating virtual machines and controlling their power states.
+
+You can use oVirt provisioning to create virtual machines over a network connection or from an existing image.
+
+You can use `cloud-init` to configure the virtual machines that you provision.
+Using `cloud-init` avoids any special configuration on the network, such as a managed DHCP and TFTP, to finish the installation of the virtual machine.
+This method does not require {Project} to connect to the provisioned virtual machine over SSH to run the finish script.

guides/common/modules/proc_adding-a-ovirt-connection-to-project-server-by-using-cli.adoc

@@ -0,0 +1,23 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-a-ovirt-connection-to-{project-context}-server-by-using-cli"]
+= Adding a oVirt connection to {ProjectServer} by using Hammer CLI
+
+[role="_abstract"]
+Use this procedure to add oVirt as a compute resource in {Project}.
+
+.Procedure
+* Connect your oVirt to {ProjectServer}:
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+$ hammer compute-resource create \
+--datacenter "_My_Data_Center_" \
+--locations "_My_Location_" \
+--name "__My_oVirt__" \
+--organizations "_My_Organization_" \
+--password "_My_Password_" \
+--provider "Ovirt" \
+--url "_https://ovirt.example.com/ovirt-engine/api/v4_" \
+--user "_{Project}_User_"
+----

guides/common/modules/proc_adding-a-ovirt-connection-to-project-server-by-using-web-ui.adoc

@@ -0,0 +1,25 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-a-ovirt-connection-to-{project-context}-server-by-using-web-ui"]
+= Adding a oVirt connection to {ProjectServer} by using {ProjectWebUI}
+
+[role="_abstract"]
+Use this procedure to add oVirt as a compute resource in {Project}.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Infrastructure* > *Compute Resources*.
+. Click *Create Compute Resource*.
+. In the *Name* field, enter a name for the new compute resource.
+. From the *Provider* list, select *oVirt*.
+. In the *Description* field, enter a description for the compute resource.
+. In the *URL* field, enter the connection URL for the oVirt API in the following form: `\https://ovirt.example.com/ovirt-engine/api/v4`.
+. In the *User* field, enter the name of a user with permissions to access oVirt resources.
+. In the *Password* field, enter the password of the user.
+. Click *Load Datacenters* to populate the *Datacenter* list with data centers from your oVirt environment.
+. From the *Datacenter* list, select a data center.
+. From the *Quota ID* list, select a quota to limit resources available to {Project}.
+. In the *X509 Certification Authorities* field, enter the certificate authority for SSL/TLS access.
+Alternatively, if you leave the field blank, a self-signed certificate is generated on the first API request by the server.
+. Click the *Locations* tab and select the location you want to use.
+. Click the *Organizations* tab and select the organization you want to use.
+. Click *Submit* to save the compute resource.

guides/common/modules/proc_adding-compute-resource-images-to-project-by-using-web-ui.adoc

@@ -16,13 +16,13 @@ ifdef::kvm-provisioning[Note that you can manage only directory pool storage typ
 . From the *Operating System* list, select the base operating system of the image.
 . From the *Architecture* list, select the operating system architecture.
 . In the *Username* field, enter the SSH user name for image access.
-ifdef::kvm-provisioning,openstack-provisioning[This is normally the `root` user.]
+ifdef::kvm-provisioning,ovirt-provisioning,openstack-provisioning[This is normally the `root` user.]
 ifdef::gce-provisioning[]
 Specify a user other than `root`, because the `root` user cannot connect to a GCE instance using SSH keys.
 The username must begin with a letter and consist of lowercase letters and numbers.
 endif::[]
 ifdef::azure-provisioning[You cannot use the `root` user.]
-ifdef::kvm-provisioning,openstack-provisioning[. In the *Password* field, enter the SSH password for image access.]
+ifdef::kvm-provisioning,ovirt-provisioning,openstack-provisioning[. In the *Password* field, enter the SSH password for image access.]
 ifdef::azure-provisioning[. Optional: In the *Password* field, enter a password to authenticate with.]
 ifdef::kvm-provisioning[]
 . In the *Image path* field, enter the full path that points to the image on the KVM server.
@@ -33,7 +33,7 @@ For example:
  /var/lib/libvirt/images/TestImage.qcow2
 ----
 endif::[]
-ifdef::openstack-provisioning,gce-provisioning[. From the *Image* list, select an image from the {compute-resource} compute resource.]
+ifdef::openstack-provisioning,ovirt-provisioning,gce-provisioning[. From the *Image* list, select an image from the {compute-resource} compute resource.]
 ifdef::azure-provisioning[]
 . In the *Azure Image Name* field, enter an image name in the format `_prefix://UUID_`.
 +

guides/common/modules/proc_adding-ovirt-details-to-a-compute-profile-by-using-cli.adoc

@@ -0,0 +1,27 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-ovirt-details-to-a-compute-profile-by-using-cli"]
+= Adding oVirt details to a compute profile by using Hammer CLI
+
+[role="_abstract"]
+Use this procedure to add oVirt hardware settings to a compute profile.
+When you create a host on oVirt using this compute profile, these settings are automatically populated.
+
+.Procedure
+. Create a compute profile:
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+$ hammer compute-profile create --name "_My_oVirt_"
+----
+. Set the values for the compute profile:
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+$ hammer compute-profile values create \
+--compute-attributes "cluster=Default,cores=1,memory=1073741824,start=true"" \
+--compute-profile "_My_oVirt_" \
+--compute-resource "__My_oVirt__" \
+--interface "compute_interface=_Interface_Type_,compute_name=eth0,compute_network=_My_Network_" \
+--volume "size_gb=20G,storage_domain=Data,bootable=true"
+----

guides/common/modules/proc_adding-ovirt-details-to-a-compute-profile-by-using-web-ui.adoc

@@ -0,0 +1,32 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-ovirt-details-to-a-compute-profile-by-using-web-ui"]
+= Adding oVirt details to a compute profile by using {ProjectWebUI}
+
+[role="_abstract"]
+Use this procedure to add oVirt hardware settings to a compute profile.
+When you create a host on oVirt using this compute profile, these settings are automatically populated.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Infrastructure* > *Compute Profiles*.
+. In the compute profiles window, click the name of an existing compute profile, or click *Create Compute Profile*, enter a *Name*, and click *Submit*.
+. Click the name of the oVirt compute resource.
+. From the *Cluster* list, select the target host cluster in the oVirt environment.
+. From the *Template* list, select the oVirt template to use for the *Cores* and *Memory* settings.
+. In the *Cores* field, enter the number of CPU cores to allocate to the new host.
+. In the *Memory* field, enter the amount of memory to allocate to the new host.
+. From the *Image* list, select image to use for image-based provisioning.
+. In the *Network Interfaces* area, enter the network parameters for the host's network interface.
+You can create multiple network interfaces.
+However, at least one interface must point to a {SmartProxy}-managed network.
+For each network interface, enter the following details:
+.. In the *Name* field, enter the name of the network interface.
+.. From the *Network* list, select The logical network that you want to use.
+. In the *Storage* area, enter the storage parameters for the host.
+You can create multiple volumes for the host.
+For each volume, enter the following details:
+.. In the *Size (GB)* enter the size, in GB, for the new volume.
+.. From the *Storage domain* list, select the storage domain for the volume.
+.. From the *Preallocate disk*, select either thin provisioning or preallocation of the full disk.
+.. From the *Bootable* list, select whether you want a bootable or non-bootable volume.
+. Click *Submit* to save the compute profile.

guides/common/modules/proc_booting-virtual-machines.adoc

@@ -13,6 +13,7 @@ The following virtualization hypervisors support iPXE:
 
 ** libvirt
 ifndef::satellite[]
+** oVirt
 ** VMWare (https://ipxe.org/howto/vmware[via custom firmware])
 endif::[]
 * You have configured your iPXE environment.

guides/common/modules/proc_creating-hosts-on-compute-resource-by-using-cli.adoc

@@ -40,6 +40,26 @@ $ hammer host create \
 --volume="pool_name=default,capacity=20G,format_type=qcow2"
 ----
 endif::[]
+ifdef::ovirt-provisioning[]
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+$ hammer host create \
+--build true \
+--compute-attributes="cluster=Default,cores=1,memory=1073741824,start=true" \
+--compute-resource "_My_oVirt_" \
+--enabled true \
+--hostgroup "_My_Host_Group_" \
+--interface "managed=true,primary=true,provision=true,compute_name=eth0,compute_network=_My_Network_" \
+--location "_My_Location_" \
+--managed true \
+--name "_My_Host_Name_" \
+--organization "_My_Organization_" \
+--provision-method build \
+--volume="size_gb=20G,storage_domain=Data,bootable=true"
+----
+endif::[]
+
 ** To use image-based provisioning, create the host with the `hammer host create` command and include `--provision-method image`.
 Replace the values in the following example with the appropriate values for your environment.
 ifdef::kvm-provisioning[]
@@ -61,3 +81,22 @@ $ hammer host create \
 --volume="pool_name=default,capacity=20G,format_type=qcow2"
 ----
 endif::[]
+ifdef::ovirt-provisioning[]
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+$ hammer host create \
+--compute-attributes="cluster=Default,cores=1,memory=1073741824,start=true" \
+--compute-resource "_My_oVirt_" \
+--enabled true \
+--hostgroup "_My_Host_Group_" \
+--image "_My_oVirt_Image_" \
+--interface "managed=true,primary=true,provision=true,compute_name=eth0,compute_network=_My_Network_" \
+--location "_My_Location_" \
+--managed true \
+--name "_My_Host_Name_" \
+--organization "_My_Organization_" \
+--provision-method "image" \
+--volume="size_gb=20G,storage_domain=Data,bootable=true"
+----
+endif::[]

guides/common/modules/proc_installing-the-ovirt-plugin.adoc

@@ -0,0 +1,20 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="installing-the-ovirt-plugin"]
+= Installing the oVirt plugin
+
+[role="_abstract"]
+Install the oVirt plugin to attach an oVirt compute resource provider to {Project}.
+This allows you to manage and deploy hosts to oVirt.
+
+.Procedure
+* On your {ProjectServer}, install the oVirt plugin:
++
+[options="nowrap", subs="+quotes,verbatim,attributes"]
+----
+# {foreman-installer} --enable-foreman-plugin-ovirt
+----
+
+.Verification
+. In the {ProjectWebUI}, navigate to *Administer* > *About*.
+. On the *Compute resources* tab, verify the installation of the oVirt plugin.

guides/common/modules/proc_preparing-cloud-init-images-in-ovirt.adoc

@@ -0,0 +1,52 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="preparing-cloud-init-images-in-ovirt"]
+= Preparing cloud-init images in oVirt
+
+[role="_abstract"]
+To use `cloud-init` during provisioning, you must prepare an image with `cloud-init` installed in oVirt, and then import the image to {Project} to use for provisioning.
+
+.Procedure
+. In oVirt, create a virtual machine to use for image-based provisioning in {Project}.
+. On the virtual machine, install `cloud-init`:
++
+ifdef::satellite[]
+[options="nowrap" subs="+quotes,attributes"]
+----
+# {client-package-install-el8} cloud-init
+----
+endif::[]
+ifndef::orcharhino,satellite[]
+** On Debian or Ubuntu:
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+# {client-package-install-deb} cloud-init
+----
+** On {EL} 8+:
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+# {client-package-install-el8} cloud-init
+----
+** On OpenSUSE and {SLES}:
++
+[options="nowrap" subs="+quotes,attributes"]
+----
+# {client-package-install-sles} cloud-init
+----
+endif::[]
+ifdef::orcharhino[]
+[options="nowrap" subs="+quotes,attributes"]
+----
+# {client-package-install} cloud-init
+----
+endif::[]
+. To the `/etc/cloud/cloud.cfg` file, add the following information:
++
+----
+datasource_list: ["NoCloud", "ConfigDrive"]
+----
+. In oVirt, create an image from this virtual machine.
++
+When you add this image to {Project}, ensure that you select the *User Data* checkbox.

guides/common/modules/proc_using-novnc-to-access-virtual-machines.adoc

@@ -10,6 +10,9 @@ You can use your browser to access the VNC console of VMs created by {Project}.
 
 * VMware
 * Libvirt
+ifndef::satellite[]
+* oVirt
+endif::[]
 
 .Prerequisites
 * You have a virtual machine created by {Project}.

guides/common/modules/ref_prerequisites-for-ovirt-provisioning.adoc

@@ -0,0 +1,32 @@
+:_mod-docs-content-type: REFERENCE
+
+[id="prerequisites-for-ovirt-provisioning"]
+= Prerequisites for oVirt provisioning
+
+[role="_abstract"]
+Before you can provision cloud instances on oVirt, ensure that your environment meets the following requirements.
+
+include::snip_prerequisites-common-compute-resource.adoc[]
+* A {SmartProxyServer} managing a logical network on the oVirt environment.
+Ensure no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}.
+For more information, see {ProvisioningDocURL}preparing-networking-for-host-management[Preparing networking for host management] in _{ProvisioningDocTitle}_.
+* An existing template, other than the `blank` template, if you want to use image-based provisioning.
+For more information about creating templates for virtual machines, see https://www.ovirt.org/documentation/virtual_machine_management_guide/#chap-Templates[Templates] in the oVirt documentation.
+* An administration-like user on oVirt for communication with {ProjectServer}.
+Do not use the `admin@internal` user for this communication.
+Instead, create a new oVirt user with the following permissions:
+** *System* > *Configure System* > *Login Permissions*
+** *Network* > *Configure vNIC Profile* > *Create*
+** *Network* > *Configure vNIC Profile* > *Edit Properties*
+** *Network* > *Configure vNIC Profile* > *Delete*
+** *Network* > *Configure vNIC Profile* > *Assign vNIC Profile to VM*
+** *Network* > *Configure vNIC Profile* > *Assign vNIC Profile to Template*
+** *Template* > *Provisioning Operations* > *Import/Export*
+** *VM* > *Provisioning Operations* > *Create*
+** *VM* > *Provisioning Operations* > *Delete*
+** *VM* > *Provisioning Operations* > *Import/Export*
+** *VM* > *Provisioning Operations* > *Edit Storage*
+** *Disk* > *Provisioning Operations* > *Create*
+** *Disk* > *Disk Profile* > *Attach Disk Profile*
++
+For more information about how to create a user and add permissions in oVirt, see https://www.ovirt.org/documentation/administration_guide/#chap-Users_and_Roles[Users and Roles] in the oVirt documentation.

guides/common/modules/ref_supported-virtualization-infrastructures.adoc

@@ -9,6 +9,7 @@ You can connect the following virtualization infrastructures as compute resource
 * KVM (libvirt)
 * VMware
 ifndef::satellite[]
+* oVirt
 * Proxmox
 endif::[]
 ifndef::orcharhino[]

guides/common/modules/snip_steps-create-a-host-tab-interfaces.adoc

@@ -10,7 +10,7 @@ ifdef::using-pxe-to-provision-hosts,using-network-boot-to-provision-hosts[]
 * In the *MAC address* field, enter a MAC address of the provisioning interface of the host.
 This ensures the identification of the host during the PXE boot process.
 endif::[]
-ifdef::azure-provisioning,gce-provisioning,openstack-provisioning,ec2-provisioning,kvm-provisioning,vmware-provisioning,proxmox-provisioning[]
+ifdef::azure-provisioning,gce-provisioning,openstack-provisioning,ec2-provisioning,kvm-provisioning,ovirt-provisioning,vmware-provisioning,proxmox-provisioning[]
 * Ensure that the *MAC address* field is blank.
 {compute-resource} assigns a MAC address to the host during provisioning.
 endif::[]