XenAPI: Cleanup install instructions

* Removed plugin installation through creating a supplemental pack as the
scripts used to build the pack are no longer part of compute.
* Removed references to XCP, Kronos.
* Amend XenServer download links.
* Remove references to DevStack.
* Remove boot from iso instructions as they are not tested.
* Formatted the sources
* Update links to XenServer 6.2

Partial-Bug: 1021224

Change-Id: I02d2906d1d5d697dfe709b4e2cc532f0f89983d9

doc/config-reference/compute/section_xapi-ami-setup.xml

@@ -6,17 +6,20 @@
   xml:id="xapi-ami-setup">
     <?dbhtml stop-chunking?>
     <title>Prepare for AMI type images</title>
-    <para>To support AMI type images in your OpenStack installation,
+    <para>
-        you must create a <filename>/boot/guest</filename> directory
+        To support AMI type images in your OpenStack installation, you must
-        inside Dom0. The OpenStack VM extracts the kernel and ramdisk
+        create the <filename>/boot/guest</filename> directory on dom0. One of
-        from the AKI and ARI images puts them in this location.</para>
+        the OpenStack XAPI plugins will extract the kernel and ramdisk from
-    <para>OpenStack maintains the contents of this directory and its
+        AKI and ARI images and put them to that directory.
-        size should not increase during normal operation. However, in
+    </para>
-        case of power failures or accidental shutdowns, some files
+    <para>
-        might be left over. To prevent these files from filling the
+        OpenStack maintains the contents of this directory and its size should
-        Dom0 disk, set up this directory as a symlink that points to a
+        not increase during normal operation. However, in case of power
-        subdirectory of the local SR.</para>
+        failures or accidental shutdowns, some files might be left over. To
-    <para>Run these commands in Dom0 to achieve this setup:</para>
+        prevent these files from filling up dom0's filesystem, set up this
+        directory as a symlink that points to a subdirectory of the local SR.
+    </para>
+    <para>Run these commands in dom0 to achieve this setup:</para>
     <screen><prompt>#</prompt> <userinput>LOCAL_SR=$(xe sr-list name-label="Local storage" --minimal)</userinput>
 <prompt>#</prompt> <userinput>LOCALPATH="/var/run/sr-mount/$LOCAL_SR/os-guest-kernels"</userinput>
 <prompt>#</prompt> <userinput>mkdir -p "$LOCALPATH"</userinput>

doc/config-reference/compute/section_xapi-install-plugins.xml

@@ -5,19 +5,24 @@
   version="5.0"
   xml:id="xapi-install-plugins">
     <?dbhtml stop-chunking?>
-    <title>Install the XenAPI plug-ins</title>
+    <title>Install XAPI plug-ins</title>
-    <para>When you use Xen as the hypervisor for OpenStack Compute,
+    <para>
-        you can install a Python script (or any executable) on the
+        When you use a XAPI managed hypervisor, you can install a Python script
-        host side, and call that through the XenAPI. These scripts are
+        (or any executable) on the host side, and execute that through XenAPI.
-        called plug-ins. The XenAPI plug-ins live in the nova code
+        These scripts are called plug-ins. The OpenStack related XAPI plug-ins
-        repository. These plug-ins have to be copied to the Dom0 for
+        live in OpenStack Compute's code repository. These plug-ins have to be
-        the hypervisor, to the appropriate directory, where xapi can
+        copied to dom0's filesystem, to the appropriate directory, where XAPI
-        find them. There are several options for the installation. The
+        can find them. It is important to ensure that the version of the
-        important thing is to ensure that the version of the plug-ins
+        plug-ins are in line with the OpenStack Compute installation you are
-        are in line with the nova installation by only installing
+        using.
-        plug-ins from a matching nova repository.</para>
+    </para>
+    <para>
+        The plugins should typically be copied from the Nova installation
+        running in the Compute's DomU, but if you want to download the latest
+        version the following procedure can be used.
+    </para>
     <section xml:id="manual_install">
-        <title>Manually install the plug-in</title>
+        <title>Manually installing the plug-ins</title>
         <procedure>
             <step>
                 <para>Create temporary files/directories:</para>
@@ -25,70 +30,26 @@
 <prompt>$</prompt> <userinput>NOVA_SOURCES=$(mktemp -d)</userinput></screen>
             </step>
             <step>
