Add more About ... sections to Infrastructure Concepts documentation, plus small fix to image alt text in About Zones.
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/e88b1721 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/e88b1721 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/e88b1721 Branch: refs/heads/master Commit: e88b1721ee9f18a5c594fa7d6300ae503cbc993d Parents: d9864e3 Author: Jessica Tomechak <[email protected]> Authored: Thu Aug 9 22:56:47 2012 -0700 Committer: Jessica Tomechak <[email protected]> Committed: Thu Aug 9 22:56:47 2012 -0700 ---------------------------------------------------------------------- docs/en-US/about-clusters.xml | 20 ++++++++++++++++++++ docs/en-US/about-hosts.xml | 26 ++++++++++++++++++++++++++ docs/en-US/about-primary-storage.xml | 16 ++++++++++++++++ docs/en-US/about-secondary-storage.xml | 16 ++++++++++++++++ docs/en-US/about-zones.xml | 2 +- 5 files changed, 79 insertions(+), 1 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e88b1721/docs/en-US/about-clusters.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/about-clusters.xml b/docs/en-US/about-clusters.xml new file mode 100644 index 0000000..944c566 --- /dev/null +++ b/docs/en-US/about-clusters.xml @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<section id="about-clusters"> + <title>About Clusters</title> + <para>A cluster provides a way to group hosts. To be precise, a cluster is a XenServer server pool, a set of KVM servers, a set of OVM hosts, or a VMware cluster preconfigured in vCenter. The hosts in a cluster all have identical hardware, run the same hypervisor, are on the same subnet, and access the same shared primary storage. Virtual machine instances (VMs) can be live-migrated from one host to another within the same cluster, without interrupting service to the user.</para> + <para>A cluster is the third-largest organizational unit within a &PRODUCT; deployment. Clusters are contained within pods, and pods are contained within zones. Size of the cluster is limited by the underlying hypervisor, although the &PRODUCT; recommends less in most cases; see Best Practices.</para> + <para>A cluster consists of one or more hosts and one or more primary storage servers.</para> + <mediaobject> + <imageobject> + <imagedata fileref="./images/cluster-overview.png" /> + </imageobject> + <textobject><phrase>cluster-overview.png: Structure of a simple cluster</phrase></textobject> + </mediaobject> + <para>&PRODUCT; allows multiple clusters in a cloud deployment.</para> + <para>Even when local storage is used, clusters are still required. In this case, there is just one host per cluster.</para> + <para>When VMware is used, every VMware cluster is managed by a vCenter server. Administrator must register the vCenter server with &PRODUCT;. There may be multiple vCenter servers per zone. Each vCenter server may manage multiple VMware clusters.</para> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e88b1721/docs/en-US/about-hosts.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/about-hosts.xml b/docs/en-US/about-hosts.xml new file mode 100644 index 0000000..11a7449 --- /dev/null +++ b/docs/en-US/about-hosts.xml @@ -0,0 +1,26 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<section id="about-hosts"> + <title>About Hosts</title> + <para>A host is a single computer. Hosts provide the computing resources that run the guest virtual machines. Each host has hypervisor software installed on it to manage the guest VMs. For example, a Linux KVM-enabled server, a Citrix XenServer server, and an ESXi server are hosts.</para> + <para>The host is the smallest organizational unit within a &PRODUCT; deployment. Hosts are contained within clusters, clusters are contained within pods, and pods are contained within zones.</para> + <para>Hosts in a &PRODUCT; deployment:</para> + <itemizedlist> + <listitem><para>Provde the CPU, memory, storage, and networking resources needed to host the virtual machines</para></listitem> + <listitem><para>Interconnect using a high bandwidth TCP/IP network and connect to the Internet</para></listitem> + <listitem><para>May reside in multiple data centers across different geographic locations</para></listitem> + <listitem><para>May have different capacities (different CPU speeds, different amounts of RAM, etc.), although the hosts within a cluster must all be homogeneous</para></listitem> + </itemizedlist> + <para>Additional hosts can be added at any time to provide more capacity for guest VMs.</para> + <para>&PRODUCT; automatically detects the amount of CPU and memory resources provided by the Hosts.</para> + <para>Hosts are not visible to the end user. An end user cannot determine which host their guest has been assigned to.</para> + <para>For a host to function in &PRODUCT;, you must do the following:</para> + <itemizedlist> + <listitem><para>Install hypervisor software on the host</para></listitem> + <listitem><para>Assign an IP address to the host</para></listitem> + <listitem><para>Ensure the host is connected to the &PRODUCT; Management Server</para></listitem> + </itemizedlist> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e88b1721/docs/en-US/about-primary-storage.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/about-primary-storage.xml b/docs/en-US/about-primary-storage.xml new file mode 100644 index 0000000..99b2402 --- /dev/null +++ b/docs/en-US/about-primary-storage.xml @@ -0,0 +1,16 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<section id="about-primary-storage"> + <title>About Primary Storage</title> + <para>Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster. You can add multiple primary storage servers to a cluster. At least one is required. It is typically located close to the hosts for increased performance.</para> + <para>&PRODUCT; is designed to work with all standards-compliant iSCSI and NFS servers that are supported by the underlying hypervisor, including, for example:</para> + <itemizedlist> + <listitem><para>Dell EqualLogic⢠for iSCSI</para></listitem> + <listitem><para>Network Appliances filers for NFS and iSCSI</para></listitem> + <listitem><para>Scale Computing for NFS</para></listitem> + </itemizedlist> + <para>If you intend to use only local disk for your installation, you can skip to Add Secondary Storage.</para> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e88b1721/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 new file mode 100644 index 0000000..70e3f79 --- /dev/null +++ b/docs/en-US/about-secondary-storage.xml @@ -0,0 +1,16 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<section id="about-secondary-storage"> + <title>About Secondary Storage</title> + <para>Secondary storage is associated with a zone, and it 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> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e88b1721/docs/en-US/about-zones.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/about-zones.xml b/docs/en-US/about-zones.xml index 97d1b34..313df76 100644 --- a/docs/en-US/about-zones.xml +++ b/docs/en-US/about-zones.xml @@ -15,7 +15,7 @@ <imageobject> <imagedata fileref="./images/zone-overview.png" /> </imageobject> - <textobject><phrase>pod-overview.png: Nested structure of a simple pod</phrase></textobject> + <textobject><phrase>zone-overview.png: Nested structure of a simple zone</phrase></textobject> </mediaobject> <para>Zones are visible to the end user. When a user starts a guest VM, the user must select a zone for their guest. Users might also be required to copy their private templates to additional zones to enable creation of guest VMs using their templates in those zones.</para> <para>Zones can be public or private. Public zones are visible to all users. This means that any user may create a guest in that zone. Private zones are reserved for a specific domain. Only users in that domain or its subdomains may create guests in that zone.</para>
