docs/en-US/prepare-system-vm-template.xml

<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

<!-- Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at
    
    http://www.apache.org/licenses/LICENSE-2.0
    
    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
-->
<section id="prepare-system-vm-template">
  <title>Prepare the System VM Template</title>
  <para>Secondary storage must be seeded with a template that is used for &PRODUCT; system VMs.
    Citrix provides you with the necessary binary package of the system VM.</para>
  <note>
    <para>When copying and pasting a command, ensure that the command has pasted as a single line
      before executing. Some document viewers may introduce unwanted line breaks in copied
      text.</para>
  </note>
   <orderedlist>
    <listitem>
      <para>If you are using a separate NFS server, mount the secondary storage on your Management
        Server. Replace the example NFS server name and NFS share paths below with your own.</para>
      <programlisting># mount -t nfs nfsservername:/nfs/share/secondary /mnt/secondary</programlisting>
      <para>If your secondary storage mount point is not named /mnt/secondary, substitute your own
      mount point name.</para>
      </listitem>
    <listitem>
      <para>On the Management Server, run one or more of the following cloud-install-sys-tmplt
        commands to retrieve and decompress the system VM template. Run the command for each
        hypervisor type that you expect end users to run in this Zone.</para>
       <para>If you set the &PRODUCT; database encryption type to "web" when you set up the database,
        you must now add the parameter -s &lt;management-server-secret-key&gt;. See <xref
          linkend="about-password-encryption"/>.</para>
      <para>This process will require approximately 5 GB of free space on the local file system and
      up to 30 minutes each time it runs.</para>
       <itemizedlist>
        <listitem>
          <para>For XenServer:</para>
          <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.vhd.bz2 -h xenserver -s &lt;optional-management-server-secret-key&gt; -F</programlisting>
        </listitem>
        <listitem>
          <para>For vSphere:</para>
          <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.ova -h vmware -s &lt;optional-management-server-secret-key&gt;  -F</programlisting>
        </listitem>
        <listitem>
          <para>For KVM:</para>
          <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.qcow2.bz2 -h kvm -s &lt;optional-management-server-secret-key&gt; -F</programlisting>
        </listitem>
        <listitem>
          <para>For LXC:</para>
          <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.qcow2.bz2 -h lxc -s &lt;optional-management-server-secret-key&gt; -F</programlisting>
        </listitem>
      </itemizedlist>
    </listitem>
    <listitem>
       <para>When the script has finished, unmount secondary storage and remove the created
        directory.</para>
      <programlisting># umount /mnt/secondary
# rmdir /mnt/secondary</programlisting>
    </listitem>
    <listitem>
      <para>Repeat these steps for each secondary storage server.</para>
    </listitem>
  </orderedlist>
</section>