-                <para>Get the source from GitHub. The example assumes
+                <para>
-                    the master branch is used. Amend the URL to match
+                    Get the source from GitHub. The example assumes the master
-                    the version being used:</para>
+                    branch is used, and the XenServer host is accessible
-                <screen><prompt>$</prompt> <userinput>wget -qO "$NOVA_ZIPBALL" https://github.com/openstack/nova/archive/master.zip</userinput>
+                    as xenserver. Match those parameters to your setup.
+                </para>
+                <screen><prompt>$</prompt> <userinput>NOVA_URL=https://github.com/openstack/nova/archive/master.zip</userinput>
+<prompt>$</prompt> <userinput>wget -qO "$NOVA_ZIPBALL" "$NOVA_URL"</userinput>
 <prompt>$</prompt> <userinput>unzip "$NOVA_ZIPBALL" -d "$NOVA_SOURCES"</userinput></screen>
-                <para>(Alternatively) To use the official Ubuntu
-                    packages, use the following commands to get the
-                    nova code base:</para>
-                <screen><prompt>$</prompt> <userinput>( cd $NOVA_SOURCES &amp;&amp; apt-get source python-nova --download-only )</userinput>
-<prompt>$</prompt> <userinput>( cd $NOVA_SOURCES &amp;&amp; for ARCHIVE in *.tar.gz; do tar -xzf $ARCHIVE; done )</userinput></screen>
             </step>
             <step>
                 <para>Copy the plug-ins to the hypervisor:</para>
                 <screen><prompt>$</prompt> <userinput>PLUGINPATH=$(find $NOVA_SOURCES -path '*/xapi.d/plugins' -type d -print)</userinput>
-<prompt>$</prompt> <userinput>tar -czf - -C "$PLUGINPATH" ./ | ssh root@xenserver tar -xozf - -C /etc/xapi.d/plugins/</userinput></screen>
+<prompt>$</prompt> <userinput>tar -czf - -C "$PLUGINPATH" ./ |</userinput>
+<prompt>&gt;</prompt> <userinput>ssh root@xenserver tar -xozf - -C /etc/xapi.d/plugins/</userinput></screen>
             </step>
             <step>
-                <para>Remove the temporary files/directories:</para>
+                <para>Remove temporary files/directories:</para>
                 <screen><prompt>$</prompt> <userinput>rm "$NOVA_ZIPBALL"</userinput>
 <prompt>$</prompt> <userinput>rm -rf "$NOVA_SOURCES"</userinput> </screen>
             </step>
         </procedure>
     </section>
-    <section xml:id="packaged_install">
-        <title>Package a XenServer supplemental pack</title>
-        <para>Follow these steps to produce a supplemental pack from
-            the nova sources, and package it as a XenServer
-            supplemental pack.</para>
-        <procedure>
-            <step>
-                <para>Create RPM packages. Given you have the nova
-                    sources. Use one of the methods in <xref
-                        linkend="manual_install"/>:</para>
-                <screen><prompt>$</prompt> <userinput>cd nova/plugins/xenserver/xenapi/contrib</userinput>
-<prompt>$</prompt> <userinput>./build-rpm.sh</userinput></screen>
-                <para>These commands leave an
-                        <filename>.rpm</filename> file in the
-                        <filename>rpmbuild/RPMS/noarch/</filename>
-                    directory.</para>
-            </step>
-            <step>
-                <para>Pack the RPM packages to a Supplemental Pack,
-                    using the XenServer DDK (the following command
-                    should be issued on the XenServer DDK virtual
-                    appliance, after the produced rpm file has been
-                    copied over):</para>
-                <screen><prompt>$</prompt> <userinput>/usr/bin/build-supplemental-pack.sh \</userinput>
-<prompt>&gt;</prompt> <userinput>--output=output_directory \</userinput>
-<prompt>&gt;</prompt> <userinput>--vendor-code=novaplugin \</userinput>
-<prompt>&gt;</prompt> <userinput>--vendor-name=openstack \</userinput>
-<prompt>&gt;</prompt> <userinput>--label=novaplugins \</userinput>
-<prompt>&gt;</prompt> <userinput>--text="nova plugins" \</userinput>
-<prompt>&gt;</prompt> <userinput>--version=0 \</userinput>
-<prompt>&gt;</prompt> <userinput>full_path_to_rpmfile</userinput></screen>
-                <para>This command produces an
-                        <filename>.iso</filename> file in the output
-                    directory specified. Copy that file to the
-                    hypervisor.</para>
-            </step>
-            <step>
-                <para>Install the Supplemental Pack. Log in to the
-                    hypervisor, and issue:</para>
-                <screen><prompt>#</prompt> <userinput>xe-install-supplemental-pack path_to_isofile</userinput></screen>
-            </step>
-        </procedure>
-    </section>
 </section>

