docbook for adding primary and secondary storage Signed-off-by: Gavin Lee <[email protected]> Signed-off-by: Mice Xia <[email protected]>
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/00fe63ac Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/00fe63ac Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/00fe63ac Branch: refs/heads/4.0 Commit: 00fe63ac4de7cfad569f135270d658859e169717 Parents: 74380e5 Author: Gavin Lee <[email protected]> Authored: Thu Sep 20 16:29:51 2012 +0800 Committer: Edison Su <[email protected]> Committed: Mon Sep 24 10:14:49 2012 -0700 ---------------------------------------------------------------------- docs/en-US/primary-storage-add.xml | 50 +++++++++++++++++++++++++++- docs/en-US/secondary-storage-add.xml | 22 ++++++++++++- docs/publican-all.cfg | 1 + docs/publican-install.cfg | 4 +-- 4 files changed, 71 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/00fe63ac/docs/en-US/primary-storage-add.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/primary-storage-add.xml b/docs/en-US/primary-storage-add.xml index 588d491..5581e9e 100644 --- a/docs/en-US/primary-storage-add.xml +++ b/docs/en-US/primary-storage-add.xml @@ -23,6 +23,52 @@ --> <section id="primary-storage-add"> - <title>Adding Primary Storage</title> - <para>TODO</para> + <title>Add Primary Storage</title> + <section id="sys-require-primary-storage"> + <title>System Requirements for Primary Storage</title> + <para>Hardware requirements:</para> + <itemizedlist> + <listitem><para>Any standards-compliant iSCSI or NFS server that is supported by the underlying hypervisor.</para></listitem> + <listitem><para>The storage server should be a machine with a large number of disks. The disks should ideally be managed by a hardware RAID controller.</para></listitem> + <listitem><para>Minimum required capacity depends on your needs.</para></listitem> + </itemizedlist> + <para>When setting up primary storage, follow these restrictions:</para> + <itemizedlist> + <listitem><para>Primary storage cannot be added until a host has been added to the cluster.</para></listitem> + <listitem><para>If you do not provision shared primary storage, you must set the global configuration parameter system.vm.local.storage.required to true, or else you will not be able to start VMs.</para></listitem> + </itemizedlist> + </section> + <section id="adding-primary-storage"> + <title>Adding Primary Stroage</title> + <para>When you create a new zone, the first primary storage is added as part of that procedure. You can add primary storage servers at any time, such as when adding a new cluster or adding more servers to an existing cluster.</para> + <warning><para>Be sure there is nothing stored on the server. Adding the server to &PRODUCT; will destroy any existing data.</para></warning> + <orderedlist> + <listitem><para>Log in to the &PRODUCT; UI (see <xref linkend="log-in" />).</para></listitem> + <listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the primary storage.</para></listitem> + <listitem><para>Click the Compute tab.</para></listitem> + <listitem><para>In the Primary Storage node of the diagram, click View All.</para></listitem> + <listitem><para>Click Add Primary Storage.</para></listitem> + <listitem> + <para>Provide the following information in the dialog. The information required varies depending on your choice in Protocol.</para> + <itemizedlist> + <listitem><para><emphasis role="bold">Pod.</emphasis> The pod for the storage device.</para></listitem> + <listitem><para><emphasis role="bold">Cluster.</emphasis> The cluster for the storage device.</para></listitem> + <listitem><para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para></listitem> + <listitem><para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS.</para></listitem> + <listitem><para><emphasis role="bold">Server (for NFS, iSCSI, or PreSetup).</emphasis> The IP address or DNS name of the storage device.</para></listitem> + <listitem><para><emphasis role="bold">Server (for VMFS).</emphasis> The IP address or DNS name of the vCenter server.</para></listitem> + <listitem><para><emphasis role="bold">Path (for NFS).</emphasis> In NFS this is the exported path from the server.</para></listitem> + <listitem><para><emphasis role="bold">Path (for VMFS).</emphasis> In vSphere this is a combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para></listitem> + <listitem><para><emphasis role="bold">Path (for SharedMountPoint).</emphasis> With KVM this is the path on each host that is where this primary storage is mounted. For example, "/mnt/primary".</para></listitem> + <listitem><para><emphasis role="bold">SR Name-Label (for PreSetup).</emphasis> Enter the name-label of the SR that has been set up outside &PRODUCT;.</para></listitem> + <listitem><para><emphasis role="bold">Target IQN (for iSCSI).</emphasis> In iSCSI this is the IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para></listitem> + <listitem><para><emphasis role="bold">Lun # (for iSCSI).</emphasis> In iSCSI this is the LUN number. For example, 3.</para></listitem> + <listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings..</para></listitem> + </itemizedlist> + <para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para> + </listitem> + <listitem><para>Click OK.</para></listitem> + </orderedlist> + + </section> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/00fe63ac/docs/en-US/secondary-storage-add.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/secondary-storage-add.xml b/docs/en-US/secondary-storage-add.xml index 15e8c74..e1f45cd 100644 --- a/docs/en-US/secondary-storage-add.xml +++ b/docs/en-US/secondary-storage-add.xml @@ -23,6 +23,26 @@ --> <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>(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>TODO</para> + <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>Be sure there is nothing stored on the server. Adding the server to &PRODUCT; will destroy any existing data.</para></warning> + <orderedlist> + <listitem><para>If you are going to use Swift for cloud-wide secondary storage, you must add the Swift storage to &PRODUCT; before you add the local zone secondary storage servers. See <xref linkend="zone-add" />.</para></listitem> + <listitem><para>To prepare for local zone secondary storage, 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></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>Now that the secondary storage server for per-zone storage is prepared, add it to &PRODUCT;. Secondary storage is added as part of the procedure for adding a new zone. See <xref linkend="zone-add" />.</para></listitem> + </orderedlist> + </section> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/00fe63ac/docs/publican-all.cfg ---------------------------------------------------------------------- diff --git a/docs/publican-all.cfg b/docs/publican-all.cfg index d338738..897f92b 100644 --- a/docs/publican-all.cfg +++ b/docs/publican-all.cfg @@ -25,3 +25,4 @@ docname: cloudstack brand: cloudstack chunk_first: 1 chunk_section_depth: 1 +condition: install http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/00fe63ac/docs/publican-install.cfg ---------------------------------------------------------------------- diff --git a/docs/publican-install.cfg b/docs/publican-install.cfg index 708200d..64eeed9 100644 --- a/docs/publican-install.cfg +++ b/docs/publican-install.cfg @@ -24,6 +24,4 @@ docname: cloudstack_installation brand: cloudstack chunk_first: 1 chunk_section_depth: 1 - - - +condition: install
