en-US/secondary-storage-add.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="secondary-storage-add">
    <title>Add Secondary Storage</title>
    <section id="sys-require-secondary-storage">
    <title>System Requirements for Secondary Storage</title>
    <itemizedlist>
        <listitem>
        <para>NFS storage appliance or Linux NFS server</para>
      </listitem>
      <listitem>
        <para>SMB/CIFS (Hyper-V)</para>
      </listitem>
        <listitem><para>(Optional) OpenStack Object Storage (Swift) (see http://swift.openstack.org)</para></listitem>
        <listitem><para>100GB minimum capacity</para></listitem>
        <listitem><para>A secondary storage device must be located in the same zone as the guest VMs it serves.</para></listitem>
        <listitem><para>Each Secondary Storage server must be available to all hosts in the zone.</para></listitem>
    </itemizedlist>
    </section>
    <section id="adding-secondary-storage">
    <title>Adding Secondary Storage</title>
    <para>When you create a new zone, the first secondary storage is added as part of that procedure. You can add secondary storage servers at any time to add more servers to an existing zone.</para>
    <warning><para>Ensure that nothing is stored on the server. Adding the server to &PRODUCT; will destroy any
    existing data.</para></warning>
      <para></para>
    <orderedlist>
        <listitem><para>To prepare for the zone-based Secondary Staging Store, you should have created and mounted an
          NFS share during Management Server installation. <phrase condition="install">See <xref
              linkend="prepare-nfs-shares"/>.</phrase><phrase condition="admin">See Preparing NFS
            Shares in the Installation Guide.</phrase></para>
        <para>If you are using an Hyper-V host, ensure that you have created a SMB share.</para></listitem>
        <listitem><para>Make sure you prepared the system VM template during Management Server installation. <phrase condition="install">See <xref linkend="prepare-system-vm-template" />.</phrase><phrase condition="admin">See Prepare the System VM Template in the Installation Guide.</phrase></para></listitem>
        <listitem><para>Log in to the &PRODUCT; UI as root administrator.</para></listitem>
        <listitem><para>In the left navigation bar, click Infrastructure.</para></listitem>
        <listitem><para>In Secondary Storage, click View All.</para></listitem>
        <listitem><para>Click Add Secondary Storage.</para></listitem>
        <listitem><para>Fill in the following fields:</para>
            <itemizedlist>
                <listitem><para>Name. Give the storage a descriptive name.</para></listitem>
                <listitem><para>Provider. Choose S3, Swift, NFS, or CIFS then fill in the related fields which appear. The
              fields will vary depending on the storage provider; for more information, consult the
              provider's documentation (such as the S3 or Swift website). NFS can be used for
              zone-based storage, and the others for region-wide storage. For Hyper-V, select
              SMB/CIFS.</para>
                    <warning><para>Heterogeneous Secondary Storage is not supported in Regions. You can use only a single NFS,
                    S3, or Swift account per region.</para></warning>
                <para></para></listitem>
                <listitem><para>Create NFS Secondary Staging Store. This box must always be checked.</para>
                    <warning><para>Even if the UI allows you to uncheck this box, do not do so.
                        This checkbox and the three fields below it must be filled in.
                        Even when Swift or S3 is used as the secondary storage provider, an NFS
                        staging storage in each zone is still required.</para></warning><para/></listitem>
                <listitem><para>Zone. The zone where the NFS Secondary Staging Store is to be located.</para></listitem>
              <listitem>
                <para><emphasis role="bold">SMB Username</emphasis>: Applicable only if you select
                  SMB/CIFS provider. The username of the account which has the necessary permissions to
                  the SMB shares. The user must be part of the Hyper-V administrator group.</para>
              </listitem>
              <listitem>
                <para><emphasis role="bold">SMB Password</emphasis>: Applicable only if you select
                  SMB/CIFS provider. The password associated with the account.</para>
              </listitem>
              <listitem>
                <para><emphasis role="bold">SMB Domain</emphasis>: Applicable only if you select
                  SMB/CIFS provider. The Active Directory domain that the SMB share is a part of.</para>
              </listitem>
                <listitem><para>NFS server. The name of the zone's Secondary Staging Store.</para></listitem>
                <listitem><para>Path. The path to the zone's Secondary Staging Store.</para></listitem>
            </itemizedlist>
        </listitem>
    </orderedlist>
    </section>
    <section id="secondary-staging-store">
        <title>Adding an NFS Secondary Staging Store for Each Zone</title>
        <para>Every zone must have at least one NFS store provisioned; multiple NFS servers are
            allowed per zone. To provision an NFS Staging Store for a zone:</para>
        <orderedlist>
            <listitem><para>Log in to the &PRODUCT; UI as root administrator.</para></listitem>
            <listitem><para>In the left navigation bar, click Infrastructure.</para></listitem>
            <listitem><para>In Secondary Storage, click View All.</para></listitem>
            <listitem><para>In Select View, choose Secondary Staging Store.</para></listitem>
            <listitem><para>Click the Add NFS Secondary Staging Store button.</para></listitem>
            <listitem><para>Fill out the dialog box fields, then click OK:</para>
                <itemizedlist>
                    <listitem><para>Zone. The zone where the NFS Secondary Staging Store is to be located.</para></listitem>
                    <listitem><para>NFS server. The name of the zone's Secondary Staging Store.</para></listitem>
                    <listitem><para>Path. The path to the zone's Secondary Staging Store.</para></listitem>
                </itemizedlist>
            </listitem>
        </orderedlist>
    </section>

</section>