Features/OpenStack using libguestfs

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...")
 
(initial revision)
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.'''}}
+
= Feature Name =
 
+
OpenStack using libguestfs
{{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}}
+
 
+
{{admon/note | All sections of this template are required for review by FESCo.  If any sections are empty it will not be reviewed }}
+
 
+
 
+
<!-- All fields on this form are required to be accepted by FESCo.
+
We also request that you maintain the same order of sections so that all of the feature pages are uniform.  -->
+
 
+
<!-- The actual name of your feature page should look something like: Features/YourFeatureName.  This keeps all features in the same namespace -->
+
 
+
= Feature Name <!-- The name of your feature --> =
+
  
 
== Summary ==
 
== Summary ==
<!-- 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. -->
+
Expand the operations and formats of virtual disk images supported by openstack, by using libguestfs
  
 
== Owner ==
 
== Owner ==
<!--This should link to your home wiki page so we know who you are-->
+
* Name: [[User:pbrady| Pádraig Brady]], [[User:rjones| Richard Jones]]
* Name: [[User:FASAcountName| Your Name]]
+
* Email: pbrady@redhat.com, rjones@redhat.com
 
+
<!-- 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-->
+
* Email: <your email address so we can contact you, invite you to meetings, etc.>
+
  
 
== Current status ==
 
== Current status ==
* Targeted release: [[Releases/<number> | Fedora <number> ]]  
+
* Targeted release: [Fedora 17]  
* Last updated: (DATE)
+
* Last updated: 20 Dec 2011
* Percentage of completion: XX%
+
* Percentage of completion: 100%
 
+
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
+
  
 
== Detailed Description ==
 
== Detailed Description ==
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
+
libguestfs supports many virtual disk formats and has support for operations like resizing and file injection,
 +
that is useful to opesntack, which is currently limited to raw or qcow images.
  
 
== 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?-->
+
Expanding the range of virtual disk images, makes Fedora a more attractive platform for openstack development and deployment.
 +
It also aligns with RHEL 6 which doesn't support the default openstack virt image access method (qmeu-nbd)
  
 
== 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?-->
+
The change is isolated to the openstack-nova package.
  
 
== 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.  
+
The openstack file injection logic that uses libguestfs is triggered when a VM instance is created.
 +
So the easiest thing is to follow the [[Test_Day:2011-10-20_OpenStack_Test_Day]] up to and including
 +
[[http://fedoraproject.org/wiki/QA:Testcase_launch_an_instance_on_OpenStack]] and verify that
 +
the ssh keys have been inserted.
  
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.
+
For low level testing of this specific logic one can do this:
  
A good "how to test" should answer these four questions:
+
    runuser -s /bin/bash nova -c "python"
 +
    from nova.virt import disk
 +
    def _(string): return string #To avoid gettext issues at interactive prompt
 +
    disk.inject_data("/path/to/a/virtual/disk/image")
  
0. What special hardware / data / etc. is needed (if any)?
+
Note doing the above within a VM is support, albeit slower.
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. -->
+
There is no interface change to the the user.
  
 
== 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)? -->
+
The feature depends on libguestfs-mount which is already available.
 +
Any issues requiring updates to that package are avoided.
  
 
== 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.  -->
 
<!-- 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.  -->
 +
None necessary.
  
 
== 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. -->
 
<!-- 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. -->
*
+
There is no user visible change, hence no documentation change required.
 +
For completeness here are the 2 upstream commits:
 +
 
 +
https://review.openstack.org/gitweb?p=openstack%2Fnova.git;a=commit;h=f97c6652
 +
 
 +
https://review.openstack.org/gitweb?p=openstack%2Fnova.git;a=commit;h=66348596
  
 
== 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 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. -->
 
<!-- 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. -->
*
+
* Openstack; Expanded support for virtual disk image formats
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
* 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 -->
+
* See [[Talk:Features/OpenStack_using_libguestfs]]  <!-- 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 -->
  
  

Revision as of 12:33, 20 December 2011

Contents

Feature Name

OpenStack using libguestfs

Summary

Expand the operations and formats of virtual disk images supported by openstack, by using libguestfs

Owner

Current status

  • Targeted release: [Fedora 17]
  • Last updated: 20 Dec 2011
  • Percentage of completion: 100%

Detailed Description

libguestfs supports many virtual disk formats and has support for operations like resizing and file injection, that is useful to opesntack, which is currently limited to raw or qcow images.

Benefit to Fedora

Expanding the range of virtual disk images, makes Fedora a more attractive platform for openstack development and deployment. It also aligns with RHEL 6 which doesn't support the default openstack virt image access method (qmeu-nbd)

Scope

The change is isolated to the openstack-nova package.

How To Test

The openstack file injection logic that uses libguestfs is triggered when a VM instance is created. So the easiest thing is to follow the Test_Day:2011-10-20_OpenStack_Test_Day up to and including [[1]] and verify that the ssh keys have been inserted.

For low level testing of this specific logic one can do this:

   runuser -s /bin/bash nova -c "python"
   from nova.virt import disk
   def _(string): return string #To avoid gettext issues at interactive prompt
   disk.inject_data("/path/to/a/virtual/disk/image")

Note doing the above within a VM is support, albeit slower.

User Experience

There is no interface change to the the user.

Dependencies

The feature depends on libguestfs-mount which is already available. Any issues requiring updates to that package are avoided.

Contingency Plan

None necessary.

Documentation

There is no user visible change, hence no documentation change required. For completeness here are the 2 upstream commits:

https://review.openstack.org/gitweb?p=openstack%2Fnova.git;a=commit;h=f97c6652

https://review.openstack.org/gitweb?p=openstack%2Fnova.git;a=commit;h=66348596

Release Notes

  • Openstack; Expanded support for virtual disk image formats

Comments and Discussion