Features/Virt-manager Guest Inspection

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(Created page with "{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To rea...")
 
(Explain what packages are needed)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section.  They are invisible when viewing this page.  To read it, choose the "edit" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR FEATURE.'''}}
+
= Virt-manager Guest Inspection =
  
{{admon/important | Set a Page Watch| Make sure you click ''watch'' on your new page so that you are notified of changes to it by others, including the Feature Wrangler}}
+
== Summary ==
  
{{admon/note | All sections of this template are required for review by FESCo. If any sections are empty it will not be reviewed }}
+
[[File:Virt-manager-vmm-icons.png|right|thumb|x200px]] [[File:Virt-manager-vmm-details.png|right|thumb|x200px]] Virt-manager displays the operating system and applications within a guest, and allows the filesystems and Windows Registry of a guest to be browsed (read-only).
  
 +
== Owner ==
  
<!-- All fields on this form are required to be accepted by FESCo.
+
* Name: [[User:Rjones| Richard W.M. Jones]]
We also request that you maintain the same order of sections so that all of the feature pages are uniform. -->
+
* Name: [[User:Crobinso | Cole Robinson]]
  
<!-- The actual name of your feature page should look something like: Features/YourFeatureName. This keeps all features in the same namespace -->
+
* Email: rjones@redhat.com,crobinso@redhat.com
  
= Feature Name <!-- The name of your feature --> =
+
== Current status ==
 +
* Targeted release: [[Releases/16 | Fedora 16 ]]
 +
* Last updated: 2011-09-19
 +
* Percentage of completion: 100% (complete)
  
== Summary ==
+
== Detailed Description ==
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
+
  
== Owner ==
+
We are adding several related features to virt-manager, all revolving around what we call [http://libguestfs.org/virt-inspector.1.html guest inspection].
<!--This should link to your home wiki page so we know who you are-->
+
* Name: [[User:FASAcountName| Your Name]]
+
  
<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved-->
+
The first is that virt-manager will display operating system icons next to each guest in the main window. [https://rwmj.wordpress.com/2011/06/29/virt-manager-with-icons/#content Screenshot] [http://lists.fedoraproject.org/pipermail/legal/2011-April/001615.html Resolution of legal issues]
* Email: <your email address so we can contact you, invite you to meetings, etc.>
+
  
== Current status ==
+
The second is that in the virt-manager "details" window we display extra details.  In particular the name of the installed operating system and the list of applications.  [https://rwmj.wordpress.com/2011/06/30/virt-manager-operating-system-and-list-of-applications/#content Screenshot]
* Targeted release: [[Releases/<number> | Fedora <number> ]]
+
* Last updated: (DATE)
+
* Percentage of completion: XX%
+
  
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
+
The third is that there will be a button in virt-manager which will let you open up the guest filesystem and browse it graphically. For graphical browsing, this will be read-only.  [http://people.redhat.com/~rjones/guestfs-browser/ Screenshot]
  
== Detailed Description ==
+
The fourth is that you will be able to browse (read-only) into Windows Registry entries[http://people.redhat.com/~rjones/guestfs-browser/ Screenshot]
<!-- Expand on the summary, if appropriateA couple sentences suffices to explain the goal, but the more details you can provide the better. -->
+
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
+
 
 +
This is as far as we know a completely unique feature, that even other KVM-based Linux distros won't have for a while, and certainly no other hypervisor has.
  
 
== Scope ==
 
== Scope ==
<!-- What work do the developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+
 
 +
This change is isolated to the components affected, which are:
 +
 
 +
* virt-manager
 +
** <s>patch virt-manager to add inspection thread</s> (done 2011-07-18)
 +
** <s>patch virt-manager to avoid unreadable disks</s> (done 2011-08-09)
 +
** patch virt-manager to store icon data locally (probably going to skip this)
 +
** <s>push virt-manager changes to Rawhide</s>
 +
* <s>libguestfs >= 1.12.0 (future stable release)</s>
 +
** <s>release libguestfs 1.12.0 in Rawhide</s>
 +
* <s>guestfs-browser needs to be added ([https://bugzilla.redhat.com/show_bug.cgi?id=669911 bug 669911])</s>
 +
** <s>complete the package review of guestfs-browser</s>
 +
** <s>add package to Rawhide</s>
 +
** patch virt-manager to allow guestfs-browser to be launched (deferred &mdash; you can use the main menu instead)
  
 
== How To Test ==
 
== How To Test ==
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
 
  
Remember that you are writing this how to for interested testers to use to check out your feature - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your feature.
+
No special hardware is required to test this.
  
A good "how to test" should answer these four questions:
+
Users will need to have compatible KVM virtual machines installed, and be using libvirt.  Almost any Linux or Windows guest should be compatible.  FreeBSD, Solaris, etc. guests cannot be inspected at this time, although their presence should not affect inspection of other guests.
  
0. What special hardware / data / etc. is needed (if any)?
+
The user will simply need to run virt-manager, and make sure python-guestfs package is installed.  After a short period of time, icons will appear in the main window, and when clicking into the "details" window, the other features will be seen.
1. How do I prepare my system to test this feature? What packages
+
need to be installed, config files edited, etc.?
+
2. What specific actions do I perform to check that the feature is
+
working like it's supposed to?
+
3. What are the expected results of those actions?
+
-->
+
  
 
== User Experience ==
 
== User Experience ==
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
+
 
 +
Users will have a richer experience in virt-manager.
  
 
== Dependencies ==
 
== Dependencies ==
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
+
 
 +
None.
  
 
== Contingency Plan ==
 
== Contingency Plan ==
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
+
 
 +
We will revert back to the earlier version of virt-manager, or we will disable the inspection code before release.
  
 
== Documentation ==
 
== Documentation ==
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
+
 
*
+
* http://libguestfs.org/virt-inspector.1.html
 +
* http://people.redhat.com/~rjones/guestfs-browser/
 +
 
 +
Patches are posted and discussed on the [https://www.redhat.com/archives/virt-tools-list/ virt-tools mailing list].
  
 
== Release Notes ==
 
== Release Notes ==
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
*
 
  
== Comments and Discussion ==
+
virt-manager can now examine a virtual machine to determine the version of the operating system and what applications are installed.
* See [[Talk:Features/YourFeatureName]]  <!-- This adds a link to the "discussion" tab associated with your page. This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
+
  
 +
== Comments and Discussion ==
 +
* See [[Talk:Features/Virt-manager Guest Inspection]]
  
[[Category:FeaturePageIncomplete]]
+
[[Category:FeatureAcceptedF16]]
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 10:47, 12 October 2011

Contents

[edit] Virt-manager Guest Inspection

[edit] Summary

Virt-manager-vmm-icons.png
Virt-manager-vmm-details.png
Virt-manager displays the operating system and applications within a guest, and allows the filesystems and Windows Registry of a guest to be browsed (read-only).

[edit] Owner

  • Email: rjones@redhat.com,crobinso@redhat.com

[edit] Current status

  • Targeted release: Fedora 16
  • Last updated: 2011-09-19
  • Percentage of completion: 100% (complete)

[edit] Detailed Description

We are adding several related features to virt-manager, all revolving around what we call guest inspection.

The first is that virt-manager will display operating system icons next to each guest in the main window. Screenshot Resolution of legal issues

The second is that in the virt-manager "details" window we display extra details. In particular the name of the installed operating system and the list of applications. Screenshot

The third is that there will be a button in virt-manager which will let you open up the guest filesystem and browse it graphically. For graphical browsing, this will be read-only. Screenshot

The fourth is that you will be able to browse (read-only) into Windows Registry entries. Screenshot

[edit] Benefit to Fedora

This is as far as we know a completely unique feature, that even other KVM-based Linux distros won't have for a while, and certainly no other hypervisor has.

[edit] Scope

This change is isolated to the components affected, which are:

  • virt-manager
    • patch virt-manager to add inspection thread (done 2011-07-18)
    • patch virt-manager to avoid unreadable disks (done 2011-08-09)
    • patch virt-manager to store icon data locally (probably going to skip this)
    • push virt-manager changes to Rawhide
  • libguestfs >= 1.12.0 (future stable release)
    • release libguestfs 1.12.0 in Rawhide
  • guestfs-browser needs to be added (bug 669911)
    • complete the package review of guestfs-browser
    • add package to Rawhide
    • patch virt-manager to allow guestfs-browser to be launched (deferred — you can use the main menu instead)

[edit] How To Test

No special hardware is required to test this.

Users will need to have compatible KVM virtual machines installed, and be using libvirt. Almost any Linux or Windows guest should be compatible. FreeBSD, Solaris, etc. guests cannot be inspected at this time, although their presence should not affect inspection of other guests.

The user will simply need to run virt-manager, and make sure python-guestfs package is installed. After a short period of time, icons will appear in the main window, and when clicking into the "details" window, the other features will be seen.

[edit] User Experience

Users will have a richer experience in virt-manager.

[edit] Dependencies

None.

[edit] Contingency Plan

We will revert back to the earlier version of virt-manager, or we will disable the inspection code before release.

[edit] Documentation

Patches are posted and discussed on the virt-tools mailing list.

[edit] Release Notes

virt-manager can now examine a virtual machine to determine the version of the operating system and what applications are installed.

[edit] Comments and Discussion