Difference between revisions of "Xen Document Days/TODO"

From Xen
Line 21: Line 21:
 
* 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.
 
* [[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.
 +
 +
==== Xen 4.2: VCPU pinning and NUMA ====
 +
We need a good page on NUMA and maybe another one on the scheduler and vcpu pinning.
 +
Currently we have three pages on NUMA: [[Xen_Numa_Scheduling_and_Placement]], [[Xen_NUMA_Introduction]], [[Xen_NUMA_Benchmarks]].
 +
  
 
=== Open work items ===
 
=== Open work items ===
Line 36: Line 42:
 
* 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
 
==== Xen 4.2: VCPU pinning ====
 
Some more documentation outside the context of NUMA, see [[Xen_Numa_Scheduling_and_Placement]]
 
  
 
==== Review and Update: xenpm usage recommendations ====
 
==== Review and Update: xenpm usage recommendations ====

Revision as of 14:05, 30 July 2012

Go back to Xen Document Days

Requested Documentation

Icon Info.png Feel free to comment on items using the following convention:
* ~~~~: 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)

Improve networking documentation

Expand Host Configuration/Networking docs to cover non-bridge network configurations supported by xend (e.g. routed, nat'd). Possibly split into a page per config.

  • Lars.kurth 19:50, 25 June 2012 (UTC) : Significant work has been done to Xen Networking. Not sure whether the review tag from Xen_Networking can be removed
  • Ijc 08:31, 28 June 2012 (UTC): IMHO not yet. I'll continue to work on the remainder of the doc and then remove the tag.

A Xen Performance Tuning Guide

Xen 4.2: VCPU pinning and NUMA

We need a good page on NUMA and maybe another one on the scheduler and vcpu pinning. Currently we have three pages on NUMA: Xen_Numa_Scheduling_and_Placement, Xen_NUMA_Introduction, Xen_NUMA_Benchmarks.


Open work items

Getting started with Xen using xen-tools

Given that we are getting a lot more total novices to the community I was wondering whether it makes sense to add something like: getting started with xen-tools. See http://www.virtuatopia.com/index.php/Building_a_Xen_Guest_Domain_using_Xen-Tools and http://xen-tools.org/software/xen-tools/ and http://www.gossamer-threads.com/lists/xen/users/246910 this.

XCP Overview

Similar to Xen Overview

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

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: Setting boot order for domUs (PV and HVM)

Howto set up boot order for domUs (all virt modes)

HOWTO: Chain pypxeboot and pygrub

How to chain pypxeboot and pygrub

  • Lars.kurth 10:35, 27 March 2012 (UTC): Is pypxeboot popular at all?
  • 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.
  • 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.
  • Fheigl Q3: How could it be popular given the state of documentation. <= Key issue to the left of this sentence.

Clear up Xen TODO List

XenDevelopmentProjects may be out-of-date. Remove/tick off what has been done.

Done Recently

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
  • Xen command line options documentation in tree (started, but not complete)

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