You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by al...@apache.org on 2012/07/17 00:44:06 UTC
[17/22] adding docs
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/vpn.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vpn.xml b/docs/en-US/vpn.xml
new file mode 100644
index 0000000..31b7a64
--- /dev/null
+++ b/docs/en-US/vpn.xml
@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="vpn">
+ <title>VPN</title>
+ <para>CloudPlatform account owners can create virtual private networks (VPN) to access their virtual machines. If the guest network is instantiated from a network offering that offers the Remote Access VPN service, the virtual router (based on the System VM) is used to provide the service. CloudPlatform provides a L2TP-over-IPsec-based remote access VPN service to guest virtual networks. Since each network gets its own virtual router, VPNs are not shared across the networks. VPN clients native to Windows, Mac OS X and iOS can be used to connect to the guest networks. The account owner can create and manage users for their VPN. CloudPlatform does not use its account database for this purpose but uses a separate table. The VPN user database is shared across all the VPNs created by the account owner. All VPN users get access to all VPNs created by the account owner.</para>
+ <note><para>Make sure that not all traffic goes through the VPN. That is, the route installed by the VPN should be only for the guest network and not for all traffic.</para></note>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Road Warrior / Remote Access</emphasis>. Users want to be able to
+ connect securely from a home or office to a private network in the cloud. Typically,
+ the IP address of the connecting client is dynamic and cannot be preconfigured on
+ the VPN server.</para></listitem>
+ <listitem><para><emphasis role="bold">Site to Site</emphasis>. In this scenario, two private subnets are
+ connected over the public Internet with a secure VPN tunnel. The cloud user’s subnet
+ (for example, an office network) is connected through a gateway to the network in
+ the cloud. The address of the user’s gateway must be preconfigured on the VPN server
+ in the cloud. Note that although L2TP-over-IPsec can be used to set up Site-to-Site
+ VPNs, this is not the primary intent of this feature.</para></listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/whatis.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whatis.xml b/docs/en-US/whatis.xml
new file mode 100644
index 0000000..89348c5
--- /dev/null
+++ b/docs/en-US/whatis.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="whatis">
+ <title>What Is &PRODUCT;?</title>
+ <para>
+ &PRODUCT; is an open source software platform that pools computing resources to build public, private, and hybrid Infrastructure as a Service (IaaS) clouds. &PRODUCT; manages the network, storage, and compute nodes that make up a cloud infrastructure. Use &PRODUCT; to deploy, manage, and configure cloud computing environments.
+ </para>
+ <para>Typical users are service providers and enterprises. With &PRODUCT;, you can:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Set up an on-demand, elastic cloud computing service. Service providers can sell self service virtual machine instances, storage volumes, and networking configurations over the Internet.
+ </para></listitem>
+ <listitem>
+ <para>Set up an on-premise private cloud for use by employees. Rather than managing virtual machines in the same way as physical machines, with &PRODUCT; an enterprise can offer self-service virtual machines to users without involving IT departments.
+ </para></listitem>
+ </itemizedlist>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/1000-foot-view.png" />
+ </imageobject>
+ <textobject><phrase>1000-foot-view.png: Overview of &PRODUCT;</phrase></textobject>
+ </mediaobject>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/whats-in-this-adminguide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-in-this-adminguide.xml b/docs/en-US/whats-in-this-adminguide.xml
new file mode 100644
index 0000000..94129a4
--- /dev/null
+++ b/docs/en-US/whats-in-this-adminguide.xml
@@ -0,0 +1,7 @@
+<section id="whats-in-this-adminguide">
+ <title>Who Should Read This</title>
+ <para>If you have already installed CloudPlatform or you want to learn more about the ongoing
+ operation and maintenance of a CloudPlatform-powered cloud, read this documentation. It
+ will help you start using, configuring, and managing the ongoing operation of your cloud.</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/whats-new.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml
new file mode 100644
index 0000000..c1a6e0c
--- /dev/null
+++ b/docs/en-US/whats-new.xml
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter 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="whats-new">
+ <title>What's New in 3.0.x?</title>
+ <para>The following describes any new major features of each CloudPlatform version as it applies to API usage.</para>
+ <xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="change-to-behavior-of-list-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="added-cloudPlatform-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/who-should-read-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/who-should-read-installation.xml b/docs/en-US/who-should-read-installation.xml
new file mode 100644
index 0000000..0137811
--- /dev/null
+++ b/docs/en-US/who-should-read-installation.xml
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter 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="who-should-read-installation">
+ <title>Who Should Read This</title>
+ <para>
+ For those who have already gone through a design phase and planned a more sophisticated deployment,
+ or those who are ready to start scaling up a trial installation.
+ With the following procedures, you can start using the more powerful features of &PRODUCT;,
+ such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls,
+ and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere.
+ </para>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/windows-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/windows-installation.xml b/docs/en-US/windows-installation.xml
new file mode 100644
index 0000000..46044bc
--- /dev/null
+++ b/docs/en-US/windows-installation.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="windows-installation">
+ <title>Windows OS Installation</title>
+ <para>Download the installer, CloudInstanceManager.msi, from <ulink url="http://cloudstack.org/download.html">Download page</ulink> and run the installer in the newly created Windows VM.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/work-with-usage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/work-with-usage.xml b/docs/en-US/work-with-usage.xml
new file mode 100644
index 0000000..d5d8802
--- /dev/null
+++ b/docs/en-US/work-with-usage.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="change-database-config">
+ <title>Changing the Database Configuration</title>
+ <para>The CloudPlatform Management Server stores database configuration information (e.g., hostname, port, credentials) in the file /etc/cloud/management/db.properties. To effect a change, edit this file on each Management Server, then restart the Management Server.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/working-with-hosts.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-hosts.xml b/docs/en-US/working-with-hosts.xml
new file mode 100644
index 0000000..7f65da3
--- /dev/null
+++ b/docs/en-US/working-with-hosts.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="removing-hosts">
+ <title>Removing Hosts</title>
+ <para>Hosts can be removed from the cloud as needed. The procedure to remove a host depends on the hypervisor type.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/working-with-iso.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-iso.xml b/docs/en-US/working-with-iso.xml
new file mode 100644
index 0000000..8b6f345
--- /dev/null
+++ b/docs/en-US/working-with-iso.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="working-with-iso">
+ <title>Working with ISOs</title>
+ <para>CloudPlatform supports ISOs and their attachment to guest VMs. An ISO is a read-only file that has an ISO/CD-ROM style file system. Users can upload their own ISOs and mount them on their guest VMs.</para>
+ <para>ISOs are uploaded based on a URL. HTTP is the supported protocol. Once the ISO is available via HTTP specify an upload URL such as http://my.web.server/filename.iso.</para>
+ <para>ISOs may be public or private, like templates.ISOs are not hypervisor-specific. That is, a guest on vSphere can mount the exact same image that a guest on KVM can mount.</para>
+ <para>ISO images may be stored in the system and made available with a privacy level similar to templates. ISO images are classified as either bootable or not bootable. A bootable ISO image is one that contains an OS image. CloudPlatform allows a user to boot a guest VM off of an ISO image. Users can also attach ISO images to guest VMs. For example, this enables installing PV drivers into Windows. ISO images are not hypervisor-specific.</para>
+ <xi:include href="add-iso.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="attach-iso-to-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/working-with-snapshots.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-snapshots.xml b/docs/en-US/working-with-snapshots.xml
new file mode 100644
index 0000000..1987b23
--- /dev/null
+++ b/docs/en-US/working-with-snapshots.xml
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="working-with-snapshots">
+ <title>Working with Snapshots</title>
+ <para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>,
+ <emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold"
+ >KVM</emphasis>)</para>
+ <para>CloudPlatform supports snapshots of disk volumes. Snapshots are a point-in-time capture of virtual machine disks. Memory and CPU states are not captured. If you are using the Oracle VM hypervisor, you can not take snapshots, since OVM does not support them.</para>
+ <para>Snapshots may be taken for volumes, including both root and data disks (except when the Oracle VM hypervisor is used, which does not support snapshots). The administrator places a limit on the number of stored snapshots per user. Users can create new volumes from the snapshot for recovery of particular files and they can create templates from snapshots to boot from a restored disk.</para>
+ <para>Users can create snapshots manually or by setting up automatic recurring snapshot policies. Users can also create disk volumes from snapshots, which may be attached to a VM like any other disk volume. Snapshots of both root disks and data disks are supported. However, CloudPlatform does not currently support booting a VM from a recovered root disk. A disk recovered from snapshot of a root disk is treated as a regular data disk; the data on recovered disk can be accessed by attaching the disk to a VM.</para>
+ <para>A completed snapshot is copied from primary storage to secondary storage, where it is stored until deleted or purged by newer snapshot.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/working-with-system-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-system-vm.xml b/docs/en-US/working-with-system-vm.xml
new file mode 100644
index 0000000..47b3976
--- /dev/null
+++ b/docs/en-US/working-with-system-vm.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="working-with-system-vm">
+ <title>Working with System Virtual Machines</title>
+ <para>CloudPlatform uses several types of system virtual machines to perform tasks in the cloud. In general CloudPlatform manages these system VMs and creates, starts, and stops them as needed based on scale and immediate needs. However, the administrator should be aware of them and their roles to assist in debugging issues.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/working-with-templates.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-templates.xml b/docs/en-US/working-with-templates.xml
new file mode 100644
index 0000000..6073f7b
--- /dev/null
+++ b/docs/en-US/working-with-templates.xml
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="working-with-templates">
+ <title>Working with Templates</title>
+ <para>A template is a reusable configuration for virtual machines. When users launch VMs, they can choose from a list of templates in CloudPlatform.</para>
+ <para>Specifically, a template is a virtual disk image that includes one of a variety of operating systems, optional additional software such as office applications, and settings such as access control to determine who can use the template. Each template is associated with a particular type of hypervisor, which is specified when the template is added to CloudPlatform.</para>
+ <para>CloudPlatform ships with a default template. In order to present more choices to users, CloudPlatform administrators and users can create templates and add them to CloudPlatform.</para>
+ <xi:include href="create-templates-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="requirements-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="best-practices-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="default-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="private-public-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="create-template-from-existing-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="create-template-from-snapshot.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="upload-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="export-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="create-windows-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="import-ami.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="create-bare-metal-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="convert-hyperv-vm-to-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="delete-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/working-with-usage-data.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-usage-data.xml b/docs/en-US/working-with-usage-data.xml
new file mode 100644
index 0000000..09a89df
--- /dev/null
+++ b/docs/en-US/working-with-usage-data.xml
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter 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="working-with-usage-data">
+ <title>Working With Usage Data</title>
+ <para>The Usage Server provides aggregated usage records which you can use to create billing integration for the CloudStack platform. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call.</para>
+ <para>The usage records show the amount of resources, such as VM run time or template storage space, consumed by guest instances. In the special case of bare metal instances, no template storage resources are consumed, but records showing zero usage are still included in the Usage Server's output.</para>
+ <para>The Usage Server runs at least once per day. It can be configured to run multiple times per day. Its behavior is controlled by configuration settings as described in the CloudStack Administration Guide.</para>
+ <xi:include href="usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="usage-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="example-response-from-listUsageRecords.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="dates-in-usage-record.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/working-with-volumes.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-volumes.xml b/docs/en-US/working-with-volumes.xml
new file mode 100644
index 0000000..5610672
--- /dev/null
+++ b/docs/en-US/working-with-volumes.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="working-with-volumes">
+ <title>Using Swift for Secondary Storage</title>
+ <para>A volume provides storage to a guest VM. The volume can provide for a root disk or an additional data disk. CloudPlatform supports additional volumes for guest VMs.</para>
+ <para>Volumes are created for a specific hypervisor type. A volume that has been attached to guest using one hypervisor type (e.g, XenServer) may not be attached to a guest that is using another hypervisor type (e.g. vSphere, Oracle VM, KVM). This is because the different hypervisors use different disk image formats.</para>
+ <para>CloudPlatform defines a volume as a unit of storage available to a guest VM. Volumes are either root disks or data disks. The root disk has “/” in the file system and is usually the boot device. Data disks provide for additional storage (e.g. As “/opt” or “D:”). Every guest VM has a root disk, and VMs can also optionally have a data disk. End users can mount multiple data disks to guest VMs. Users choose data disks from the disk offerings created by administrators. The user can create a template from a volume as well; this is the standard procedure for private template creation. Volumes are hypervisor-specific: a volume from one hypervisor type may not be used on a guest of another hypervisor type.</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/xenserver-maintenance-mode.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/xenserver-maintenance-mode.xml b/docs/en-US/xenserver-maintenance-mode.xml
new file mode 100644
index 0000000..f8811bf
--- /dev/null
+++ b/docs/en-US/xenserver-maintenance-mode.xml
@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section 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="xenserver-maintenance-mode">
+ <title>XenServer and Maintenance Mode</title>
+ <para>For XenServer, you can take a server offline temporarily by using the Maintenance Mode feature in XenCenter. When you place a server into Maintenance Mode, all running VMs are automatically migrated from it to another host in the same pool. If the server is the pool master, a new master will also be selected for the pool. While a server is Maintenance Mode, you cannot create or start any VMs on it.</para>
+ <para><emphasis role="bold">To place a server in Maintenance Mode:</emphasis></para>
+ <orderedlist>
+ <listitem><para>In the Resources pane, select the server, then do one of the following:</para>
+ <itemizedlist>
+ <listitem><para>Right-click, then click Enter Maintenance Mode on the shortcut menu.</para>
+ </listitem>
+ <listitem><para>On the Server menu, click Enter Maintenance Mode</para>
+ </listitem>
+ </itemizedlist></listitem>
+ <listitem><para>Click Enter Maintenance Mode</para></listitem>
+ </orderedlist>
+ <para>The server's status in the Resources pane shows when all running VMs have been successfully migrated off the server.</para>
+ <para><emphasis role="bold">To take a server out of Maintenance Mode:</emphasis></para>
+ <orderedlist>
+ <listitem><para>In the Resources pane, select the server, then do one of the following:</para>
+ <itemizedlist>
+ <listitem><para>Right-click, then click Exit Maintenance Mode on the shortcut menu.</para>
+ </listitem>
+ <listitem><para>On the Server menu, click Exit Maintenance Mode</para>
+ </listitem>
+ </itemizedlist></listitem>
+ <listitem><para>Click Exit Maintenance Mode</para></listitem>
+ </orderedlist>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/zone-add.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/zone-add.xml b/docs/en-US/zone-add.xml
new file mode 100644
index 0000000..7d68375
--- /dev/null
+++ b/docs/en-US/zone-add.xml
@@ -0,0 +1,58 @@
+<?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="zone-add">
+ <title>Adding a Zone</title>
+ <para>These steps assume you have already logged in to the CloudPlatform UI. See <xref linkend="log-in" />.</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 CloudPlatform 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 cloud-management restart</programlisting>
+ </listitem>
+ <listitem><para>Refresh the CloudPlatform UI browser tab and log back in.</para></listitem>
+ </orderedlist>
+ </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 Network Setup.</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>
+ <listitem><para><xref linkend="basic-zone-configuration" /></para></listitem>
+ <listitem><para><xref linkend="advanced-zone-configuration" /></para></listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+ <xi:include href="basic-zone-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="advanced-zone-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</section>