doc/config-reference/compute/section_xapi-resize-setup.xml

@@ -5,32 +5,37 @@
   version="5.0"
   xml:id="xapi-resize-setup">
     <?dbhtml stop-chunking?>
-    <title>Modify Dom0 for resize/migration support</title>
+    <title>Modify dom0 for resize/migration support</title>
-    <para>To resize servers with XenServer and XCP, you must:</para>
+    <para>To resize servers with XenServer you must:</para>
     <itemizedlist>
         <listitem>
-            <para>Establish a root trust between all hypervisor nodes
+            <para>
-                of your deployment:</para>
+                Establish a root trust between all hypervisor nodes
-            <para>To do so, generate an ssh key-pair with the
+                of your deployment:
-                    <command>ssh-keygen</command> command. Ensure that
+            </para>
-                each of your dom0's
+            <para>
-                    <filename>authorized_keys</filename> file (located
+                To do so, generate an ssh key-pair with the
-                in <filename>/root/.ssh/authorized_keys</filename>)
+                <command>ssh-keygen</command> command. Ensure that each of your
-                contains the public key fingerprint (located in
+                dom0's <filename>authorized_keys</filename> file (located in
-                    <filename>/root/.ssh/id_rsa.pub</filename>).</para>
+                <filename>/root/.ssh/authorized_keys</filename>) contains the
+                public key fingerprint (located in
+                <filename>/root/.ssh/id_rsa.pub</filename>).
+            </para>
         </listitem>
         <listitem>
-            <para>Provide an <filename>/images</filename> mount point
+            <para>
-                to the dom0 for your hypervisor:</para>
+                Provide a <filename>/images</filename> mount point to the dom0
-            <para>Dom0 space is at a premium so creating a directory
+                for your hypervisor:
-                in dom0 is potentially dangerous and likely to fail
+            </para>
-                especially when you resize large servers. The least
+            <para>
-                you can do is to symlink <filename>/images</filename>
+                dom0 space is at a premium so creating a directory in dom0 is
-                to your local storage SR. The following instructions
+                potentially dangerous and likely to fail especially when you
-                work for an English-based installation of XenServer
+                resize large servers. The least you can do is to symlink
-                (and XCP) and in the case of ext3-based SR (with which
+                <filename>/images</filename> to your local storage SR. The
-                the resize functionality is known to work
+                following instructions work for an English-based installation
-                correctly).</para>
+                of XenServer and in the case of ext3-based SR (with which the
+                resize functionality is known to work correctly).
+            </para>
             <screen><prompt>#</prompt> <userinput>LOCAL_SR=$(xe sr-list name-label="Local storage" --minimal)</userinput>
 <prompt>#</prompt> <userinput>IMG_DIR="/var/run/sr-mount/$LOCAL_SR/images"</userinput>
 <prompt>#</prompt> <userinput>mkdir -p "$IMG_DIR"</userinput>

doc/config-reference/compute/section_xen-install.xml

@@ -4,173 +4,114 @@
   xmlns:xlink="http://www.w3.org/1999/xlink"
   version="5.0"
   xml:id="xenapi-install">
-    <title xml:id="xenapi-install.title">Install XenServer and
+    <title xml:id="xenapi-install.title">Install XenServer</title>
-        XCP</title>
+    <para>
-    <para>Before you can run OpenStack with XCP or XenServer, you must
+        Before you can run OpenStack with XenServer, you must install the
-        install the software on <link
+        hypervisor on
-            xlink:href="http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/installation.html#sys_requirements"
+        <link
-            >an appropriate server</link>.</para>
+            xlink:href="http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/installation.html#sys_requirements">
+            an appropriate server
+        </link>
+        .
+    </para>
     <note>
-        <para>Xen is a type 1 hypervisor: When your server starts, Xen
+        <para>
-            is the first software that runs. Consequently, you must
+            Xen is a type 1 hypervisor: When your server starts, Xen is the
-            install XenServer or XCP before you install the operating
+            first software that runs. Consequently, you must install XenServer
-            system where you want to run OpenStack code. The OpenStack
+            before you install the operating system where you want to run
-            services then run in a virtual machine that you install on
+            OpenStack code. You then install
-            top of XenServer.</para>
+            <systemitem class="service">nova-compute</systemitem> into a
+            dedicated virtual machine on the host.
+        </para>
     </note>
