CLOUDSTACK-1597: Docbook xml for 'Storage Setup' section
Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/78ffb7ae Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/78ffb7ae Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/78ffb7ae Branch: refs/heads/portablepublicip Commit: 78ffb7ae5ef9c4383f86fa97cd647316dde507be Parents: 2a4184b Author: Gavin Lee <[email protected]> Authored: Mon May 13 16:26:27 2013 +0800 Committer: Gavin Lee <[email protected]> Committed: Mon May 13 16:26:27 2013 +0800 ---------------------------------------------------------------------- docs/en-US/Installation_Guide.xml | 1 + docs/en-US/storage-setup.xml | 192 ++++++++++++++++++++++++++++++++ 2 files changed, 193 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78ffb7ae/docs/en-US/Installation_Guide.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/Installation_Guide.xml b/docs/en-US/Installation_Guide.xml index e6a8031..ea97f25 100644 --- a/docs/en-US/Installation_Guide.xml +++ b/docs/en-US/Installation_Guide.xml @@ -55,6 +55,7 @@ <xi:include href="choosing-a-hypervisor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="aws-interface-compatibility.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="network-setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="storage-setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="best-practices.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="Revision_History_Install_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78ffb7ae/docs/en-US/storage-setup.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/storage-setup.xml b/docs/en-US/storage-setup.xml new file mode 100644 index 0000000..dee2f4c --- /dev/null +++ b/docs/en-US/storage-setup.xml @@ -0,0 +1,192 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter 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. +--> +<chapter id="storage-setup"> + <title>Storage Setup</title> + <para>&PRODUCT; is designed to work with a wide variety of commodity and enterprise-grade storage. Local disk may be used as well, if supported by the selected hypervisor. Storage type support for guest virtual disks differs based on hypervisor selection.</para> + <informaltable> + <tgroup cols="4" align="left" colsep="1" rowsep="1"> + <thead> + <row> + <entry><para></para></entry> + <entry><para>XenServer</para></entry> + <entry><para>vSphere</para></entry> + <entry><para>KVM</para></entry> + </row> + </thead> + <tbody> + <row> + <entry><para>NFS</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + <row> + <entry><para>iSCSI</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported via VMFS</para></entry> + <entry><para>Supported via Clustered Filesystems</para></entry> + </row> + <row> + <entry><para>Fiber Channel</para></entry> + <entry><para>Supported via Pre-existing SR</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported via Clustered Filesystems</para></entry> + </row> + <row> + <entry><para>Local Disk</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + </tbody> + </tgroup> + </informaltable> + <para>The use of the Cluster Logical Volume Manager (CLVM) for KVM is not officially supported with &PRODUCT;.</para> + <section id="storage-set-small-scale"> + <title>Small-Scale Setup</title> + <para>In a small-scale setup, a single NFS server can function as both primary and secondary storage. The NFS server just needs to export two separate shares, one for primary storage and the other for secondary storage.</para> + </section> + <section id="storage-set-secondary"> + <title>Secondary Storage</title> + <para>&PRODUCT; is designed to work with any scalable secondary storage system. The only requirement is the secondary storage system supports the NFS protocol.</para> + <note> + <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. Modern hardware RAID controllers support hot plug functionality independent of the operating system so you can replace faulty disks without impacting the running operating system.</para> + </note> + </section> + <section id="storage-set-example-config"> + <title>Example Configurations</title> + <para>In this section we go through a few examples of how to set up storage to work properly on a few types of NFS and iSCSI storage systems.</para> + <section id="storage-set-example-config-local-das"> + <title>Linux NFS on Local Disks and DAS</title> + <para>This section describes how to configure an NFS export on a standard Linux installation. The exact commands might vary depending on the operating system version.</para> + <orderedlist> + <listitem><para>Install the RHEL/CentOS distribution on the storage server.</para></listitem> + <listitem><para>If the root volume is more than 2 TB in size, create a smaller boot volume to install RHEL/CentOS. A root volume of 20 GB should be sufficient.</para></listitem> + <listitem><para>After the system is installed, create a directory called /export. This can each be a directory in the root partition itself or a mount point for a large disk volume.</para></listitem> + <listitem><para>If you have more than 16TB of storage on one host, create multiple EXT3 file systems and multiple NFS exports. Individual EXT3 file systems cannot exceed 16TB.</para></listitem> + <listitem> + <para>After /export directory is created, run the following command to configure it as an NFS export.</para> + <programlisting># echo "/export <CIDR>(rw,async,no_root_squash)" >> /etc/exports</programlisting> + <para>Adjust the above command to suit your deployment needs.</para> + <itemizedlist> + <listitem> + <para><emphasis role="bold">Limiting NFS export.</emphasis> It is highly recommended that you limit the NFS export to a particular subnet by specifying a subnet mask (e.g.,â192.168.1.0/24â). By allowing access from only within the expected cluster, you avoid having non-pool member mount the storage. The limit you place must include the management network(s) and the storage network(s). If the two are the same network then one CIDR is sufficient. If you have a separate storage network you must provide separate CIDRâs for both or one CIDR that is broad enough to span both.</para> + <para>The following is an example with separate CIDRs:</para> + <programlisting>/export 192.168.1.0/24(rw,async,no_root_squash) 10.50.1.0/24(rw,async,no_root_squash)</programlisting> + </listitem> + <listitem> + <para><emphasis role="bold">Removing the async flag.</emphasis> The async flag improves performance by allowing the NFS server to respond before writes are committed to the disk. Remove the async flag in your mission critical production deployment.</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>Run the following command to enable NFS service.</para> + <programlisting># chkconfig nfs on</programlisting> + </listitem> + <listitem> + <para>Edit the /etc/sysconfig/nfs file and uncomment the following lines.</para> + <programlisting>LOCKD_TCPPORT=32803 +LOCKD_UDPPORT=32769 +MOUNTD_PORT=892 +RQUOTAD_PORT=875 +STATD_PORT=662 +STATD_OUTGOING_PORT=2020</programlisting> + </listitem> + <listitem> + <para>Edit the /etc/sysconfig/iptables file and add the following lines at the beginning of the INPUT chain.</para> + <programlisting> +-A INPUT -m state --state NEW -p udp --dport 111 -j ACCEPT +-A INPUT -m state --state NEW -p tcp --dport 111 -j ACCEPT +-A INPUT -m state --state NEW -p tcp --dport 2049 -j ACCEPT +-A INPUT -m state --state NEW -p tcp --dport 32803 -j ACCEPT +-A INPUT -m state --state NEW -p udp --dport 32769 -j ACCEPT +-A INPUT -m state --state NEW -p tcp --dport 892 -j ACCEPT +-A INPUT -m state --state NEW -p udp --dport 892 -j ACCEPT +-A INPUT -m state --state NEW -p tcp --dport 875 -j ACCEPT +-A INPUT -m state --state NEW -p udp --dport 875 -j ACCEPT +-A INPUT -m state --state NEW -p tcp --dport 662 -j ACCEPT +-A INPUT -m state --state NEW -p udp --dport 662 -j ACCEPT + </programlisting> + </listitem> + <listitem> + <para>Reboot the server.</para> + <para>An NFS share called /export is now set up.</para> + </listitem> + </orderedlist> + <note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note> + </section> + <section id="storage-set-example-config-iscsi"> + <title>Linux NFS on iSCSI</title> + <para>Use the following steps to set up a Linux NFS server export on an iSCSI volume. These steps apply to RHEL/CentOS 5 distributions.</para> + <orderedlist> + <listitem> + <para>Install iscsiadm.</para> + <programlisting> +# yum install iscsi-initiator-utils +# service iscsi start +# chkconfig --add iscsi +# chkconfig iscsi on + </programlisting> + </listitem> + <listitem> + <para>Discover the iSCSI target.</para> + <programlisting># iscsiadm -m discovery -t st -p <iSCSI Server IP address>:3260</programlisting> + <para>For example:</para> + <programlisting># iscsiadm -m discovery -t st -p 172.23.10.240:3260 + 172.23.10.240:3260,1 iqn.2001-05.com.equallogic:0-8a0906-83bcb3401-16e0002fd0a46f3d-rhel5-test </programlisting> + </listitem> + <listitem> + <para>Log in.</para> + <programlisting># iscsiadm -m node -T <Complete Target Name> -l -p <Group IP>:3260</programlisting> + <para>For example:</para> + <programlisting># iscsiadm -m node -l -T iqn.2001-05.com.equallogic:83bcb3401-16e0002fd0a46f3d-rhel5-test -p 172.23.10.240:3260 </programlisting> + </listitem> + <listitem> + <para>Discover the SCSI disk. For example:</para> + <programlisting> +# iscsiadm -m session -P3 | grep Attached +Attached scsi disk sdb State: running + </programlisting> + </listitem> + <listitem> + <para>Format the disk as ext3 and mount the volume.</para> + <programlisting># mkfs.ext3 /dev/sdb +# mkdir -p /export +# mount /dev/sdb /export + </programlisting> + </listitem> + <listitem> + <para>Add the disk to /etc/fstab to make sure it gets mounted on boot.</para> + <programlisting>/dev/sdb /export ext3 _netdev 0 0</programlisting> + </listitem> + </orderedlist> + <para>Now you can set up /export as an NFS share.</para> + <itemizedlist> + <listitem> + <para><emphasis role="bold">Limiting NFS export.</emphasis> In order to avoid data loss, it is highly recommended that you limit the NFS export to a particular subnet by specifying a subnet mask (e.g.,â192.168.1.0/24â). By allowing access from only within the expected cluster, you avoid having non-pool member mount the storage and inadvertently delete all its data. The limit you place must include the management network(s) and the storage network(s). If the two are the same network then one CIDR is sufficient. If you have a separate storage network you must provide separate CIDRs for both or one CIDR that is broad enough to span both. </para> + <para>The following is an example with separate CIDRs:</para> + <programlisting>/export 192.168.1.0/24(rw,async,no_root_squash) 10.50.1.0/24(rw,async,no_root_squash)</programlisting> + </listitem> + <listitem><para><emphasis role="bold">Removing the async flag.</emphasis> The async flag improves performance by allowing the NFS server to respond before writes are committed to the disk. Remove the async flag in your mission critical production deployment.</para></listitem> + </itemizedlist> + </section> + </section> + </chapter>
