Bug 1085786 - No Run Once specific documentation exists
Summary: No Run Once specific documentation exists
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.4.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ---
Assignee: Andrew Dahms
QA Contact: Julie
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-04-09 11:11 UTC by Jiri Belka
Modified: 2014-07-23 01:31 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-07-23 01:31:40 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Jiri Belka 2014-04-09 11:11:51 UTC
Description of problem:

There is no specific documentation about Run Once dialog. I expect if (?) icon would work (BZ1085762) it would open /docs/manual/en_US/html/Administration_Guide/sect-Running_Virtual_Machines.html But this page does not explain anything about Run Once dialog. For example I can't find (in fact I don't remember) what 'iso://' means in Linux Boot Options.

It is not even explained in /docs/manual/en_US/html/Administration_Guide/Virtual_Machine_Boot_Options_settings_explained.html

So... extend Virtual_Machine_Boot_Options_settings_explained.html and make (?) in Run Once dialog to point to a page which would explain options in this dialog.

Version-Release number of selected component (if applicable):
av6 / rhevm-doc-3.4.0-2.el6eng.noarch

How reproducible:
supposition for (?) / 100% for Virtual_Machine_Boot_Options_settings_explained.html

Steps to Reproduce:
1. click (?) in Run Once / check Virtual_Machine_Boot_Options_settings_explained.html
2.
3.

Actual results:
no details about Run Once options

Expected results:
documentation should talk about these specific options

Additional info:

Comment 1 Andrew Dahms 2014-04-09 22:19:03 UTC
Hi Jiri,

Thank you for raising this bug.

A description of the options in the run once dialog can be found here: https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.4-Beta/html-single/Administration_Guide/index.html#Virtual_Machine_Run_Once_settings_explained

I can confirm that the (?) icon is not working in the Run Virtual Machine(s) dialog at the moment. This issue is an engineering-related issue so I cannot address it myself, but a link has been provided for that (?) icon so if the backend functionality is addressed it should point to the relevant section in the documentation.

As for the content itself, would you be able to refer to the link above and let me know if you feel any details are missing? There is a short description of the purpose of the 'iso://' string in Linux Boot Options, but if you feel it is unclear or feel that additional information is necessary, I would be happy to review the section for you.

Kind regards,

Andrew

Comment 2 Jiri Belka 2014-04-10 09:09:10 UTC
Thanks you. Thus you can close the BZ. The doc looks good, just little nitpicking.

> Run Stateless - Deletes all changes to the virtual machine upon shutdown. 

I would add that this needs a VM with disk. This is how I understand the functionality.

> SPICE - Recommended protocol for Linux and Windows virtual machines, excepting
> Windows 8 and Server 2012 virtual machines.

Strange, why do you prevent defining SPICE in VM properties but we allow it in Run Once. Seems odd. I will ask if this is bug or (odd) feature.

Comment 3 Michal Skrivanek 2014-04-10 10:19:26 UTC
> Strange, why do you prevent defining SPICE in VM properties but we allow it in Run Once. Seems odd. I will ask if this is bug or (odd) feature

well, I'd say a bug. But it gives you a possibility to give it a try…so maybe let's keep it as a little odd feature:)

Comment 4 Michal Skrivanek 2014-04-11 06:34:33 UTC
bug 1067561 should fix it, actually

Comment 5 Andrew Dahms 2014-04-13 22:20:02 UTC
Hi Jiri,

Thank you for taking a look at the documentation and letting me know how it fits your needs!
I'll use this bug to add a line about stateless virtual machines and make sure that aspect of its functionality is clear.

Thank you for your input on this one, Michal - much appreciated!

Kind regards,

Andrew

Comment 6 Andrew Dahms 2014-04-14 02:37:37 UTC
Revised 10821.

Comment 7 Andrew Dahms 2014-04-15 06:27:39 UTC
Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.4/html-single/Administration_Guide/index.html#Virtual_Machine_Run_Once_settings_explained

What Changed
------------------------------
The following topic was revised to add a line stating that the 'Run Stateless' is only available to virtual machines to which disks have been attached.

Virtual Machine Run Once Settings Explained [10821-630974]

Updated revision history: [30102-630975]

NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Administration_Guide-3.4-en-US-3.4-19

Moving to ON_QA.

Comment 8 Julie 2014-07-23 01:31:40 UTC
Verified changed in the current release.


Note You need to log in before you can comment on or make changes to this bug.