Difference between revisions of "Xen Document Days/TODO"

From Xen
(A Xen Security Guide)
(Open work items)
Line 27: Line 27:
 
=== Open work items ===
 
=== Open work items ===
  
==== Getting started with Xen using xen-tools (copy and paste from blog to wiki) ====
+
==== Easy/beginners: Getting started with Xen using xen-tools (copy and paste from blog to wiki) ====
 
Have a [http://blog.xen.org/index.php/2012/08/31/xen-tools-a-straightforward-vm-provisioninginstallation-tool/ blog post]. Copy and paste to wiki.
 
Have a [http://blog.xen.org/index.php/2012/08/31/xen-tools-a-straightforward-vm-provisioninginstallation-tool/ blog post]. Copy and paste to wiki.
 +
 +
==== Easy/beginners: Clean up Xen_4.2_Man_Pages ====
 +
There are now docs in in-source tree which is not covered in [[Xen_4.2_Man_Pages]]. Make missing articles accessible from [Xen_4.2_Man_Pages]].
  
 
==== XCP Overview ====
 
==== XCP Overview ====
Line 56: Line 59:
 
* [[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]] 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.
 
* [[User:Fheigl|Fheigl]] Q3: 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
  
 
== Done Recently ==
 
== Done Recently ==

Revision as of 16:03, 19 September 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.
  • Lars.kurth 15:53, 19 September 2012 (UTC): Checked with ijc, needs a little more work

A Xen Performance Tuning Guide

Open work items

Easy/beginners: Getting started with Xen using xen-tools (copy and paste from blog to wiki)

Have a blog post. Copy and paste to wiki.

Easy/beginners: Clean up Xen_4.2_Man_Pages

There are now docs in in-source tree which is not covered in Xen_4.2_Man_Pages. Make missing articles accessible from [Xen_4.2_Man_Pages]].

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

  • Lars.kurth 09:48, 27 March 2012 (UTC): Category:Security contains some security related docs
  • 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
  • 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.

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.
  • Lars.kurth 16:03, 19 September 2012 (UTC) : wondering whether this video contains what is needed

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
  • 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