From Fedora Project Wiki
mNo edit summary
mNo edit summary
 
(10 intermediate revisions by 4 users not shown)
Line 2: Line 2:


== Summary ==
== Summary ==
Spice aims to provide a complete open source solution for interaction with virtualized desktops.
Spice aims to provide a complete open source solution for interaction with remote (virtualized) desktops.


This feature brings Spice 0.10 to Fedora 16.
This feature brings Spice 0.10 to Fedora 16.
Line 12: Line 12:
== Current status ==
== Current status ==
* Targeted release: [[Releases/16 | Fedora 16 ]]  
* Targeted release: [[Releases/16 | Fedora 16 ]]  
* Last updated: 2010-07-12
* Last updated: 2010-11-3
* Percentage of completion: 5%
* Percentage of completion: 100%
<!--
Changing it to 100% since the features are available.
Spice 0.10 is still to be released.
We will update spice fedora package when that happens.
-->


== Detailed Description ==
== Detailed Description ==
The Spice project deals with both the virtualized devices and the front-end.
The Simple Protocol for Independent Computing Environments (SPICE) is used for client-server communication. Spice adds a QXL display device to QEMU and provides drivers for this device for both X and Windows.
 
Currently, the project main focus is to provide high-quality remote access to QEMU virtual machines. The Simple Protocol for Independent Computing Environments (SPICE) is used for client-server communication. Spice adds a QXL display device to QEMU and provides
drivers for this device for both X and Windows.


