Bug 1894051

Summary:	[v2v][Testday][Doc][VM import from RHV to CNV] Add details on how the RHV VM ID can be fetched
Product:	Container Native Virtualization (CNV)	Reporter:	Ilanit Stein <istein>
Component:	Documentation	Assignee:	Avital Pinnick <apinnick>
Status:	CLOSED NEXTRELEASE	QA Contact:	Ilanit Stein <istein>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	2.5.0	CC:	apinnick, cnv-qe-bugs, dagur
Target Milestone:	---
Target Release:	2.5.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-11-16 10:06:54 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Ilanit Stein 2020-11-03 12:46:54 UTC

Document URL: 
virt-importing-rhv-vm 

Section Number and Name: 
Importing a Red Hat Virtualization virtual machine with the CLI

This VM id can be used by the CLI commands 
Please add details on how to fetch RHV VM ID.

How to fetch VM ID:
Option 1. In RHV webadmin go to VMs page, and clik the relevant VM.
In the VM general tab the VM ID should be displayed.
 
Option 2. Navigate to https://<RHV FQDN/ovirt-engine/api/vms/
look for the relevant VM - It's ID should be mentioned.
An example of RHV VM ID: 80554327-0569-496b-bdeb-fcbbf52b827b

Additional information:
** This bug was reported during the "Migration to Openshift Virtualization Test day" on Oct 20 2020.

Comment 5 Ilanit Stein 2020-11-10 09:35:23 UTC

Thanks Avital,


I checked the links in the PR:

1. VM ID -
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Virtual_Machine_General_settings_explained

The link do not point from where RHV VM ID can be fetched. 
Please either replace with a link that point to that, 
or mention that:
It can be fetched from webadmin, VM windows, General tab,
or via Rest API, https://<RHV FQDN>/ovirt-engine/api/vms/ - that list all the RHV VMs and their VM ID.

Maybe this ^^ can be added to RHV admin guide, if it's not there, and then we can link from OCP VM import doc to it.

2. Disk ID - 
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide/index#Understanding_virtual_disks

This link brings to the RHV admin guide start page, and not to the disks section. 
Please replace it with a correct link, or provide details on where it is displayed:
RHV webadmin, Disks tab, pick the disk that is attached to the imported VM.
or via RHV Rest API  https://<RHV FQDN>/ovirt-engine/api/vms/<VM ID>
will show details on the VM's disks, such as disk ID.

Comment 6 Avital Pinnick 2020-11-10 12:08:03 UTC

(In reply to Ilanit Stein from comment #5)
> Thanks Avital,
> 
> 
> I checked the links in the PR:
> 
> 1. VM ID -
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/
> html-single/virtual_machine_management_guide/
> index#Virtual_Machine_General_settings_explained
> 
> The link do not point from where RHV VM ID can be fetched. 

The VM ID description is in a table called "Virtual Machine: General settings"

The user will know where VM general settings are. There is no explanation of how to access each setting because it is covered by "Editing virtual machines". (https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#chap-Editing_Virtual_Machines)

> Please either replace with a link that point to that, 
> or mention that:
> It can be fetched from webadmin, VM windows, General tab,
> or via Rest API, https://<RHV FQDN>/ovirt-engine/api/vms/ - that list all
> the RHV VMs and their VM ID.

This is beyond the scope of CNV docs, however.

> 
> Maybe this ^^ can be added to RHV admin guide, if it's not there, and then
> we can link from OCP VM import doc to it.

You could try creating a BZ but I doubt the RHV docs team would want to add it. Accessing the properties of a VM is a basic admin task. The Administration Guide does not document every setting that the user could encounter because many are self-explanatory.

> 
> 2. Disk ID - 
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/
> html-single/administration_guide/index#Understanding_virtual_disks
> 
> This link brings to the RHV admin guide start page, and not to the disks
> section. 

In Firefox, the link points to the disks section. In Chrome, the link does not render properly.

> Please replace it with a correct link, or provide details on where it is
> displayed:
> RHV webadmin, Disks tab, pick the disk that is attached to the imported VM.
> or via RHV Rest API  https://<RHV FQDN>/ovirt-engine/api/vms/<VM ID>
> will show details on the VM's disks, such as disk ID.

I am willing to add the API calls. It would not be appropriate for us to duplicate RHV documentation in CNV docs, so I do not want to add a procedure.

Comment 8 Ilanit Stein 2020-11-10 16:40:51 UTC

Last PR looks good to me. The RHV api calls are a good source to get the vM details. 
Moving to Verified.

Comment 10 Avital Pinnick 2020-11-16 10:06:54 UTC

Changes merged