Difference between revisions of "Xen Document Days/TODO"

From Xen
(Clean-up in prep for docs day)
Line 4: Line 4:
  
 
{{Info|Feel free to comment on items using the following convention:
 
{{Info|Feel free to comment on items using the following convention:
<pre>* ~~~~: your comment</pre>
+
<pre>* {{Comment|~~~~:}} your comment</pre>
 
Feel free to add new workitems using the following convention:
 
Feel free to add new workitems using the following convention:
 
<pre>==== Workitem ===
 
<pre>==== Workitem ===
Line 15: Line 15:
 
* Which workloads work for which virt mode. Network considerations. NUMA. VCPU Pinning. Etc.
 
* Which workloads work for which virt mode. Network considerations. NUMA. VCPU Pinning. Etc.
 
* Examples from the KVM world: [http://sheepdog.taobao.org/people/zituan/kvm_tuning.html Guest perf tuning], [http://www.linux-kvm.org/page/Tuning_KVM KVM options affecting performance], [http://publib.boulder.ibm.com/infocenter/lnxinfo/v3r0m0/index.jsp?topic=%2Fliaat%2Fliaattunkickoff.htm Comprehensive guide covering pinning, caching, memory, huge pages, etc.]  
 
* Examples from the KVM world: [http://sheepdog.taobao.org/people/zituan/kvm_tuning.html Guest perf tuning], [http://www.linux-kvm.org/page/Tuning_KVM KVM options affecting performance], [http://publib.boulder.ibm.com/infocenter/lnxinfo/v3r0m0/index.jsp?topic=%2Fliaat%2Fliaattunkickoff.htm Comprehensive guide covering pinning, caching, memory, huge pages, etc.]  
* [[User:Lars.kurth|Lars.kurth]] 19:50, 25 June 2012 (UTC) : Work has been done on [[Tuning]]. Not sure whether more needs to be done.
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 19:50, 25 June 2012 (UTC):}} Work has been done on [[Tuning]]. Not sure whether more needs to be done.
* [[User:StefanoStabellini|Stefano]] 30 June 2012: The guide is in a decent state but I will keep improving it during the next doc days.
+
* {{Comment|[[User:StefanoStabellini|Stefano]] 30 June 2012:}} The guide is in a decent state but I will keep improving it during the next doc days.
* [[User:Lars.kurth|Lars.kurth]] 15:54, 19 September 2012 (UTC): Needs a quick sanity check for Xen 4.2
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 15:54, 19 September 2012 (UTC):}} Needs a quick sanity check for Xen 4.2
 +
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done?
 +
==== Document Policy on Maintenance Releases ====
 +
Which releases are supported, for how long. Owners. As well as a mechanism for individuals (or vendors) to take ownership of older releases (as is the case for Xen 3.4).
 +
* {{Comment|[[User:Ijc|Ijc]] 16:07, 26 November 2012 (UTC):}} Attempt to document current process: http://lists.xen.org/archives/html/xen-devel/2012-11/msg01389.html
 +
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done, see [[Xen_Maintenance_Releases]]?
 +
 
 +
==== Better Statements on Compatibility ====
 +
There seems to be some confusion in the wider Linxu community about XL/XM compatibility. Maybe some specific questions in an FAQ/the release notes. Also migration compatibility comes up often. Any articles related to compatibility should be listed in [[:Category:Compatibility]], which I am willing to clean up.
 +
* {{Comment|[[User:Anthony|Anthony]] 14:33, 26 November 2012 (UTC):}} I add a bunch of pages to the category, and add few link in the category to upgrade from xend to xl.
 +
* {{Comment|[[User:Anthony|Anthony]] 17:19, 26 November 2012 (UTC):}} I also redirect [[XL in Xen 4.2]] to [[XL]] as they had both the same content minus few things.
 +
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 12:48, 22 January 2013 (UTC):}} Is this done?
 +
 
 +
 
 
==== Better XCP Overview Documentation ====
 
==== Better XCP Overview Documentation ====
* [[User:Lars.kurth|Lars.kurth]] 08:02, 25 September 2012 (UTC) See [[XCP Overview]] & [[XCP Release Features]] - these need a little bit more work
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 08:02, 25 September 2012 (UTC):}} See [[XCP Overview]] & [[XCP Release Features]] - these need a little bit more work
  
 
=== Open work items ===
 
=== Open work items ===
Line 26: Line 39:
  
 
We should publish the key ids and fingerprints somewhere.
 
We should publish the key ids and fingerprints somewhere.
 
==== Document Policy on Maintenance Releases ====
 