Features supported in the protocol are:
Spice was added in Fedora 14 [ https://fedoraproject.org/wiki/Features/Spice ]
* Accelerated 2D graphics
Other spice related components were added later (spice-vdagent, spice-gtk)
* "Hardware" cursor support
* Audio playing
* Audio recording
* Image compression, both lossless and lossy (for WAN support)
* Video detection with MJpeg streaming
* Encryption
* Client side mouse pointer support
* Drivers for: X, Windows (xp, win7 -- not in Fedora)
 
Red Hat acquired Spice together with kvm when it aqcuired Qumranet, and has invested significant effort into opening it up, cleaning up dependencies, etc.


New features in Release 0.10 are:
New features in Release 0.10 are:
* Usb sharing between guest and client (letting the guest access USB devices on the client)
* Usb sharing between guest and client (letting the guest access USB devices on the client), see: http://fedoraproject.org/wiki/Features/UsbNetworkRedirection
** https://fedoraproject.org/wiki/Features/UsbNetworkRedirection
* Audio Volume messages between guest and client
* New package xspice (xorg-x11-server-Xspice), this provides a standalone X and Spice server, see: [http://www.spice-space.org/page/Features/XSpice spice-space]


== Benefit to Fedora ==
== Benefit to Fedora ==
Line 43: Line 36:


== 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?-->
* Spice support was added in Fedora 14 (as well as dependent packages, such as spice-protocol, celt051).
* Spice support was added in Fedora 14 (as well as dependent packages, such as spice-protocol, celt051).
* Upon Spice 0.10 availability, there is some Fedora packaging work to be done.
* Upon Spice 0.10 availability, there is some Fedora packaging work to be done:
* Need to update spice-protocol package.
** Need to update spice-protocol package (done).
* Need to update spice-server pacakge.
** Need to update spice package (done).
* Need to update spice-client package.
<!--
 
<!-- Do we need theses packages too ?
* Need to update spice-gtk package (would that be in a different Feature?)
* Need to update spice-gtk package (would that be in a different Feature?)
* Need to update xorg-x11-drv-qxl package (?)
* Need to update xorg-x11-drv-qxl package (?) HDG: nice to have, all changes in upstream are related to xspice, and not to the x11 qxl driver
* Need to update spice-vdagent package (?)
* Need to update spice-vdagent package (?) HDG: no interesting spice-vdagent changes are pending, so I don't think so.
-->
-->


== 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 server part of Spice requires a x86-64 machine, and ideally should have hardware virtualization support (kvm) although this is not strictly required.


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.
The client currently works on x86-64 and x86, but we're working on porting it to more architectures.  


A good "how to test" should answer these four questions:
To test spice:
* Use virt-manager to create a VM with Spice support.
* Run virt-viewer to access it via Spice, Or
* Use vinagre to access your VM.


0. What special hardware / data / etc. is needed (if any)?
Alternatively:
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?
-->
 
The server part of Spice requires a x86-64 machine, and ideally should have hardware virtualization support (kvm) although this is not strictly required.
 
The client currently works on x86-64 and x86, but we're working on porting it to more architectures.


To test spice, install a qemu with spice support and spice-server on the server machine (aka host), then start qemu with options something like this:
Install a qemu and spice-server on the server machine (aka host), then start qemu with options something like this:
   qemu <disk-image> -usb -soundhw ac97 -vga qxl -spice port=5930,disable-ticketing -enable-kvm -m 1024 -monitor stdio
   qemu <disk-image> -usb -soundhw ac97 -vga qxl -spice port=5930,disable-ticketing -enable-kvm -m 1024 -monitor stdio
or with passwords:
or with passwords:
   qemu <disk-image> -usb -soundhw ac97 -vga qxl -spice port=5930,password=<secret> -enable-kvm -m 1024 -monitor stdio
   qemu <disk-image> -usb -soundhw ac97 -vga qxl -spice port=5930,password=<secret> -enable-kvm -m 1024 -monitor stdio


On the client, install the spice-client package and start it like:
On the client (can be the same machine), install the spice-client package and start it like:
   spicec -h <server> -p <port> [-w <secret>], e.g.
   spicec -h <server> -p <port> [-w <secret>], e.g.
   spicec -h localhost -p 5930
   spicec -h localhost -p 5930
Line 86: Line 69:
This should let you access the machine. You should now install the qxl driver and optionally the agent on the guest. If you do not do this you're running in vga mode which is quite slow and inefficient.
This should let you access the machine. You should now install the qxl driver and optionally the agent on the guest. If you do not do this you're running in vga mode which is quite slow and inefficient.


Alternatively:
=== XSpice ===
* Use virt-manager to create a VM with Spice support.
XSpice is a standalone X server. To launch it without any password protection on port 9999 with display :2.0:
* Run virt-viewer to access it via Spice, Or
  xspice --port 9999 --disable-ticketing :2.0
* Use vinagre to access your VM.
 
See xspice --help for other options.
 
In a seperate terminal you can run X clients under it:
  DISPLAY=:2.0 icewm
  DISPLAY=:2.0 gnome-terminal
  DISPLAY=:2.0 firefox
 
Connect a standard spice client to the server to get the display, keyboard and mouse:
  spicec -h localhost -p 9999


== 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. -->
Spice is already available in Fedora 15.
Spice is already available in F15.


The new USB sharing feature enables users to share (simple, usb1) usb devices (such as usb-disk) plugged in the client machine with the guest.
The new USB sharing feature enables users to share (simple, usb1) usb devices (such as usb-disk) plugged in the client machine with the guest.


== 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)? -->
* qemu
* qemu
<!-- * spice-gtk? -->
<!-- * a usb remoting package ? -->


== 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.  -->
Do not update Spice to 0.10, stay with current version (0.8).
Do not update Spice to 0.10, stay with current version (0.8).


Line 116: Line 101:


== 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/ -->
Fedora 16 includes the latest version of the spice remote virtualized desktop protocol stack, compared to
<!-- 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. -->
spice-0.8 the following features were added:
* Spice now supports client-guest USB sharing.
* Audio volume synchronisation between guest and client
* Spice now supports client-guest USB sharing
* A new XSpice X-server which allows using the spice protocol without a virtual-machine


== Comments and Discussion ==
== Comments and Discussion ==
* See [[Talk:Features/Spice]] <!-- 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/Spice]]


 
[[Category: FeatureAcceptedF16]]
[[Category: FeaturePageIncomplete]]
<!--
<!--
  [[Category:F16 Virt Features]]
  [[Category:F16 Virt Features]]