-    <para>Before you can install your system, decide whether to
+    <para>
-        install a free or paid edition of Citrix XenServer or Xen
+        Use the following link to download XenServer's installation media:
-        Cloud Platform from Xen.org. Download the software from these
+        <itemizedlist>
-        locations:</para>
+            <listitem>
-    <itemizedlist>
+                <para>
-        <listitem>
+                    <link
-            <para><link
+                        xlink:href="http://xenserver.org/open-source-virtualization-download.html">
-                    xlink:href="http://www.citrix.com/XenServer/download"
+                        http://xenserver.org/open-source-virtualization-download.html
-                    >http://www.citrix.com/XenServer/download</link></para>
+                    </link>
-        </listitem>
+                </para>
-        <listitem>
+            </listitem>
-            <para><link
+        </itemizedlist>
-                    xlink:href="http://www.xen.org/download/xcp/index.html"
+    </para>
-                    >http://www.xen.org/download/xcp/index.html</link></para>
+    <para>
-        </listitem>
+        When you install many servers, you might find it easier to perform
-    </itemizedlist>
+        <link
-    <para>When you install many servers, you might find it easier to
+            xlink:href="http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/installation.html#pxe_boot_install">
-        perform <link
+            PXE boot installations
-            xlink:href="http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/installation.html#pxe_boot_install"
+        </link>
-            >PXE boot installations of XenServer or XCP</link>. You
+        . You can also package any post-installation changes that you want to
-        can also package any post-installation changes that you want
+        make to your XenServer by following the instructions of
-        to make to your XenServer by <link
+        <link
-            xlink:href="http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/supplemental_pack_ddk.html"
+            xlink:href="http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/supplemental_pack_ddk.html">
-            >creating your own XenServer supplemental
+            creating your own XenServer supplemental pack
-        pack</link>.</para>
+        </link>
-
+        .
-    <para>You can also install the <package>xcp-xenapi</package>
+    </para>
-        package on Debian-based distributions to get XCP. However,
-        this is not as mature or feature complete as above
-        distributions. This modifies your boot loader to first boot
-        Xen and boot your existing OS on top of Xen as Dom0. The xapi
-        daemon runs in Dom0. Find more details at <link
-            xlink:href="http://wiki.xen.org/wiki/Project_Kronos"
-            >http://wiki.xen.org/wiki/Project_Kronos</link>.</para>
     <important>
-        <para>Make sure you use the EXT type of storage repository
+        <para>
-            (SR). Features that require access to VHD files (such as
+            Make sure you use the EXT type of storage repository (SR). Features
-            copy on write, snapshot and migration) do not work when
+            that require access to VHD files (such as copy on write, snapshot
-            you use the LVM SR. Storage repository (SR) is a
+            and migration) do not work when you use the LVM SR. Storage
-            XenAPI-specific term relating to the physical storage
+            repository (SR) is a XAPI-specific term relating to the physical
-            where virtual disks are stored.</para>
+            storage where virtual disks are stored.
-        <para>On the XenServer/XCP installation screen, choose the
+        </para>
-                <guilabel>XenDesktop Optimized</guilabel> option. If
+        <para>
-            you use an answer file, make sure you use
+            On the XenServer installation screen, choose the
-                <literal>srtype="ext"</literal> in the
+            <guilabel>XenDesktop Optimized</guilabel>
-                <option>installation</option> tag of the answer
+            option. If you use an answer file, make sure you use
-            file.</para>
+            <literal>srtype="ext"</literal>
+            in the
+            <literal>installation</literal>
+            tag of the answer file.
+        </para>
     </important>
     <section xml:id="xenapi-post-install">
         <title>Post-installation steps</title>
-        <para>Complete these steps to install OpenStack in your
+        <para>
-            XenServer system:</para>
+            The following steps need to be completed after the hypervisor's
+            installation:
+        </para>
         <procedure>
             <step>
-                <para>For resize and migrate functionality, complete
+                <para>
-                    the changes described in the <citetitle>Configure
+                    For resize and migrate functionality, enable password-less
-                        resize</citetitle> section in the <link
+                    SSH authentication and set up the
-                        xlink:href="http://docs.openstack.org/trunk/config-reference/content/"
+                    <literal>/images</literal>
-                            ><citetitle>OpenStack Configuration
+                    directory on dom0.
-                            Reference</citetitle></link>.</para>
+                </para>
             </step>
             <step>
-                <para>Install the VIF isolation rules to help prevent
+                <para>
-                    mac and IP address spoofing.</para>
+                    Install the XAPI plug-ins.
+                </para>
             </step>
             <step>
-                <para>Install the XenAPI plug-ins. See the following
+                <para>
-                    section.</para>
+                    To support AMI type images, you must set up
+                    <literal>/boot/guest</literal>
+                    symlink/directory in dom0.
+                </para>
             </step>
             <step>