Which releases are supported, for how long. Owners. As well as a mechanism for individuals (or vendors) to take ownership of older releases (as is the case for Xen 3.4).
 
* [[User:Ijc|Ijc]] 16:07, 26 November 2012 (UTC): Attempt to document current process: http://lists.xen.org/archives/html/xen-devel/2012-11/msg01389.html
 
 
==== Better Statements on Compatibility ====
 
There seems to be some confusion in the wider Linxu community about XL/XM compatibility. Maybe some specific questions in an FAQ/the release notes. Also migration compatibility comes up often. Any articles related to compatibility should be listed in [[:Category:Compatibility]], which I am willing to clean up.
 
* [[User:Anthony|Anthony]] 14:33, 26 November 2012 (UTC): I add a bunch of pages to the category, and add few link in the category to upgrade from xend to xl.
 
* [[User:Anthony|Anthony]] 17:19, 26 November 2012 (UTC): I also redirect [[XL in Xen 4.2]] to [[XL]] as they had both the same content minus few things.
 
  
 
==== UEFI Secure Boot ====
 
==== UEFI Secure Boot ====
Line 75: Line 79:
 
==== A Xen Security Guide ====
 
==== A Xen Security Guide ====
 
The different options in Xen for Security, trade-offs, how to set them up, how to test Xen for security and how to optimize for different scenarios
 
The different options in Xen for Security, trade-offs, how to set them up, how to test Xen for security and how to optimize for different scenarios
* [[User:Lars.kurth|Lars.kurth]] 09:48, 27 March 2012 (UTC): [[:Category:Security]] contains some security related docs
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 09:48, 27 March 2012 (UTC):}} [[:Category:Security]] contains some security related docs
* [[User:Lars.kurth|Lars.kurth]] 11:01, 4 April 2012 (UTC): It would be good if we could document a) XSM, b) Introspection API, c) Xen and SELinux in Dom0, d) Memory Access API (introduced in 4.1)
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 11:01, 4 April 2012 (UTC):}} It would be good if we could document a) XSM, b) Introspection API, c) Xen and SELinux in Dom0, d) Memory Access API (introduced in 4.1)
 
* User Docs that where migrating content would make sense and update such as (we can attach PDF's to the wiki now for starters, or we can use a [http://www.appropedia.org/Appropedia:Porting_PDF_files_to_MediaWiki conversion tool]
 
* User Docs that where migrating content would make sense and update such as (we can attach PDF's to the wiki now for starters, or we can use a [http://www.appropedia.org/Appropedia:Porting_PDF_files_to_MediaWiki conversion tool]
 
** http://bits.xensource.com/Xen/docs/user.pdf
 
** http://bits.xensource.com/Xen/docs/user.pdf
* [[User:Lars.kurth|Lars.kurth]] 15:59, 19 September 2012 (UTC): Some good articles came out of XenSummit NA (these can be built upon). Got funding to document XSM.
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 15:59, 19 September 2012 (UTC):}} Some good articles came out of XenSummit NA (these can be built upon). Got funding to document XSM; contract in place, but contractor is currently ill.
 
 
==== HOWTO setup a xenstore stubdomain ====
 
 
 
.
 
  
 
==== Review and Update: xenpm usage recommendations ====
 
==== Review and Update: xenpm usage recommendations ====
Line 96: Line 96:
 
==== HOWTO: Chain pypxeboot and pygrub====
 
==== HOWTO: Chain pypxeboot and pygrub====
 
