Add documentation for Xen via libvirt

[Alvaro Lopez]

The Configuration Reference guide lacks an hypervisor section about configuring Xen+livbirt. We are working in improving its support so I think we will draft a document soon.

[Andreas Jaeger (jaegerandi)]

Alvaro, do you want to assign the bug to yourself? Thanks for working on this!

[Andreas Jaeger (jaegerandi)]

IFCA cloud team, are you still working on this?

[Alvaro Lopez (aloga)]

Andreas:

we're working on the support on various areas for libvirt+Xen but not on the documentation (unfortunately our manpower is limited). If there's somebody that could take care of the, we can provide feedback though.

[Lars Kurth (lars-kurth)]

HI, I am willing to pick this one up, if someone can point me to the markup, style guides and repo's for http://docs.openstack.org/kilo/config-reference/content/section_compute-hypervisors.html ... all the necessary information is in various places on the xen wiki.

[Tom Fifield (fifieldt)]

https://github.com/openstack/openstack-manuals/blob/master/doc/config-reference/compute/section_compute-hypervisors.xml is where that URL comes from

Conventions are at https://wiki.openstack.org/Documentation/Conventions

Markup description at https://wiki.openstack.org/wiki/Documentation/Markup_conventions

but really, you can

[Tom Fifield (fifieldt)]

but really, you can totally just see what's in there, do something similar, and the doc team will help with conventions and markup during the review

[Tom Fifield (fifieldt)]

not sure if you need this, but the developer's guide is always handy: http://docs.openstack.org/infra/manual/developers.html :)

[Lars Kurth (lars-kurth)]

Thanks, I will have a go at it in the coming weeks. I do want to make sure that a number of Xen patches are back-ported to the next Xen Project maintenance releases (see http://lists.xenproject.org/archives/html/xen-devel/2015-06/msg01745.html) such that we have a clean baseline which doesn't depend on any patches. Any necessary libvirt patches are already released.

[Lars Kurth (lars-kurth)]

I followed the instructions at https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers and assigned the bug to myself, but as a consequence ifca-cloud got removed. Not sure this is an issue. Sorry for the stupid question.

I also started taking stock of what is there and there are a number of inconsistencies in file naming of the xenserver docs vs. the non existing xen docs. I was planning to rename
* section_compute-configure-xen.xml to section_compute-configure--xen-xenserver.xml using git mv
* make the difference between xenserver and xen clearer in section_compute-hypervisors.xml
* introduce a new file section_compute-configure-xen-libvirt.xml

Any objections?

[Tom Fifield (fifieldt)]

Lars, any further work towards xen improvements sound great! Don't feel constrained to the scope of this bug if you feel like making general improvements.

Also, looking in comments above, it seems the IFCA team is happy for help with this, so no stress there.

[Alvaro Lopez (aloga)]

Lars, no problem, we were unable to work on this. As far as the docs are concerned, all of your planned changes make a lot of sense to me (above all the differentiation between xen and xenserver).

[Lars Kurth (lars-kurth)]

I submitted the changes: they are at https://review.openstack.org/#/c/198793/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/199527
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=bb15ae4df456ab07b09ca8a8a03b0fa4eb489b52
Submitter: Jenkins
Branch: master

commit bb15ae4df456ab07b09ca8a8a03b0fa4eb489b52
Author: Lars Kurth <email address hidden>
Date: Fri Jun 26 12:25:03 2015 -0400

    Add documentation for Xen via libvirt to config-reference

    To do this I had do some changes to existing Xen documentation:

    Apply minimal changes to filenames, enabling later addition of
    hypervisor support using Xen+libvirt, renaming XenServer files
    using git mv
    - section_introduction-to-xen.xml > section_hypervisor_xen_xapi.xml
    - section_xen-install.xml > section_xapi-install.xml
    - section_compute-configure-xen.xml > section_compute-configure-xapi.xml

    All XenServer docs can now be identified using xapi in the filename.

    Renamed relevant occurances of Xen to XenServer in XenServer docs and
    the Hypervisor page and replaced outdated references to Xen.org with
    XenProject.org

    Changed URL from introduction-to-xen.html to xen_libvirt.html in
    doc/common/section_kvm_enable.xml (did not include references in .po
    and .pot files in locale, which are autogenerated)

    All of the new Xen via Libvirt documentation is in a new page called
    section_hypervisor_xen_libvirt.html

    Change-Id: I6a6de021ef4e5de4fe28aa971411e07b656c969c
    Closes-Bug: #1253565
    Signed-off-by: Lars Kurth <email address hidden>
    Co-Authored-By: Jim Fehlig <email address hidden>
    Co-Authored-By: Anthony Perard <email address hidden>

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.