CLOUDSTACK-4334. Documentation for object store.
Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/c2cde0b4 Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/c2cde0b4 Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/c2cde0b4 Branch: refs/heads/4.2 Commit: c2cde0b463916f4be3316dd4a8572fa96392b1d5 Parents: f000081 Author: Jessica <[email protected]> Authored: Mon Aug 26 12:44:56 2013 -0700 Committer: Jessica <[email protected]> Committed: Mon Aug 26 12:44:56 2013 -0700 ---------------------------------------------------------------------- docs/en-US/about-secondary-storage.xml | 22 ++++++++++++-- docs/en-US/about-zones.xml | 18 ++++++++++++ docs/en-US/primary-storage-add.xml | 6 ++-- docs/en-US/secondary-storage-add.xml | 45 +++++++++++++++++++++++++++-- docs/en-US/zone-add.xml | 35 ++-------------------- 5 files changed, 86 insertions(+), 40 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2cde0b4/docs/en-US/about-secondary-storage.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/about-secondary-storage.xml b/docs/en-US/about-secondary-storage.xml index c5b4f5d..516ec0e 100644 --- a/docs/en-US/about-secondary-storage.xml +++ b/docs/en-US/about-secondary-storage.xml @@ -24,12 +24,28 @@ <section id="about-secondary-storage"> <title>About Secondary Storage</title> - <para>Secondary storage is associated with a zone, and it stores the following:</para> + <para>Secondary storage stores the following:</para> <itemizedlist> <listitem><para>Templates — OS images that can be used to boot VMs and can include additional configuration information, such as installed applications</para></listitem> <listitem><para>ISO images — disc images containing data or bootable media for operating systems</para></listitem> <listitem><para>Disk volume snapshots — saved copies of VM data which can be used for data recovery or to create new templates</para></listitem> </itemizedlist> - <para>The items in zone-based NFS secondary storage are available to all hosts in the zone. &PRODUCT; manages the allocation of guest virtual disks to particular primary storage devices.</para> - <para>To make items in secondary storage available to all hosts throughout the cloud, you can add OpenStack Object Storage (Swift, <ulink url="http://swift.openstack.org";>swift.openstack.org</ulink>) in addition to the zone-based NFS secondary storage. When using Swift, you configure Swift storage for the entire &PRODUCT;, then set up NFS secondary storage for each zone as usual. The NFS storage in each zone acts as a staging area through which all templates and other secondary storage data pass before being forwarded to Swift. The Swift storage acts as a cloud-wide resource, making templates and other data available to any zone in the cloud. There is no hierarchy in the Swift storage, just one Swift container per storage object. Any secondary storage in the whole cloud can pull a container from Swift at need. It is not necessary to copy templates and snapshots from one zone to another, as would be required when using zone NFS alone. Everything is available everywhere.</para> + <para>The items in secondary storage are available to all hosts in the scope of + the secondary storage, which may be defined as per zone or per region.</para> + <para>To make items in secondary storage available to all hosts throughout the cloud, you can + add object storage in addition to the + zone-based NFS Secondary Staging Store. + It is not necessary to + copy templates and snapshots from one zone to another, as would be required when using zone + NFS alone. Everything is available everywhere.</para> + <para>&PRODUCT; provides plugins that enable both + OpenStack Object Storage (Swift, + <ulink url="http://swift.openstack.org";>swift.openstack.org</ulink>) + and Amazon Simple Storage Service (S3) object storage. + When using one of these storage plugins, you configure Swift or S3 storage for + the entire &PRODUCT;, then set up the NFS Secondary Staging Store for each zone. The NFS + storage in each zone acts as a staging area through which all templates and other secondary + storage data pass before being forwarded to Swoft or S3. + The backing object storage acts as a cloud-wide + resource, making templates and other data available to any zone in the cloud.</para> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2cde0b4/docs/en-US/about-zones.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/about-zones.xml b/docs/en-US/about-zones.xml index 44f9b4d..d23058f 100644 --- a/docs/en-US/about-zones.xml +++ b/docs/en-US/about-zones.xml @@ -55,4 +55,22 @@ </itemizedlist> <para>When you add a new zone using the &PRODUCT; UI, you will be prompted to configure the zoneâs physical network and add the first pod, cluster, host, primary storage, and secondary storage.</para> + <para>In order to support zone-wide primary storage for VMware, changes have been made so + that &PRODUCT; is now aware of VMware Datacenters and can map each Datacenter to a + &PRODUCT; zone. Previously, &PRODUCT; was only aware of VMware Clusters, a smaller + organizational unit than Datacenters. This implies that a single &PRODUCT; zone could + possibly contain clusters from different VMware Datacenters. In order for zone-wide + primary storage to work for VMware hosts, &PRODUCT; has to make sure that a zone + contains only a single VMware Datacenter. Therefore, when you are creating a new + &PRODUCT; zone, you will now be able to select a VMware Datacenter for the zone. If you + are provisioning multiple VMware Datacenters, each one will be set up as a single zone + in &PRODUCT;. </para> + <note> + <para>If you are upgrading from a previous &PRODUCT; version, and your existing + deployment contains a zone with clusters from multiple VMware Datacenters, that zone + will not be forcibly migrated to the new model. It will continue to function as + before. However, any new zone-wide operations, such as zone-wide primary storage, will + not be available in that zone.</para> + </note> + <para/> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2cde0b4/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 52048ed..d8a81f6 100644 --- a/docs/en-US/primary-storage-add.xml +++ b/docs/en-US/primary-storage-add.xml @@ -52,8 +52,10 @@ <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>Scope. Indicate whether the storage is available to all hosts in the zone or only to hosts in a single cluster.</para></listitem> + <listitem><para>Pod. (Visible only if you choose Cluster in the Scope field.) The pod for the storage device.</para></listitem> + <listitem><para>Cluster. (Visible only if you choose Cluster in the Scope field.) The cluster for the storage device.</para></listitem> + <listitem><para>Name. The name of 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> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2cde0b4/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 e1f45cd..9dd1e7d 100644 --- a/docs/en-US/secondary-storage-add.xml +++ b/docs/en-US/secondary-storage-add.xml @@ -39,10 +39,49 @@ <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>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></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> + <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, or NFS, 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.</para> + <warning><para>You can use only a single S3 or Swift account per region.</para></warning></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>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> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2cde0b4/docs/en-US/zone-add.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/zone-add.xml b/docs/en-US/zone-add.xml index 3ca5789..841f7ee 100644 --- a/docs/en-US/zone-add.xml +++ b/docs/en-US/zone-add.xml @@ -1,4 +1,4 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml vrsion='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; @@ -24,46 +24,17 @@ <section id="zone-add"> <title>Adding a Zone</title> - <para>These steps assume you have already logged in to the &PRODUCT; UI. See <xref linkend="log-in" />.</para> + <para>When you add a new zone, you will be prompted to configure the zoneâs physical network and add the first pod, cluster, host, primary storage, and secondary storage.</para> <orderedlist> - <listitem><para>(Optional) If you are going to use Swift for cloud-wide secondary storage, you need to add it before you add zones.</para> - <orderedlist numeration="loweralpha"> - <listitem><para>Log in to the &PRODUCT; UI as administrator.</para></listitem> - <listitem><para>If this is your first time visiting the UI, you will see the guided tour splash screen. Choose âExperienced user.â The Dashboard appears.</para></listitem> - <listitem><para>In the left navigation bar, click Global Settings.</para></listitem> - <listitem><para>In the search box, type swift.enable and click the search button.</para></listitem> - <listitem><para>Click the edit button and set swift.enable to true. - <inlinemediaobject> - <imageobject> - <imagedata fileref="./images/edit-icon.png" /> - </imageobject> - <textobject><phrase>edit-icon.png: button to modify data</phrase></textobject> - </inlinemediaobject> - </para> - </listitem> - <listitem><para>Restart the Management Server.</para> - <programlisting># service cloudstack-management restart</programlisting> - </listitem> - <listitem><para>Refresh the &PRODUCT; UI browser tab and log back in.</para></listitem> - </orderedlist> - </listitem> + <listitem><para>Log in to the &PRODUCT; UI as the root administrator. See <xref linkend="log-in" />.</para></listitem> <listitem><para>In the left navigation, choose Infrastructure.</para></listitem> <listitem><para>On Zones, click View More.</para></listitem> - <listitem><para>(Optional) If you are using Swift storage, click Enable Swift. Provide the following:</para> - <itemizedlist> - <listitem><para><emphasis role="bold">URL.</emphasis> The Swift URL.</para></listitem> - <listitem><para><emphasis role="bold">Account.</emphasis> The Swift account.</para></listitem> - <listitem><para><emphasis role="bold">Username.</emphasis> The Swift accountâs username.</para></listitem> - <listitem><para><emphasis role="bold">Key.</emphasis> The Swift key.</para></listitem> - </itemizedlist> - </listitem> <listitem><para>Click Add Zone. The zone creation wizard will appear.</para></listitem> <listitem><para>Choose one of the following network types:</para> <itemizedlist> <listitem><para><emphasis role="bold">Basic.</emphasis> For AWS-style networking. Provides a single network where each VM instance is assigned an IP directly from the network. Guest isolation can be provided through layer-3 means such as security groups (IP address source filtering).</para></listitem> <listitem><para><emphasis role="bold">Advanced.</emphasis> For more sophisticated network topologies. This network model provides the most flexibility in defining guest networks and providing custom network offerings such as firewall, VPN, or load balancer support.</para></listitem> </itemizedlist> - <para>For more information about the network types, see <xref linkend="about-physical-networks" />.</para> </listitem> <listitem><para>The rest of the steps differ depending on whether you chose Basic or Advanced. Continue with the steps that apply to you:</para> <itemizedlist>