How to chain [http://sourceforge.net/projects/pypxeboot/ pypxeboot] and pygrub  
 
How to chain [http://sourceforge.net/projects/pypxeboot/ pypxeboot] and pygrub  
* [[User:Lars.kurth|Lars.kurth]] 10:35, 27 March 2012 (UTC): Is pypxeboot popular at all?
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 10:35, 27 March 2012 (UTC):}} Is pypxeboot popular at all?
* [[User:Fheigl|Fheigl]] I added that. It is somewhat common, OVM 2 and OVM 3 rely on it for PXE installs. I'm not sure if xenpvnetboot is the same, or works. The use case is "you want to use the same installation server for Xen VMs and phys. servers. You  want to be able to reinstall them based on PXE reply.
+
* {{Comment|[[User:Fheigl|Fheigl]]:}} I added that. It is somewhat common, OVM 2 and OVM 3 rely on it for PXE installs. I'm not sure if xenpvnetboot is the same, or works. The use case is "you want to use the same installation server for Xen VMs and phys. servers. You  want to be able to reinstall them based on PXE reply.
* [[User:Fheigl|Fheigl]] There is documentation for pypxeboot, but there is no (afaik) documentation for how pygrub is used as a fallback loader. We wasted many days just to get some hack that can't even load a newer kernel. Which sucks, in the end you spend more time/money making PV PXE boot work than you save by using virtualized servers.
+
* {{Comment|[[User:Fheigl|Fheigl]]:}} There is documentation for pypxeboot, but there is no (afaik) documentation for how pygrub is used as a fallback loader. We wasted many days just to get some hack that can't even load a newer kernel. Which sucks, in the end you spend more time/money making PV PXE boot work than you save by using virtualized servers.
* [[User:Fheigl|Fheigl]] Q3: How could it be popular given the state of documentation. <= Key issue to the left of this sentence.
+
* {{Comment|[[User:Fheigl|Fheigl]]:}} How could it be popular given the state of documentation. <= Key issue to the left of this sentence.
* [[User:Lars.kurth|Lars.kurth]] 16:03, 19 September 2012 (UTC) : wondering whether [https://vimeo.com/46125332 this video] contains what is needed
+
* {{Comment|[[User:Lars.kurth|Lars.kurth]] 16:03, 19 September 2012 (UTC):}} wondering whether [https://vimeo.com/46125332 this video] contains what is needed
  
 
==== Updated docs for transition to git ====
 
==== Updated docs for transition to git ====
Line 121: Line 121:
 
* Review and update http://en.wikipedia.org/wiki/Xen - in particular the "Host: Unix-like systems" is out-of-date. The Guest section is too.
 
* Review and update http://en.wikipedia.org/wiki/Xen - in particular the "Host: Unix-like systems" is out-of-date. The Guest section is too.
 
* Make [[:Category:Host_Install|Host Install]] and [[:Category:Guest_Install|Guest Install]] more useful  
 
* Make [[:Category:Host_Install|Host Install]] and [[:Category:Guest_Install|Guest Install]] more useful  
** [[User:Lars.kurth|Lars.kurth]] Note: both pages share [[Template:Distro_Resources]]
+
** {{Comment|[[User:Lars.kurth|Lars.kurth]]:}} Note: both pages share [[Template:Distro_Resources]]
 
** Docs for many distros are missing: identify what docs are missing or out of date and put them on the todo list
 
** Docs for many distros are missing: identify what docs are missing or out of date and put them on the todo list
 
* Feature Status Doc : [[Xen_Release_Features]]
 
* Feature Status Doc : [[Xen_Release_Features]]
Line 139: Line 139:
 
* More PV protocol docs (see recent patches to blkif.h for example)
 
* More PV protocol docs (see recent patches to blkif.h for example)
 
* Document xenstore paths used by guests and toolstack etc
 
* Document xenstore paths used by guests and toolstack etc
** [[User:Ijc|Ijc]] 16:10, 26 November 2012 (UTC): This is now in tree: http://xenbits.xen.org/docs/unstable/misc/xenstore-paths.html
+
** {{Comment|[[User:Ijc|Ijc]] 16:10, 26 November 2012 (UTC):}} This is now in tree: http://xenbits.xen.org/docs/unstable/misc/xenstore-paths.html
  
 
== Wiki Maintenance ==
 
== Wiki Maintenance ==

Revision as of 12:48, 22 January 2013

Go back to Xen Document Days

Requested Documentation

Icon Info.png Feel free to comment on items using the following convention:
* {{Comment|~~~~:}} your comment

Feel free to add new workitems using the following convention:

==== Workitem ===
~~~~: work-item description


In progress (just need to double check whether finished)

A Xen Performance Tuning Guide

Document Policy on Maintenance Releases

Which releases are supported, for how long. Owners. As well as a mechanism for individuals (or vendors) to take ownership of older releases (as is the case for Xen 3.4).

Better Statements on Compatibility

There seems to be some confusion in the wider Linxu community about XL/XM compatibility. Maybe some specific questions in an FAQ/the release notes. Also migration compatibility comes up often. Any articles related to compatibility should be listed in Category:Compatibility, which I am willing to clean up.

  • Pictogram voting comment 15px.png Anthony 14:33, 26 November 2012 (UTC): I add a bunch of pages to the category, and add few link in the category to upgrade from xend to xl.
  • Pictogram voting comment 15px.png Anthony 17:19, 26 November 2012 (UTC): I also redirect XL in Xen 4.2 to XL as they had both the same content minus few things.
  • Pictogram voting comment 15px.png Lars.kurth 12:48, 22 January 2013 (UTC): Is this done?


Better XCP Overview Documentation

Open work items

Document release signing keys and fingerprints etc

We should publish the key ids and fingerprints somewhere.

UEFI Secure Boot

Write a document on how to sign the xen binary for UEFI Secure Boot. Potential reference here: Dealing With Secure Boot

Manpages for xe command

Write manpages for xe and it's 361 subcommands.

Xen PV Architecture Documentation

Something like a SDM for Xen PV "processors".

Add pages to Category:Paravirtualised Architecture

cpupools intro / howto

Describe the different ways, and necessary components, to create PVs using xl

Raised by mail by Matthias Blankenhaus (who is prepared to take the lead, but needs help): This document would describe the different ways, and necessary components that each way requires, to create PVs using xl. Right now there are at least the following cases:

  • loopbacked vhds
    • single partition format
    • disk format
  • qemu backed vhds
    • qcow / qcow2
  • LVS backed image

This is not a complete list. Also the mileage of each case differs depending on the kernel features enabled in dom0/domu and also depending on the Xen version. Furthermore, certain format require additional infrastructure like the tap device.

All in all, this a complex topic that needs clarification. Doing this based on the lowest common denominator, xl, would clarify many things. In addition, baseline performance data on all of the above would help a great deal. Matthias volunteered to run the majority of needed perf tests

A Xen Security Guide

The different options in Xen for Security, trade-offs, how to set them up, how to test Xen for security and how to optimize for different scenarios

  • Pictogram voting comment 15px.png Lars.kurth 09:48, 27 March 2012 (UTC): Category:Security contains some security related docs
  • Pictogram voting comment 15px.png Lars.kurth 11:01, 4 April 2012 (UTC): It would be good if we could document a) XSM, b) Introspection API, c) Xen and SELinux in Dom0, d) Memory Access API (introduced in 4.1)
  • User Docs that where migrating content would make sense and update such as (we can attach PDF's to the wiki now for starters, or we can use a conversion tool
  • Pictogram voting comment 15px.png Lars.kurth 15:59, 19 September 2012 (UTC): Some good articles came out of XenSummit NA (these can be built upon). Got funding to document XSM; contract in place, but contractor is currently ill.

Review and Update: xenpm usage recommendations

There is Xen power management and Xenpm command which may all be outdated. These should probably be reviewed and updated.

HOWTO : using xm trigger to poweroff or firing off NMIs

Howto on using xm trigger to poweroff or firing off NMIs.

HOWTO : How to Set Up Nested Virtualization

See this thread

HOWTO: Chain pypxeboot and pygrub

How to chain pypxeboot and pygrub

  • Pictogram voting comment 15px.png Lars.kurth 10:35, 27 March 2012 (UTC): Is pypxeboot popular at all?
  • Pictogram voting comment 15px.png Fheigl: I added that. It is somewhat common, OVM 2 and OVM 3 rely on it for PXE installs. I'm not sure if xenpvnetboot is the same, or works. The use case is "you want to use the same installation server for Xen VMs and phys. servers. You want to be able to reinstall them based on PXE reply.
  • Pictogram voting comment 15px.png Fheigl: There is documentation for pypxeboot, but there is no (afaik) documentation for how pygrub is used as a fallback loader. We wasted many days just to get some hack that can't even load a newer kernel. Which sucks, in the end you spend more time/money making PV PXE boot work than you save by using virtualized servers.
  • Pictogram voting comment 15px.png Fheigl: How could it be popular given the state of documentation. <= Key issue to the left of this sentence.
  • Pictogram voting comment 15px.png Lars.kurth 16:03, 19 September 2012 (UTC): wondering whether this video contains what is needed

Updated docs for transition to git

We are planning to switch the primary Xen repositories to git at some point, a bunch of documentation will necessarily require updating.

Document {deb,rpm,tar}-pkg targets in kernel

Mainline_Linux_Kernel_Configs talks about the obsolete and Debian specific make-kpkg tool. Should reference the kernels own foo-pkg targets instead.

Done Recently

Clear up Xen TODO List

Developer Docs

Docs that need attention or are missing

  • Make XAPI docs (built from source) available on xen.org
  • PVOPS portal on xen.org - Konrad volunteered
  • some more xenstore docs (i.e. recent python bindings that were sent to the -users list
  • Using libxenstat python bindings (imo they're broken)
  • More PV protocol docs (see recent patches to blkif.h for example)
  • Document xenstore paths used by guests and toolstack etc

Wiki Maintenance

Fix articles that need attention

Review Categorization

We need to go through some of the categies on the http://wiki.xen.org/wiki/Main_Page and decise whether there are documents in each category that need to be highlighted in a trail, etc.

Loose ends on migration