-                <para>To support AMI type images, you must set up
+                <para>
-                        <literal>/boot/guest</literal>
+                    Create a Paravirtualized virtual machine that can run
-                    symlink/directory in Dom0. For detailed
+                    <systemitem class="service">nova-compute</systemitem>.
-                    instructions, see next section.</para>
+                </para>
             </step>
             <step>
-                <para>To support resize/migration, set up an ssh trust
+                <para>
-                    relation between your XenServer hosts, and ensure
+                    Install and configure
-                        <literal>/images</literal> is properly set up.
+                    <systemitem class="service">nova-compute</systemitem>
-                    See next section for more details.</para>
+                    in the above virtual machine.
-            </step>
+                </para>
-            <step>
-                <para>Create a Paravirtualized virtual machine that
-                    can run the OpenStack compute code.</para>
-            </step>
-            <step>
-                <para>Install and configure the <systemitem
-                        class="service">nova-compute</systemitem> in
-                    the above virtual machine.</para>
             </step>
         </procedure>
-        <para>For more information, see how DevStack performs the last
-            three steps for developer deployments. For more
-            information about DevStack, see <citetitle>Getting Started
-                With XenServer and Devstack</citetitle> (<link
-                xlink:href="https://github.com/openstack-dev/devstack/blob/master/tools/xen/README.md"
-                >https://github.com/openstack-dev/devstack/blob/master/tools/xen/README.md</link>).
-            Find more information about the first step, see
-                <citetitle>Multi Tenancy Networking Protections in
-                XenServer</citetitle> (<link
-                xlink:href="https://github.com/openstack/nova/blob/master/plugins/xenserver/doc/networking.rst"
-                >https://github.com/openstack/nova/blob/master/plugins/xenserver/doc/networking.rst</link>).
-            For information about how to install the XenAPI plug-ins,
-            see <citetitle>XenAPI README</citetitle> (<link
-                xlink:href="https://github.com/openstack/nova/blob/master/plugins/xenserver/xenapi/README"
-                >https://github.com/openstack/nova/blob/master/plugins/xenserver/xenapi/README</link>).</para>
         <xi:include href="section_xapi-install-plugins.xml"/>
         <xi:include href="section_xapi-ami-setup.xml"/>
         <xi:include href="section_xapi-resize-setup.xml"/>
     </section>
-    <section xml:id="xenapi-boot-from-iso">
-        <title>Xen boot from ISO</title>
-        <para>XenServer, through the XenAPI integration with
-            OpenStack, provides a feature to boot instances from an
-            ISO file. To activate the Boot From ISO feature, you must
-            configure the SR elements on XenServer host, as
-            follows:</para>
-        <procedure>
-            <step>
-                <para>Create an ISO-typed SR, such as an NFS ISO
-                    library, for instance. For this, using XenCenter
-                    is a simple method. You must export an NFS volume
-                    from a remote NFS server. Make sure it is exported
-                    in read-write mode.</para>
-            </step>
-            <step>
-                <para>On the compute host, find and record the UUID of
-                    this ISO SR:</para>
-                <screen><prompt>#</prompt> <userinput>xe host-list</userinput></screen>
-            </step>
-            <step>
-                <para>Locate the UUID of the NFS ISO library:</para>
-                <screen><prompt>#</prompt> <userinput>xe sr-list content-type=iso</userinput></screen>
-            </step>
-            <step>
-                <para>Set the UUID and configuration. Even if an NFS
-                    mount point is not local, you must specify
-                        <literal>local-storage-iso</literal>.</para>
-                <screen><prompt>#</prompt> <userinput>xe sr-param-set uuid=[iso sr uuid] other-config:i18n-key=local-storage-iso</userinput></screen>
-            </step>
-            <step>
-                <para>Make sure the host-UUID from <literal>xe
-                        pbd-list</literal> equals the UUID of the host
-                    you found previously:</para>
-                <screen><prompt>#</prompt> <userinput>xe sr-uuid=[iso sr uuid]</userinput></screen>
-            </step>
-            <step>
-                <para>You can now add images through the OpenStack
-                    Image Service with
-                        <literal>disk-format=iso</literal>, and boot
-                    them in OpenStack Compute:</para>
-                <screen><prompt>$</prompt> <userinput>glance image-create --name fedora_iso --disk-format iso --container-format bare &lt; Fedora-16-x86_64-netinst.iso</userinput></screen>
-            </step>
-        </procedure>
-    </section>
 </section>