-->
-->
<!-- When your feature page is completed and ready for review -->
<!-- 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-->
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 13:47, 6 November 2011

Spice

Summary

Spice aims to provide a complete open source solution for interaction with remote (virtualized) desktops.

This feature brings Spice 0.10 to Fedora 16.

Owner

Current status

  • Targeted release: Fedora 16
  • Last updated: 2010-11-3
  • Percentage of completion: 100%

Detailed Description

The Simple Protocol for Independent Computing Environments (SPICE) is used for client-server communication. Spice adds a QXL display device to QEMU and provides drivers for this device for both X and Windows.

Spice was added in Fedora 14 [ https://fedoraproject.org/wiki/Features/Spice ] Other spice related components were added later (spice-vdagent, spice-gtk)

New features in Release 0.10 are:

Benefit to Fedora

In the long term, Spice will let Fedora provide a better user experience in desktop virtualization. In the short term, Fedora gains an interesting new open-source technology that many people want to try out.

Scope

  • Spice support was added in Fedora 14 (as well as dependent packages, such as spice-protocol, celt051).
  • Upon Spice 0.10 availability, there is some Fedora packaging work to be done:
    • Need to update spice-protocol package (done).
    • Need to update spice package (done).

How To Test

The server part of Spice requires a x86-64 machine, and ideally should have hardware virtualization support (kvm) although this is not strictly required.

The client currently works on x86-64 and x86, but we're working on porting it to more architectures.

To test spice:

  • Use virt-manager to create a VM with Spice support.
  • Run virt-viewer to access it via Spice, Or
  • Use vinagre to access your VM.

Alternatively:

Install a qemu and spice-server on the server machine (aka host), then start qemu with options something like this: 

 qemu <disk-image> -usb -soundhw ac97 -vga qxl -spice port=5930,disable-ticketing -enable-kvm -m 1024 -monitor stdio

or with passwords: 

 qemu <disk-image> -usb -soundhw ac97 -vga qxl -spice port=5930,password=<secret> -enable-kvm -m 1024 -monitor stdio

On the client (can be the same machine), install the spice-client package and start it like: 

 spicec -h <server> -p <port> [-w <secret>], e.g.
 spicec -h localhost -p 5930

This should let you access the machine. You should now install the qxl driver and optionally the agent on the guest. If you do not do this you're running in vga mode which is quite slow and inefficient.

XSpice

XSpice is a standalone X server. To launch it without any password protection on port 9999 with display :2.0: 

 xspice --port 9999 --disable-ticketing :2.0

See xspice --help for other options.

In a seperate terminal you can run X clients under it: 

 DISPLAY=:2.0 icewm
 DISPLAY=:2.0 gnome-terminal
 DISPLAY=:2.0 firefox

Connect a standard spice client to the server to get the display, keyboard and mouse: 

 spicec -h localhost -p 9999

User Experience

Spice is already available in Fedora 15.

The new USB sharing feature enables users to share (simple, usb1) usb devices (such as usb-disk) plugged in the client machine with the guest.

Dependencies

  • qemu

Contingency Plan

Do not update Spice to 0.10, stay with current version (0.8).

Documentation

Release Notes

Fedora 16 includes the latest version of the spice remote virtualized desktop protocol stack, compared to spice-0.8 the following features were added:

  • Audio volume synchronisation between guest and client
  • Spice now supports client-guest USB sharing
  • A new XSpice X-server which allows using the spice protocol without a virtual-machine

Comments and Discussion

Retrieved from "https://fedoraproject.org/w/index.php?title=Features/F16Spice0.10&oldid=260161"