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
[10/22] adding docs
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/creating-system-service-offerings.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/creating-system-service-offerings.xml b/docs/en-US/creating-system-service-offerings.xml
new file mode 100644
index 0000000..7f9bf52
--- /dev/null
+++ b/docs/en-US/creating-system-service-offerings.xml
@@ -0,0 +1,34 @@
+<?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="creating-system-service-offerings">
+ <title>Creating a New System Service Offering</title>
+ <para>To create a system service offering:</para>
+ <orderedlist>
+ <listitem><para>Log in with admin privileges to the CloudPlatform UI.</para></listitem>
+ <listitem><para>In the left navigation bar, click Service Offerings.</para></listitem>
+ <listitem><para>In Select Offering, choose System Offering.</para></listitem>
+ <listitem><para>Click Add System Service Offering.</para></listitem>
+ <listitem><para>In the dialog, make the following choices:</para>
+ <itemizedlist>
+ <listitem><para>Name. Any desired name for the system offering.</para></listitem>
+ <listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem>
+ <listitem><para>System VM Type. Select the type of system virtual machine that this offering is intended to support.</para></listitem>
+ <listitem><para>Storage type. The type of disk that should be allocated. Local allocates from storage attached directly to the host where the system VM is running. Shared allocates from storage accessible via NFS.</para></listitem>
+ <listitem><para># of CPU cores. The number of cores which should be allocated to a system VM with this offering</para></listitem>
+ <listitem><para>CPU (in MHz). The CPU speed of the cores that the system VM is allocated. For example, “2000” would provide for a 2 GHz clock.</para></listitem>
+ <listitem><para>Memory (in MB). The amount of memory in megabytes that the system VM should be allocated. For example, “2048” would provide for a 2 GB RAM allocation.</para></listitem>
+ <listitem><para>Network Rate. Allowed data transfer rate in MB per second.</para></listitem>
+ <listitem><para>Offer HA. If yes, the administrator can choose to have the system VM be monitored and as highly available as possible.</para></listitem>
+ <listitem><para>Storage Tags. The tags that should be associated with the primary storage used by the system VM.</para></listitem>
+ <listitem><para>Host Tags. (Optional) Any tags that you use to organize your hosts</para></listitem>
+ <listitem><para>CPU cap. Whether to limit the level of CPU usage even if spare capacity is available.</para></listitem>
+ <listitem><para>Public. Indicate whether the service offering should be available all domains or only some domains. Choose Yes to make it available to all domains. Choose No to limit the scope to a subdomain; CloudPlatform will then prompt for the subdomain's name.</para></listitem>
+ </itemizedlist></listitem>
+ <listitem><para>Click Add.</para></listitem>
+ </orderedlist>
+
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/creating-vms.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/creating-vms.xml b/docs/en-US/creating-vms.xml
new file mode 100644
index 0000000..ea5d0f2
--- /dev/null
+++ b/docs/en-US/creating-vms.xml
@@ -0,0 +1,31 @@
+<?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="creating-vms">
+ <title>Creating VMs</title>
+ <para>Virtual machines are usually created from a template. Users can also create blank virtual machines. A blank virtual machine is a virtual machine without an OS template. Users can attach an ISO file and install the OS from the CD/DVD-ROM.</para>
+ <para>To create a VM from a template:</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as an administrator or user.</para></listitem>
+ <listitem><para>In the left navigation bar, click Instances.</para></listitem>
+ <listitem><para>Click Add Instance.</para></listitem>
+ <listitem><para>Select a template, then follow the steps in the wizard. (For more information about how the templates came to be in this list, see Working with Templates.</para></listitem>
+ <listitem><para>Be sure that the hardware you have allows starting the selected service offering.</para></listitem>
+ <listitem><para>Click Submit and your VM will be created and started.</para>
+ <note><para>For security reason, the internal name of the VM is visible only to the root admin.</para></note></listitem>
+ </orderedlist>
+ <note><para>Starting with v3.0.3, you can create a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A new request parameter, startVM, is introduced in the deployVm API to support this feature. For more information, see the Developer's Guide</para></note>
+ <para>To create a VM from an ISO:</para>
+ <note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para></note>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as an administrator or user.</para></listitem>
+ <listitem><para>In the left navigation bar, click Instances.</para></listitem>
+ <listitem><para>Click Add Instance.</para></listitem>
+ <listitem><para>Select ISO Boot, and follow the steps in the wizard.</para></listitem>
+ <listitem><para>Click Submit and your VM will be created and started.</para></listitem>
+ <listitem><para>(Oracle VM only) After ISO installation, the installer reboots into the operating system. Due to a known issue in OVM, the reboot will place the VM in the Stopped state. In the CloudPlatform UI, detach the ISO from the VM (so that the VM will not boot from the ISO again), then click the Start button to restart the VM.</para></listitem>
+ </orderedlist>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/customizing-dns.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/customizing-dns.xml b/docs/en-US/customizing-dns.xml
new file mode 100644
index 0000000..bf9dc41
--- /dev/null
+++ b/docs/en-US/customizing-dns.xml
@@ -0,0 +1,26 @@
+<?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="customizing-dns">
+ <title>Customizing the Network Domain Name</title>
+ <para>The root administrator can optionally assign a custom DNS suffix at the level of a network, account, domain, zone, or entire CloudPlatform installation, and a domain administrator can do so within their own domain. To specify a custom domain name and put it into effect, follow these steps.</para>
+ <orderedlist>
+ <listitem><para>Set the DNS suffix at the desired scope</para>
+ <itemizedlist>
+ <listitem><para>At the network level, the DNS suffix can be assigned through the UI when creating a new network, as described in <xref linkend="add-additional-guest-network"/> or with the updateNetwork command in the CloudPlatform API.</para></listitem>
+ <listitem><para>At the account, domain, or zone level, the DNS suffix can be assigned with the appropriate CloudPlatform API commands: createAccount, editAccount, createDomain, editDomain, createZone, or editZone.</para></listitem>
+ <listitem><para>At the global level, use the configuration parameter guest.domain.suffix. You can also use the CloudPlatform API command updateConfiguration. After modifying this global configuration, restart the Management Server to put the new setting into effect.</para></listitem>
+ </itemizedlist></listitem>
+ <listitem><para>To make the new DNS suffix take effect for an existing network, call the CloudPlatform API command updateNetwork. This step is not necessary when the DNS suffix was specified while creating a new network.</para></listitem>
+ </orderedlist>
+ <para>The source of the network domain that is used depends on the following rules.</para>
+ <itemizedlist>
+ <listitem><para>For all networks, if a network domain is specified as part of a network's own configuration, that value is used.</para></listitem>
+ <listitem><para>For an account-specific network, the network domain specified for the account is used. If none is specified, the system looks for a value in the domain, zone, and global configuration, in that order.</para></listitem>
+ <listitem><para>For a domain-specific network, the network domain specified for the domain is used. If none is specified, the system looks for a value in the zone and global configuration, in that order.</para></listitem>
+ <listitem><para>For a zone-specific network, the network domain specified for the zone is used. If none is specified, the system looks for a value in the global configuration.</para></listitem>
+ </itemizedlist>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/dates-in-usage-record.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/dates-in-usage-record.xml b/docs/en-US/dates-in-usage-record.xml
new file mode 100644
index 0000000..ff46587
--- /dev/null
+++ b/docs/en-US/dates-in-usage-record.xml
@@ -0,0 +1,8 @@
+ <section id="dates-in-usage-record">
+ <title>Dates in the Usage Record</title>
+ <para>Usage records include a start date and an end date. These dates define the period of time for which the raw usage number was calculated. If daily aggregation is used, the start date is midnight on the day in question and the end date is 23:59:59 on the day in question (with one exception; see below). A virtual machine could have been deployed at noon on that day, stopped at 6pm on that day, then started up again at 11pm. When usage is calculated on that day, there will be 7 hours of running VM usage (usage type 1) and 12 hours of allocated VM usage (usage type 2). If the same virtual machine runs for the entire next day, there will 24 hours of both running VM usage (type 1) and allocated VM usage (type 2).</para>
+ <para>Note: The start date is not the time a virtual machine was started, and the end date is not the time when a virtual machine was stopped. The start and end dates give the time range within which usage was calculated.</para>
+ <para>For network usage, the start date and end date again define the range in which the number of bytes transferred was calculated. If a user downloads 10 MB and uploads 1 MB in one day, there will be two records, one showing the 10 megabytes received and one showing the 1 megabyte sent.</para>
+ <para>There is one case where the start date and end date do not correspond to midnight and 11:59:59pm when daily aggregation is used. This occurs only for network usage records. When the usage server has more than one day's worth of unprocessed data, the old data will be included in the aggregation period. The start date in the usage record will show the date and time of the earliest event. For other types of usage, such as IP addresses and VMs, the old unprocessed data is not included in daily aggregation.</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/dedicated-ha-hosts.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/dedicated-ha-hosts.xml b/docs/en-US/dedicated-ha-hosts.xml
new file mode 100644
index 0000000..e985142
--- /dev/null
+++ b/docs/en-US/dedicated-ha-hosts.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="dedicated-ha-hosts">
+ <title>Dedicated HA Hosts</title>
+ <para>(v3.0.3 and greater) One or more hosts can be designated for use only by HA-enabled VMs that are restarting due to a host failure. Setting up a pool of such dedicated HA hosts as the recovery destination for all HA-enabled VMs is useful to:</para>
+ <itemizedlist>
+ <listitem><para>Make it easier to determine which VMs have been restarted as part of the CloudPlatform high-availability function. If a VM is running on a dedicated HA host, then it must be an HA-enabled VM whose original host failed. (With one exception: It is possible for an administrator to manually migrate any VM to a dedicated HA host.).</para></listitem>
+ <listitem><para>Keep HA-enabled VMs from restarting on hosts which may be reserved for other purposes.</para></listitem>
+ </itemizedlist>
+ <para>The dedicated HA option is set through a special host tag when the host is created. To allow the administrator to dedicate hosts to only HA-enabled VMs, set the global configuration variable ha.tag to the desired tag (for example, "ha_host"), and restart the Management Server. Enter the value in the Host Tags field when adding the host(s) that you want to dedicate to HA-enabled VMs.</para>
+ <note><para>If you set ha.tag, be sure to actually use that tag on at least one host in your cloud. If the tag specified in ha.tag is not set for any host in the cloud, the HA-enabled VMs will fail to restart after a crash.</para></note>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/default-account-resource-limit.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/default-account-resource-limit.xml b/docs/en-US/default-account-resource-limit.xml
new file mode 100644
index 0000000..0ace634
--- /dev/null
+++ b/docs/en-US/default-account-resource-limit.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="default-account-resource-limit">
+ <title>Default Account Resource Limits</title>
+ <para>You can limit resource use by accounts. The default limits are set using global configuration parameters, and they affect all accounts within a cloud. The relevant parameters are those beginning with max.account (max.account.snapshots, etc.)..</para>
+ <para>To override a default limit for a particular account, set a per-account resource limit.</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI.</para></listitem>
+ <listitem><para>In the left navigation tree, click Accounts.</para></listitem>
+ <listitem><para>Select the account you want to modify. The current limits are displayed. A value of -1 shows that there is no limit in place</para></listitem>
+ <listitem><para>Click the Edit button<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/edit-icon.png" />
+ </imageobject>
+ <textobject><phrase>editbutton.png: edits the settings.</phrase></textobject>
+ </inlinemediaobject></para></listitem>
+ </orderedlist>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/default-template.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/default-template.xml b/docs/en-US/default-template.xml
new file mode 100644
index 0000000..4f4e583
--- /dev/null
+++ b/docs/en-US/default-template.xml
@@ -0,0 +1,37 @@
+<?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="default-template">
+ <title>The Default Template</title>
+ <para>CloudPlatform includes a CentOS template. This template is downloaded by the Secondary Storage VM after the primary and secondary storage are configured. You can use this template in your production deployment or you can delete it and use custom templates.</para>
+ <para>The root password for the default template is "password".</para>
+ <para>A default template is provided for each of XenServer, KVM, and vSphere. The templates that are downloaded depend on the hypervisor type that is available in your cloud. Each template is approximately 2.5 GB physical size.</para>
+ <para>The default template includes the standard iptables rules, which will block most access to the template excluding ssh.</para>
+ <programlisting># iptables --list
+Chain INPUT (policy ACCEPT)
+target prot opt source destination
+RH-Firewall-1-INPUT all -- anywhere anywhere
+
+Chain FORWARD (policy ACCEPT)
+target prot opt source destination
+RH-Firewall-1-INPUT all -- anywhere anywhere
+
+Chain OUTPUT (policy ACCEPT)
+target prot opt source destination
+
+Chain RH-Firewall-1-INPUT (2 references)
+target prot opt source destination
+ACCEPT all -- anywhere anywhere
+ACCEPT icmp -- anywhere anywhere icmp any
+ACCEPT esp -- anywhere anywhere
+ACCEPT ah -- anywhere anywhere
+ACCEPT udp -- anywhere 224.0.0.251 udp dpt:mdns
+ACCEPT udp -- anywhere anywhere udp dpt:ipp
+ACCEPT tcp -- anywhere anywhere tcp dpt:ipp
+ACCEPT all -- anywhere anywhere state RELATED,ESTABLISHED
+ACCEPT tcp -- anywhere anywhere state NEW tcp dpt:ssh
+REJECT all -- anywhere anywhere reject-with icmp-host-
+</programlisting>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/delete-templates.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/delete-templates.xml b/docs/en-US/delete-templates.xml
new file mode 100644
index 0000000..d3f99b9
--- /dev/null
+++ b/docs/en-US/delete-templates.xml
@@ -0,0 +1,10 @@
+<?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="delete-templates">
+ <title>Deleting Templates</title>
+ <para>Templates may be deleted. In general, when a template spans multiple Zones, only the copy that is selected for deletion will be deleted; the same template in other Zones will not be deleted. The provided CentOS template is an exception to this. If the provided CentOS template is deleted, it will be deleted from all Zones.</para>
+ <para>When templates are deleted, the VMs instantiated from them will continue to run. However, new VMs cannot be created based on the deleted template.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/deleting-vms.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/deleting-vms.xml b/docs/en-US/deleting-vms.xml
new file mode 100644
index 0000000..a6cc0db
--- /dev/null
+++ b/docs/en-US/deleting-vms.xml
@@ -0,0 +1,23 @@
+<?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="deleting-vms">
+ <title>Deleting VMs</title>
+ <para>Users can delete their own virtual machines. A running virtual machine will be abruptly stopped before it is deleted. Administrators can delete any virtual machines.</para>
+ <para>To delete a virtual machine:</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
+ <listitem><para>In the left navigation, click Instances.</para></listitem>
+ <listitem><para>Choose the VM that you want to delete.</para></listitem>
+ <listitem><para>Click the Destroy Instance button <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/destroy-instance.png" />
+ </imageobject>
+ <textobject><phrase>Destroyinstance.png: button to destroy an instance</phrase></textobject>
+ </inlinemediaobject>
+ </para></listitem>
+ </orderedlist>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/deployment-architecture-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/deployment-architecture-overview.xml b/docs/en-US/deployment-architecture-overview.xml
new file mode 100644
index 0000000..25f0825
--- /dev/null
+++ b/docs/en-US/deployment-architecture-overview.xml
@@ -0,0 +1,25 @@
+<?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="deployment-architecture-overview">
+ <title>Deployment Architecture Overview</title>
+ <para>
+ A &PRODUCT; installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a &PRODUCT; cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources.
+ </para>
+ <para>
+ The minimum production installation consists of one machine running the &PRODUCT; Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software). In a trial installation, a single machine can act as both the Management Server and the hypervisor host (using the KVM hypervisor).
+ </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/basic-deployment.png" />
+ </imageobject>
+ <textobject><phrase>basic-deployment.png: Basic two-machine deployment</phrase></textobject>
+ </mediaobject>
+ <para>A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture.
+ </para>
+ <xi:include href="management-server-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="cloud-infrastructure-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="networking-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/deployment_architecture_overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/deployment_architecture_overview.xml b/docs/en-US/deployment_architecture_overview.xml
new file mode 100644
index 0000000..08c1082
--- /dev/null
+++ b/docs/en-US/deployment_architecture_overview.xml
@@ -0,0 +1,22 @@
+ <section id="deployment_architecture_overview">
+ <title>Deployment Architecture Overview</title>
+
+ <para>
+ A CloudStack installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a CloudStack cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources.
+ </para>
+ <para>
+ The minimum installation consists of one machine running the CloudStack Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software).
+ </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/basic_deployment.png" />
+ </imageobject>
+ <textobject><phrase>basic_deployment.png: Basic two-machine CloudStack deployment</phrase></textobject>
+ </mediaobject>
+ <para>A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture.
+ </para>
+ <xi:include href="management_server_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="cloud_infrastructure_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="networking_overview.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/detach-move-volumes.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/detach-move-volumes.xml b/docs/en-US/detach-move-volumes.xml
new file mode 100644
index 0000000..26c241c
--- /dev/null
+++ b/docs/en-US/detach-move-volumes.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="detach-move-volumes">
+ <title>Attaching a Volume</title>
+ <note><para>This procedure is different from moving disk volumes from one storage pool to another. See VM Storage Migration </para></note>
+ <para>A volume can be detached from a guest VM and attached to another guest. Both CloudPlatform administrators and users can detach volumes from VMs and move them to other VMs.</para>
+ <para>If the two VMs are in different clusters, and the volume is large, it may take several minutes for the volume to be moved to the new VM.</para>
+ <para>If the destination VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
+ <listitem><para>In the left navigation bar, click Storage, and choose Volumes in Select View. Alternatively, if you know which VM the volume is attached to, you can click Instances, click the VM name, and click View Volumes.</para></listitem>
+ <listitem><para>Click the name of the volume you want to detach, then click the Detach Disk button <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/detach-disk-icon.png" />
+ </imageobject>
+ <textobject><phrase>DetachDiskButton.png: button to detach a volume</phrase></textobject>
+ </inlinemediaobject>
+ </para></listitem>
+ <listitem><para>To move the volume to another VM, follow the steps in Attaching a Volume <xref linkend="attaching-volume"/>.</para></listitem>
+ </orderedlist>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/developer-getting-started.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/developer-getting-started.xml b/docs/en-US/developer-getting-started.xml
new file mode 100644
index 0000000..adfac34
--- /dev/null
+++ b/docs/en-US/developer-getting-started.xml
@@ -0,0 +1,13 @@
+ <section id="getting-started">
+ <title>Getting Started</title>
+ <para>
+ To get started using the CloudStack API, you should have the following:</para>
+ <itemizedlist>
+ <listitem><para>URL of the CloudStack server you wish to integrate with.</para></listitem>
+ <listitem><para>Both the API Key and Secret Key for an account. This should have been generated by the administrator of the cloud instance and given to you.</para></listitem>
+ <listitem><para>Familiarity with HTTP GET/POST and query strings.</para></listitem>
+ <listitem><para>Knowledge of either XML or JSON.</para></listitem>
+ <listitem><para>Knowledge of a programming language that can generate HTTP requests; for example, Java or PHP.</para></listitem>
+ </itemizedlist>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/developer-guide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/developer-guide.xml b/docs/en-US/developer-guide.xml
new file mode 100644
index 0000000..77af46e
--- /dev/null
+++ b/docs/en-US/developer-guide.xml
@@ -0,0 +1,20 @@
+<?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;
+]>
+<chapter id="developer-guide">
+ <title>Using the API</title>
+ <xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="making-api-request.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="enabling-api-call-expiration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="signing-api-requests.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="responses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="asynchronous-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="contacting-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/developer-introduction.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/developer-introduction.xml b/docs/en-US/developer-introduction.xml
new file mode 100644
index 0000000..d895253
--- /dev/null
+++ b/docs/en-US/developer-introduction.xml
@@ -0,0 +1,11 @@
+<?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="developer-introduction">
+ <title>Introduction for Developers</title>
+ <xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="api-reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="developer-getting-started.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/developer_guide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/developer_guide.xml b/docs/en-US/developer_guide.xml
new file mode 100644
index 0000000..eb174be
--- /dev/null
+++ b/docs/en-US/developer_guide.xml
@@ -0,0 +1,20 @@
+<?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;
+]>
+<chapter id="developer_guide">
+ <title>Developer Guide</title>
+ <xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="making-api-request.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="enabling-api-call-expiration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="signing-api-requests.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="responses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="asynchronous-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="contacting-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/disable-enable-zones-pods-clusters.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/disable-enable-zones-pods-clusters.xml b/docs/en-US/disable-enable-zones-pods-clusters.xml
new file mode 100644
index 0000000..94bf89e
--- /dev/null
+++ b/docs/en-US/disable-enable-zones-pods-clusters.xml
@@ -0,0 +1,34 @@
+<?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="disable-enable-zones-pods-clusters">
+ <title>Disabling and Enabling Zones, Pods, and Clusters</title>
+ <para>You can enable or disable a zone, pod, or cluster without permanently removing it from the cloud. This is useful for maintenance or when there are problems that make a portion of the cloud infrastructure unreliable. No new allocations will be made to a disabled zone, pod, or cluster until its state is returned to Enabled. When a zone, pod, or cluster is first added to the cloud, it is Disabled by default.</para>
+ <para>To disable and enable a zone, pod, or cluster:</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as administrator</para></listitem>
+ <listitem><para>In the left navigation bar, click Infrastructure.</para>
+ </listitem>
+ <listitem><para>In Zones, click View More.</para>
+ </listitem>
+ <listitem><para>If you are disabling or enabling a zone, find the name of the zone in the list, and click the Enable/Disable button.<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/enable-disable.png" />
+ </imageobject>
+ <textobject><phrase>enable-disable.png: button to enable or disable zone, pod, or cluster.</phrase></textobject>
+ </inlinemediaobject>
+ </para></listitem>
+ <listitem><para>If you are disabling or enabling a pod or cluster, click the name of the zone that contains the pod or cluster.</para></listitem>
+ <listitem><para>Click the Compute tab.</para>
+ </listitem>
+ <listitem><para>In the Pods or Clusters node of the diagram, click View All.</para>
+ </listitem>
+ <listitem><para>Click the pod or cluster name in the list.</para></listitem>
+ <listitem><para>Click the Enable/Disable button.
+ <inlinemediaobject><imageobject>
+ <imagedata fileref="./images/enable-disable.png" />
+ </imageobject></inlinemediaobject></para></listitem>
+ </orderedlist>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/disk-volume-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/disk-volume-usage-record-format.xml b/docs/en-US/disk-volume-usage-record-format.xml
new file mode 100644
index 0000000..c4b898e
--- /dev/null
+++ b/docs/en-US/disk-volume-usage-record-format.xml
@@ -0,0 +1,21 @@
+<section id="disk-volume-usage-record-format">
+ <title>Disk Volume Usage Record Format</title>
+ <para>For disk volumes, the following fields exist in a usage record.</para>
+ <itemizedlist>
+ <listitem><para>account – name of the account</para></listitem>
+ <listitem><para>accountid – ID of the account</para></listitem>
+ <listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
+ <listitem><para>zoneid – Zone where the usage occurred</para></listitem>
+ <listitem><para>description – A string describing what the usage record is tracking</para></listitem>
+ <listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
+ <listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
+ <listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
+ <listitem><para>usageid – The volume ID</para></listitem>
+ <listitem><para>offeringid – The ID of the disk offering</para></listitem>
+ <listitem><para>type – Hypervisor</para></listitem>
+ <listitem><para>templateid – ROOT template ID</para></listitem>
+ <listitem><para>size – The amount of storage allocated</para></listitem>
+ <listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
+ </itemizedlist>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/dns-dhcp.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/dns-dhcp.xml b/docs/en-US/dns-dhcp.xml
new file mode 100644
index 0000000..dfebbd6
--- /dev/null
+++ b/docs/en-US/dns-dhcp.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="dns-dhcp">
+ <title>DNS and DHCP</title>
+ <para>The Virtual Router provides DNS and DHCP services to the guests. It proxies DNS requests to the DNS server configured on the Availability Zone.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/domains.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/domains.xml b/docs/en-US/domains.xml
new file mode 100644
index 0000000..669b3d3
--- /dev/null
+++ b/docs/en-US/domains.xml
@@ -0,0 +1,10 @@
+<?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="domains">
+ <title>Domains</title>
+ <para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
+
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/enable-disable-static-nat.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enable-disable-static-nat.xml b/docs/en-US/enable-disable-static-nat.xml
new file mode 100644
index 0000000..0895b88
--- /dev/null
+++ b/docs/en-US/enable-disable-static-nat.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="enable-disable-static-nat">
+ <title>Enabling or Disabling Static NAT</title>
+ <para>If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP.</para>
+ <para>If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network.</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
+ <listitem><para>In the left navigation, choose Network.</para></listitem>
+ <listitem><para>Click the name of the network where you want to work with.</para></listitem>
+ <listitem><para>Click View IP Addresses.</para></listitem>
+ <listitem><para>Click the IP address you want to work with.</para>
+ </listitem>
+ <listitem><para>Click the Static NAT button.<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/release-ip-icon.png" />
+ </imageobject>
+ <textobject><phrase>ReleaseIPButton.png: button to release an IP</phrase></textobject>
+ </inlinemediaobject>The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address.</para></listitem>
+ <listitem><para>If you are enabling static NAT, a dialog appears where you can choose the destination VM and click Apply</para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/enable-security-groups.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enable-security-groups.xml b/docs/en-US/enable-security-groups.xml
new file mode 100644
index 0000000..b97b65e
--- /dev/null
+++ b/docs/en-US/enable-security-groups.xml
@@ -0,0 +1,10 @@
+<?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="enable-security-groups">
+ <title>Enabling Security Groups</title>
+ <para>In order for security groups to function in a zone, the security groups feature must first be enabled for the zone. The administrator can do this when creating a new zone, by selecting a network offering that includes security groups. The procedure is described in Basic Zone Configuration in the Advanced Installation Guide.</para>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/enabling-api-call-expiration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enabling-api-call-expiration.xml b/docs/en-US/enabling-api-call-expiration.xml
new file mode 100644
index 0000000..9ebbb20
--- /dev/null
+++ b/docs/en-US/enabling-api-call-expiration.xml
@@ -0,0 +1,16 @@
+ <section id="enabling-api-call-expiration">
+ <title>Enabling API Call Expiration</title>
+ <para>
+ You can set an expiry timestamp on API calls to prevent replay attacks over non-secure channels, such as HTTP. The server tracks the expiry timestamp you have specified and rejects all the subsequent API requests that come in after this validity period.
+ </para>
+ <para>To enable this feature, add the following parameters to the API request:</para>
+ <itemizedlist>
+ <listitem><para>signatureVersion=3: If the signatureVersion parameter is missing or is not equal to 3, the expires parameter is ignored in the API request.</para></listitem>
+ <listitem><para>expires=YYYY-MM-DDThh:mm:ssZ: Specifies the date and time at which the signature included in the request is expired. The timestamp is expressed in the YYYY-MM-DDThh:mm:ssZ format, as specified in the ISO 8601 standard.</para></listitem>
+ </itemizedlist>
+ <para>For example:</para>
+ <programlisting>expires=2011-10-10T12:00:00+0530</programlisting>
+ <para>A sample API request with expiration is given below:</para>
+ <programlisting>http://<IPAddress>:8080/client/api?command=listZones&signatureVersion=3&expires=2011-10-10T12:00:00+0530&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D</programlisting>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/enabling-port-8096.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enabling-port-8096.xml b/docs/en-US/enabling-port-8096.xml
new file mode 100644
index 0000000..5521439
--- /dev/null
+++ b/docs/en-US/enabling-port-8096.xml
@@ -0,0 +1,13 @@
+ <section id="enabling-port-8096">
+ <title>Enabling Port 8096</title>
+ <para>
+ Port 8096, which allows API calls without authentication, is closed and disabled by default on any fresh 3.0.1 installations. You can enable 8096 (or another port) for this purpose as follows:
+ </para>
+ <orderedlist>
+ <listitem><para>Ensure that the first Management Server is installed and running.</para></listitem>
+ <listitem><para>Set the global configuration parameter integration.api.port to the desired port.</para></listitem>
+ <listitem><para>Restart the Management Server.</para></listitem>
+ <listitem><para>On the Management Server host machine, create an iptables rule allowing access to that port.</para></listitem>
+ </orderedlist>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/end-user-ui-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/end-user-ui-overview.xml b/docs/en-US/end-user-ui-overview.xml
new file mode 100644
index 0000000..879485c
--- /dev/null
+++ b/docs/en-US/end-user-ui-overview.xml
@@ -0,0 +1,9 @@
+<?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="end-user-ui-overview">
+ <title>End User's UI Overview</title>
+ <para>The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/error-handling.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/error-handling.xml b/docs/en-US/error-handling.xml
new file mode 100644
index 0000000..1b2684f
--- /dev/null
+++ b/docs/en-US/error-handling.xml
@@ -0,0 +1,6 @@
+ <section id="error-handling">
+ <title>Error Handling</title>
+ <para>If an error occurs while processing an API request, the appropriate response in the format specified is returned. Each error response consists of an error code and an error text describing what possibly can go wrong. For an example error response, see page 12.</para>
+ <para>An HTTP error code of 401 is always returned if API request was rejected due to bad signatures, missing API Keys, or the user simply did not have the permissions to execute the command.</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/event-log-queries.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/event-log-queries.xml b/docs/en-US/event-log-queries.xml
new file mode 100644
index 0000000..b425ce0
--- /dev/null
+++ b/docs/en-US/event-log-queries.xml
@@ -0,0 +1,18 @@
+<?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="event-log-queries">
+ <title>Event Log Queries</title>
+ <para>Database logs can be queried from the user interface. The list of events captured by the system includes:</para>
+ <itemizedlist>
+ <listitem><para>Virtual machine creation, deletion, and on-going management operations</para></listitem>
+ <listitem><para>Virtual router creation, deletion, and on-going management operations</para>
+ </listitem>
+ <listitem><para>Template creation and deletion</para></listitem>
+ <listitem><para>Network/load balancer rules creation and deletion</para></listitem>
+ <listitem><para>Storage volume creation and deletion</para></listitem>
+ <listitem><para>User login and logout</para></listitem>
+ </itemizedlist>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/event-types.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/event-types.xml b/docs/en-US/event-types.xml
new file mode 100644
index 0000000..f9570b1
--- /dev/null
+++ b/docs/en-US/event-types.xml
@@ -0,0 +1,196 @@
+ <section id="event-types">
+ <title>Event Types</title>
+ <informaltable frame="all">
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" />
+ <colspec colname="c2" />
+ <tbody>
+ <row>
+ <entry><para>VM.CREATE</para></entry>
+ <entry><para>TEMPLATE.EXTRACT</para></entry>
+ <entry><para>SG.REVOKE.INGRESS</para></entry>
+ </row>
+ <row>
+ <entry><para>VM.DESTROY</para></entry>
+ <entry><para>TEMPLATE.UPLOAD</para></entry>
+ <entry><para>HOST.RECONNECT</para></entry>
+ </row>
+ <row>
+ <entry><para>VM.START</para></entry>
+ <entry><para>TEMPLATE.CLEANUP</para></entry>
+ <entry><para>MAINT.CANCEL</para></entry>
+ </row>
+ <row>
+ <entry><para>VM.STOP</para></entry>
+ <entry><para>VOLUME.CREATE</para></entry>
+ <entry><para>MAINT.CANCEL.PS</para></entry>
+ </row>
+ <row>
+ <entry><para>VM.REBOOT</para></entry>
+ <entry><para>VOLUME.DELETE</para></entry>
+ <entry><para>MAINT.PREPARE</para></entry>
+ </row>
+ <row>
+ <entry><para>VM.UPGRADE</para></entry>
+ <entry><para>VOLUME.ATTACH</para></entry>
+ <entry><para>MAINT.PREPARE.PS</para></entry>
+ </row>
+ <row>
+ <entry><para>VM.RESETPASSWORD</para></entry>
+ <entry><para>VOLUME.DETACH</para></entry>
+ <entry><para>VPN.REMOTE.ACCESS.CREATE</para></entry>
+ </row>
+ <row>
+ <entry><para>ROUTER.CREATE</para></entry>
+ <entry><para>VOLUME.UPLOAD</para></entry>
+ <entry><para>VPN.USER.ADD</para></entry>
+ </row>
+ <row>
+ <entry><para>ROUTER.DESTROY</para></entry>
+ <entry><para>SERVICEOFFERING.CREATE</para></entry>
+ <entry><para>VPN.USER.REMOVE</para></entry>
+ </row>
+ <row>
+ <entry><para>ROUTER.START</para></entry>
+ <entry><para>SERVICEOFFERING.UPDATE</para></entry>
+ <entry><para>NETWORK.RESTART</para></entry>
+ </row>
+ <row>
+ <entry><para>ROUTER.STOP</para></entry>
+ <entry><para>SERVICEOFFERING.DELETE</para></entry>
+ <entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
+ </row>
+ <row>
+ <entry><para>ROUTER.REBOOT</para></entry>
+ <entry><para>DOMAIN.CREATE</para></entry>
+ <entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
+ </row>
+ <row>
+ <entry><para>ROUTER.HA</para></entry>
+ <entry><para>DOMAIN.DELETE</para></entry>
+ <entry><para>STATICNAT.DISABLE</para></entry>
+ </row>
+ <row>
+ <entry><para>PROXY.CREATE</para></entry>
+ <entry><para>DOMAIN.UPDATE</para></entry>
+ <entry><para>SSVM.CREATE</para></entry>
+ </row>
+ <row>
+ <entry><para>PROXY.DESTROY</para></entry>
+ <entry><para>SNAPSHOT.CREATE</para></entry>
+ <entry><para>SSVM.DESTROY</para></entry>
+ </row>
+ <row>
+ <entry><para>PROXY.START</para></entry>
+ <entry><para>SNAPSHOT.DELETE</para></entry>
+ <entry><para>SSVM.START</para></entry>
+ </row>
+ <row>
+ <entry><para>PROXY.STOP</para></entry>
+ <entry><para>SNAPSHOTPOLICY.CREATE</para></entry>
+ <entry><para>SSVM.STOP</para></entry>
+ </row>
+ <row>
+ <entry><para>PROXY.REBOOT</para></entry>
+ <entry><para>SNAPSHOTPOLICY.UPDATE</para></entry>
+ <entry><para>SSVM.REBOOT</para></entry>
+ </row>
+ <row>
+ <entry><para>PROXY.HA</para></entry>
+ <entry><para>SNAPSHOTPOLICY.DELETE</para></entry>
+ <entry><para>SSVM.H</para></entry>
+ </row>
+ <row>
+ <entry><para>VNC.CONNECT</para></entry>
+ <entry><para>VNC.DISCONNECT</para></entry>
+ <entry><para>NET.IPASSIGN</para></entry>
+ </row>
+ <row>
+ <entry><para>NET.IPRELEASE</para></entry>
+ <entry><para>NET.RULEADD</para></entry>
+ <entry><para>NET.RULEDELETE</para></entry>
+ </row>
+ <row>
+ <entry><para>NET.RULEMODIFY</para></entry>
+ <entry><para>NETWORK.CREATE</para></entry>
+ <entry><para>NETWORK.DELETE</para></entry>
+ </row>
+ <row>
+ <entry><para>LB.ASSIGN.TO.RULE</para></entry>
+ <entry><para>LB.REMOVE.FROM.RULE</para></entry>
+ <entry><para>LB.CREATE</para></entry>
+ </row>
+ <row>
+ <entry><para>LB.DELETE</para></entry>
+ <entry><para>LB.UPDATE</para></entry>
+ <entry><para>USER.LOGIN</para></entry>
+ </row>
+ <row>
+ <entry><para>USER.LOGOUT</para></entry>
+ <entry><para>USER.CREATE</para></entry>
+ <entry><para>USER.DELETE</para></entry>
+ </row>
+ <row>
+ <entry><para>USER.UPDATE</para></entry>
+ <entry><para>USER.DISABLE</para></entry>
+ <entry><para>TEMPLATE.CREATE</para></entry>
+ </row>
+ <row>
+ <entry><para>TEMPLATE.DELETE</para></entry>
+ <entry><para>TEMPLATE.UPDATE</para></entry>
+ <entry><para>TEMPLATE.COPY</para></entry>
+ </row>
+ <row>
+ <entry><para>TEMPLATE.DOWNLOAD.START</para></entry>
+ <entry><para>TEMPLATE.DOWNLOAD.SUCCESS</para></entry>
+ <entry><para>TEMPLATE.DOWNLOAD.FAILED</para></entry>
+ </row>
+ <row>
+ <entry><para>ISO.CREATE</para></entry>
+ <entry><para>ISO.DELETE</para></entry>
+ <entry><para>ISO.COPY</para></entry>
+ </row>
+ <row>
+ <entry><para>ISO.ATTACH</para></entry>
+ <entry><para>ISO.DETACH</para></entry>
+ <entry><para>ISO.EXTRACT</para></entry>
+ </row>
+ <row>
+ <entry><para>ISO.UPLOAD</para></entry>
+ <entry><para>SERVICE.OFFERING.CREATE</para></entry>
+ <entry><para>SERVICE.OFFERING.EDIT</para></entry>
+ </row>
+ <row>
+ <entry><para>SERVICE.OFFERING.DELETE</para></entry>
+ <entry><para>DISK.OFFERING.CREATE</para></entry>
+ <entry><para>DISK.OFFERING.EDIT</para></entry>
+ </row>
+ <row>
+ <entry><para>DISK.OFFERING.DELETE</para></entry>
+ <entry><para>NETWORK.OFFERING.CREATE</para></entry>
+ <entry><para>NETWORK.OFFERING.EDIT</para></entry>
+ </row>
+ <row>
+ <entry><para>NETWORK.OFFERING.DELETE</para></entry>
+ <entry><para>POD.CREATE</para></entry>
+ <entry><para>POD.EDIT</para></entry>
+ </row>
+ <row>
+ <entry><para>POD.DELETE</para></entry>
+ <entry><para>ZONE.CREATE</para></entry>
+ <entry><para>ZONE.EDIT</para></entry>
+ </row>
+ <row>
+ <entry><para>ZONE.DELETE</para></entry>
+ <entry><para>VLAN.IP.RANGE.CREATE</para></entry>
+ <entry><para>VLAN.IP.RANGE.DELETE</para></entry>
+ </row>
+ <row>
+ <entry><para>CONFIGURATION.VALUE.EDIT</para></entry>
+ <entry><para>SG.AUTH.INGRESS</para></entry>
+ <entry><para></para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/events-log.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/events-log.xml b/docs/en-US/events-log.xml
new file mode 100644
index 0000000..4087e58
--- /dev/null
+++ b/docs/en-US/events-log.xml
@@ -0,0 +1,10 @@
+<?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="events-log">
+ <title>Event Logs</title>
+ <para>There are two types of events logged in the CloudPlatform Event Log. Standard events log the success or failure of an event and can be used to identify jobs or processes that have failed. There are also long running job events. Events for asynchronous jobs log when a job is scheduled, when it starts, and when it completes. Other long running synchronous jobs log when a job starts, and when it completes. Long running synchronous and asynchronous event logs can be used to gain more information on the status of a pending job or can be used to identify a job that is hanging or has not started. The following sections provide more information on these events..</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/events.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/events.xml b/docs/en-US/events.xml
new file mode 100644
index 0000000..b1a67c1
--- /dev/null
+++ b/docs/en-US/events.xml
@@ -0,0 +1,11 @@
+<?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="events">
+ <xi:include href="events-log.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="standard-events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="long-running-job-events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="event-log-queries.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/example-LDAP-configuration-commands.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/example-LDAP-configuration-commands.xml b/docs/en-US/example-LDAP-configuration-commands.xml
new file mode 100644
index 0000000..a91a909
--- /dev/null
+++ b/docs/en-US/example-LDAP-configuration-commands.xml
@@ -0,0 +1,28 @@
+<?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="example-LDAP-configuration-commands">
+ <title>Example LDAP Configuration Commands</title>
+ <para>To understand the examples in this section, you need to know the basic concepts behind calling the CloudPlatform API, which are explained in the Developer’s Guide.</para>
+ <para>The following shows an example invocation of ldapConfig with an ApacheDS LDAP server</para>
+ <programlisting>http://127.0.0.1:8080/client/api?command=ldapConfig&hostname=127.0.0.1&searchbase=ou%3Dtesting%2Co%3Dproject&queryfilter=%28%26%28uid%3D%25u%29%29&binddn=cn%3DJohn+Singh%2Cou%3Dtesting%2Co%project&bindpass=secret&port=10389&ssl=true&truststore=C%3A%2Fcompany%2Finfo%2Ftrusted.ks&truststorepass=secret&response=json&apiKey=YourAPIKey&signature=YourSignatureHash</programlisting>
+ <para>The command must be URL-encoded. Here is the same example without the URL encoding:</para>
+ <programlisting>http://127.0.0.1:8080/client/api?command=ldapConfig
+&hostname=127.0.0.1
+&searchbase=ou=testing,o=project
+&queryfilter=(&(%uid=%u))
+&binddn=cn=John+Singh,ou=testing,o=project
+&bindpass=secret
+&port=10389
+&ssl=true
+&truststore=C:/company/info/trusted.ks
+&truststorepass=secret
+&response=json
+&apiKey=YourAPIKey&signature=YourSignatureHash
+ </programlisting>
+ <para>The following shows a similar command for Active Directory. Here, the search base is the testing group within a company, and the users are matched up based on email address.</para>
+<programlisting>http://10.147.29.101:8080/client/api?command=ldapConfig&hostname=10.147.28.250&searchbase=OU%3Dtesting%2CDC%3Dcompany&queryfilter=%28%26%28mail%3D%25e%29%29 &binddn=CN%3DAdministrator%2COU%3Dtesting%2CDC%3Dcompany&bindpass=1111_aaaa&port=389&response=json&apiKey=YourAPIKey&signature=YourSignatureHash</programlisting>
+ <para>The next few sections explain some of the concepts you will need to know when filling out the ldapConfig parameters. </para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/example-response-from-listUsageRecords.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/example-response-from-listUsageRecords.xml b/docs/en-US/example-response-from-listUsageRecords.xml
new file mode 100644
index 0000000..96615bb
--- /dev/null
+++ b/docs/en-US/example-response-from-listUsageRecords.xml
@@ -0,0 +1,32 @@
+ <section id="example-response-from-listUsageRecords">
+ <title>Example response from listUsageRecords</title>
+ <para>
+ All CloudStack API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS:</para>
+
+ <programlisting>
+ <listusagerecordsresponse>
+ <count>1816</count>
+ <usagerecord>
+ <account>user5</account>
+ <accountid>10004</accountid>
+ <domainid>1</domainid>
+ <zoneid>1</zoneid>
+ <description>i-3-4-WC running time (ServiceOffering: 1) (Template: 3)</description>
+ <usage>2.95288 Hrs</usage>
+ <usagetype>1</usagetype>
+ <rawusage>2.95288</rawusage>
+ <virtualmachineid>4</virtualmachineid>
+ <name>i-3-4-WC</name>
+ <offeringid>1</offeringid>
+ <templateid>3</templateid>
+ <usageid>245554</usageid>
+ <type>XenServer</type>
+ <startdate>2009-09-15T00:00:00-0700</startdate>
+ <enddate>2009-09-18T16:14:26-0700</enddate>
+ </usagerecord>
+
+ … (1,815 more usage records)
+ </listusagerecordsresponse>
+ </programlisting>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/export-template.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/export-template.xml b/docs/en-US/export-template.xml
new file mode 100644
index 0000000..c6db53f
--- /dev/null
+++ b/docs/en-US/export-template.xml
@@ -0,0 +1,10 @@
+<?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="export-template">
+ <title>Exporting Templates</title>
+ <para>End users and Administrators may export templates from the CloudPlatform. Navigate to the template in the UI and choose the Download function from the Actions menu.</para>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/external-firewalls-and-load-balancers.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/external-firewalls-and-load-balancers.xml b/docs/en-US/external-firewalls-and-load-balancers.xml
new file mode 100644
index 0000000..239e7b8
--- /dev/null
+++ b/docs/en-US/external-firewalls-and-load-balancers.xml
@@ -0,0 +1,11 @@
+<?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="external-firewalls-and-load-balancers">
+ <title>External Firewalls and Load Balancers</title>
+ <para>CloudPlatform is capable of replacing its Virtual Router with an external Juniper SRX device and an optional external NetScaler or F5 load balancer for gateway and load balancing services. In this case, the VMs use the SRX as their gateway.</para>
+
+
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/feature-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/feature-overview.xml b/docs/en-US/feature-overview.xml
new file mode 100644
index 0000000..9ea1b78
--- /dev/null
+++ b/docs/en-US/feature-overview.xml
@@ -0,0 +1,49 @@
+<?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="feature-overview">
+ <title>What Can &PRODUCT; Do?</title>
+ <para>
+ <emphasis role="bold">Multiple Hypervisor Support</emphasis>
+ </para>
+ <para>
+ &PRODUCT; works with a variety of hypervisors. A single cloud deployment can contain multiple hypervisor implementations. You have the complete freedom to choose the right hypervisor for your workload.
+ </para>
+ <para>
+ &PRODUCT; is designed to work with open source Xen and KVM hypervisors as well as enterprise-grade hypervisors such as Citrix XenServer, VMware vSphere, and Oracle VM (OVM). You can also provision “bare metal” hosts with no hypervisor (Beta feature. Untested in &PRODUCT; 3.0.x.)
+ </para>
+ <para>
+ <emphasis role="bold">Massively Scalable Infrastructure Management</emphasis>
+ </para>
+ <para>
+ &PRODUCT; can manage tens of thousands of servers installed in multiple geographically distributed datacenters. The centralized management server scales linearly, eliminating the need for intermediate cluster-level management servers. No single component failure can cause cloud-wide outage. Periodic maintenance of the management server can be performed without affecting the functioning of virtual machines running in the cloud.
+ </para>
+ <para>
+ <emphasis role="bold">Automatic Configuration Management</emphasis>
+ </para>
+ <para>&PRODUCT; automatically configures each guest virtual machine’s networking and storage settings.
+ </para>
+ <para>&PRODUCT; internally manages a pool of virtual appliances to support the cloud itself. These appliances offer services such as firewalling, routing, DHCP, VPN access, console proxy, storage access, and storage replication. The extensive use of virtual appliances simplifies the installation, configuration, and ongoing management of a cloud deployment.
+ </para>
+ <para>
+ <emphasis role="bold">Graphical User Interface</emphasis>
+ </para>
+ <para>&PRODUCT; offers an administrator's Web interface, used for provisioning and managing the cloud, as well as an end-user's Web interface, used for running VMs and managing VM templates. The UI can be customized to reflect the desired service provider or enterprise look and feel.
+ </para>
+ <para>
+ <emphasis role="bold">API and Extensibility</emphasis>
+ </para>
+ <para>
+ &PRODUCT; provides an API that gives programmatic access to all the management features available in the UI. The API is maintained and documented. This API enables the creation of command line tools and new user interfaces to suit particular needs. See the Developer’s Guide and API Reference, both available at http://docs.cloud.com/CloudStack_Documentation.
+ </para>
+ <para>
+ The &PRODUCT; pluggable allocation architecture allows the creation of new types of allocators for the selection of storage and Hosts. See the Allocator Implementation Guide (<ulink url="http://docs.cloudstack.org/CloudStack_Documentation/Allocator_Implementation_Guide">http://docs.cloudstack.org/CloudStack_Documentation/Allocator_Implementation_Guide</ulink>).
+ </para>
+ <para>
+ <emphasis role="bold">High Availability</emphasis>
+ </para>
+ <para>&PRODUCT; has a number of features to increase the availability of the system. The Management Server itself may be deployed in a multi-node installation where the servers are load balanced. MySQL may be configured to use replication to provide for a manual failover in the event of database loss. For the hosts, &PRODUCT; supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath.
+ </para>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/firewall-rules.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/firewall-rules.xml b/docs/en-US/firewall-rules.xml
new file mode 100644
index 0000000..a7a708d
--- /dev/null
+++ b/docs/en-US/firewall-rules.xml
@@ -0,0 +1,37 @@
+<?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="firewall-rules">
+ <title>Firewall Rules</title>
+ <para>By default, all incoming traffic to the public IP address is rejected by the firewall. To allow external traffic, you can open firewall ports by specifying firewall rules. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses.</para>
+ <para>You cannot use firewall rules to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See <xref linkend="add-security-group"/>.</para>
+ <para>Firewall rules can be created using the Firewall tab in the Management Server UI. This tab is not displayed by default when CloudPlatform is installed. To display the Firewall tab, the CloudPlatform administrator must set the global configuration parameter firewall.rule.ui.enabled to "true."</para>
+ <para>To create a firewall rule:</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
+ <listitem><para>In the left navigation, choose Network.</para></listitem>
+ <listitem><para>Click the name of the network where you want to work with.</para></listitem>
+ <listitem><para>Click View IP Addresses.</para></listitem>
+ <listitem><para>Click the IP address you want to work with.</para>
+ </listitem>
+ <listitem><para>Click the Configuration tab and fill in the following values.</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Source CIDR</emphasis>. (Optional) To accept only traffic from IP
+ addresses within a particular address block, enter a CIDR or a
+ comma-separated list of CIDRs. Example: 192.168.0.0/22. Leave empty to allow
+ all CIDRs.</para></listitem>
+ <listitem><para><emphasis role="bold">Protocol</emphasis>. The communication protocol in use on the opened
+ port(s).</para></listitem>
+ <listitem><para><emphasis role="bold">Start Port and End Port</emphasis>. The port(s) you want to open on the
+ firewall. If you are opening a single port, use the same number in both
+ fields</para></listitem>
+ <listitem><para><emphasis role="bold">ICMP Type and ICMP Code</emphasis>. Used only if Protocol is set to
+ ICMP. Provide the type and code required by the ICMP protocol to fill out
+ the ICMP header. Refer to ICMP documentation for more details if you are not
+ sure what to enter</para></listitem>
+ </itemizedlist></listitem>
+ <listitem><para>Click Add</para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/first_ms_node_install.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/first_ms_node_install.xml b/docs/en-US/first_ms_node_install.xml
new file mode 100644
index 0000000..f0c2e14
--- /dev/null
+++ b/docs/en-US/first_ms_node_install.xml
@@ -0,0 +1,34 @@
+ <section id="first_ms_node_install">
+ <title>Install the First Management Server</title>
+ <orderedlist>
+ <listitem><para>Download the CloudStack Management Server onto the host where it will run from one of the following links. If your operating system is CentOS, use the download file for RHEL.</para>
+ <itemizedlist>
+ <listitem><para>Open-source community: <ulink url="http://sourceforge.net/projects/cloudstack/files/CloudStack Acton/">http://sourceforge.net/projects/cloudstack/files/CloudStack Acton/</ulink></para></listitem>
+ <listitem><para>Commercial customers: <ulink url="https://www.citrix.com/English/ss/downloads/">https://www.citrix.com/English/ss/downloads/</ulink>.
+ Commercial customers will need a <ulink url="http://www.citrix.com/lang/English/publicindex.asp?destURL=%2FEnglish%2FmyCitrix%2Findex.asp%3F">MyCitrix account</ulink>.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Install the CloudStack packages. You should have a file in the form of “CloudStack-VERSION-N-OSVERSION.tar.gz”. Untar the file and then run the install.sh script inside it. Replace the file and directory names below with those you are using:</para>
+ <programlisting># tar xzf CloudStack-VERSION-N-OSVERSION.tar.gz
+# cd CloudStack-VERSION-N-OSVERSION
+# ./install.sh
+</programlisting>
+ <para>You should see a few messages as the installer prepares, followed by a list of choices.</para>
+ </listitem>
+ <listitem><para>Choose M to install the Management Server software.</para>
+ <programlisting> > M</programlisting>
+ </listitem>
+ <listitem><para>Wait for a message like “Complete! Done,” which indicates that the software was installed successfully.</para>
+ </listitem>
+ <listitem><para>(RHEL or CentOS) When the installation is finished, run the following commands to start essential services (the commands might be different depending on your OS):</para>
+ <programlisting># service rpcbind start
+# service nfs start
+# chkconfig nfs on
+# chkconfig rpcbind on
+ </programlisting>
+ </listitem>
+ <listitem><para>Continue to Install and Configure the Database.</para>
+ </listitem>
+ </orderedlist>
+ </section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/globally-configured-limit.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/globally-configured-limit.xml b/docs/en-US/globally-configured-limit.xml
new file mode 100644
index 0000000..5c8bb85
--- /dev/null
+++ b/docs/en-US/globally-configured-limit.xml
@@ -0,0 +1,81 @@
+<?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="globally-configured-limits">
+ <title>Globally Configured Limits</title>
+ <para>In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses.</para>
+ <para>The following table lists limits set in the Global Configuration:</para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry><para>Parameter Name</para></entry>
+ <entry><para>Definition</para></entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>max.account.public.ips</para></entry>
+ <entry><para>Number of public IP addresses that can be owned by an account</para></entry>
+
+ </row>
+ <row>
+ <entry><para>max.account.snapshots</para></entry>
+ <entry><para>Number of snapshots that can exist for an account</para></entry>
+
+ </row>
+
+ <row>
+ <entry><para>max.account.templates</para></entry>
+ <entry><para>Number of templates that can exist for an account</para></entry>
+
+ </row>
+ <row>
+ <entry><para>max.account.user.vms</para></entry>
+ <entry><para>Number of virtual machine instances that can exist for an account</para></entry>
+ </row>
+
+ <row>
+ <entry><para>max.account.volumes</para></entry>
+ <entry><para>Number of disk volumes that can exist for an account</para></entry>
+ </row>
+
+ <row>
+ <entry><para>max.template.iso.size</para></entry>
+ <entry><para>Maximum size for a downloaded template or ISO in GB</para></entry>
+ </row>
+
+ <row>
+ <entry><para>max.volume.size.gb</para></entry>
+ <entry><para>Maximum size for a volume in GB</para></entry>
+ </row>
+ <row>
+ <entry><para>network.throttling.rate</para></entry>
+ <entry><para>Default data transfer rate in megabits per second allowed per user (supported on XenServer)</para></entry>
+ </row>
+ <row>
+ <entry><para>snapshot.max.hourly</para></entry>
+ <entry><para>Maximum recurring hourly snapshots to be retained for a volume. If the limit is reached, early snapshots from the start of the hour are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring hourly snapshots can not be scheduled</para></entry>
+ </row>
+
+ <row>
+ <entry><para>snapshot.max.daily</para></entry>
+ <entry><para>Maximum recurring daily snapshots to be retained for a volume. If the limit is reached, snapshots from the start of the day are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring daily snapshots can not be scheduled</para></entry>
+ </row>
+ <row>
+ <entry><para>snapshot.max.weekly</para></entry>
+ <entry><para>Maximum recurring weekly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the week are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring weekly snapshots can not be scheduled</para></entry>
+ </row>
+
+ <row>
+ <entry><para>snapshot.max.monthly</para></entry>
+ <entry><para>Maximum recurring monthly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the month are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring monthly snapshots can not be scheduled.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>To modify global configuration parameters, use the global configuration screen in the CloudPlatform UI. See Setting Global Configuration Parameters </para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/globally-configured-limits.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/globally-configured-limits.xml b/docs/en-US/globally-configured-limits.xml
new file mode 100644
index 0000000..5c8bb85
--- /dev/null
+++ b/docs/en-US/globally-configured-limits.xml
@@ -0,0 +1,81 @@
+<?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="globally-configured-limits">
+ <title>Globally Configured Limits</title>
+ <para>In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses.</para>
+ <para>The following table lists limits set in the Global Configuration:</para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry><para>Parameter Name</para></entry>
+ <entry><para>Definition</para></entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>max.account.public.ips</para></entry>
+ <entry><para>Number of public IP addresses that can be owned by an account</para></entry>
+
+ </row>
+ <row>
+ <entry><para>max.account.snapshots</para></entry>
+ <entry><para>Number of snapshots that can exist for an account</para></entry>
+
+ </row>
+
+ <row>
+ <entry><para>max.account.templates</para></entry>
+ <entry><para>Number of templates that can exist for an account</para></entry>
+
+ </row>
+ <row>
+ <entry><para>max.account.user.vms</para></entry>
+ <entry><para>Number of virtual machine instances that can exist for an account</para></entry>
+ </row>
+
+ <row>
+ <entry><para>max.account.volumes</para></entry>
+ <entry><para>Number of disk volumes that can exist for an account</para></entry>
+ </row>
+
+ <row>
+ <entry><para>max.template.iso.size</para></entry>
+ <entry><para>Maximum size for a downloaded template or ISO in GB</para></entry>
+ </row>
+
+ <row>
+ <entry><para>max.volume.size.gb</para></entry>
+ <entry><para>Maximum size for a volume in GB</para></entry>
+ </row>
+ <row>
+ <entry><para>network.throttling.rate</para></entry>
+ <entry><para>Default data transfer rate in megabits per second allowed per user (supported on XenServer)</para></entry>
+ </row>
+ <row>
+ <entry><para>snapshot.max.hourly</para></entry>
+ <entry><para>Maximum recurring hourly snapshots to be retained for a volume. If the limit is reached, early snapshots from the start of the hour are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring hourly snapshots can not be scheduled</para></entry>
+ </row>
+
+ <row>
+ <entry><para>snapshot.max.daily</para></entry>
+ <entry><para>Maximum recurring daily snapshots to be retained for a volume. If the limit is reached, snapshots from the start of the day are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring daily snapshots can not be scheduled</para></entry>
+ </row>
+ <row>
+ <entry><para>snapshot.max.weekly</para></entry>
+ <entry><para>Maximum recurring weekly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the week are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring weekly snapshots can not be scheduled</para></entry>
+ </row>
+
+ <row>
+ <entry><para>snapshot.max.monthly</para></entry>
+ <entry><para>Maximum recurring monthly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the month are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring monthly snapshots can not be scheduled.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>To modify global configuration parameters, use the global configuration screen in the CloudPlatform UI. See Setting Global Configuration Parameters </para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/guest-ip-ranges.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/guest-ip-ranges.xml b/docs/en-US/guest-ip-ranges.xml
new file mode 100644
index 0000000..97da044
--- /dev/null
+++ b/docs/en-US/guest-ip-ranges.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="guest-ip-ranges">
+ <title>Guest IP Ranges</title>
+ <para>The IP ranges for guest network traffic are set on a per-account basis by the user. This allows the users to configure their network in a fashion that will enable VPN linking between their guest network and their clients.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/guest-network.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/guest-network.xml b/docs/en-US/guest-network.xml
new file mode 100644
index 0000000..e8264b3
--- /dev/null
+++ b/docs/en-US/guest-network.xml
@@ -0,0 +1,10 @@
+<?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="guest-network">
+ <title>Guest Network</title>
+ <para>In a CloudPlatform cloud, guest VMs can communicate with each other using shared infrastructure with the security and user perception that the guests have a private LAN.</para>
+ <para>The CloudPlatform virtual router is the main component providing networking features for guest traffic.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/guest-traffic.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/guest-traffic.xml b/docs/en-US/guest-traffic.xml
new file mode 100644
index 0000000..38658e0
--- /dev/null
+++ b/docs/en-US/guest-traffic.xml
@@ -0,0 +1,19 @@
+<?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="guest-traffic">
+ <title>Guest Traffic</title>
+ <para>A network can carry guest traffic only between VMs within one zone. Virtual machines in different zones cannot communicate with each other using their IP addresses; they must communicate with each other by routing through a public IP address.</para>
+ <para>Figure 1 illustrates a typical guest traffic setup:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/basic_deployment.png" />
+ </imageobject>
+ <textobject><phrase>guesttraffic.png: Depicts a guest traffic setup</phrase></textobject>
+ </mediaobject>
+ <para>The Management Server automatically creates a virtual router for each network. A virtual router is a special virtual machine that runs on the hosts. Each virtual router has three network interfaces. Its eth0 interface serves as the gateway for the guest traffic and has the IP address of 10.1.1.1. Its eth1 interface is used by the system to configure the virtual router. Its eth2 interface is assigned a public IP address for public traffic.</para>
+ <para>The virtual router provides DHCP and will automatically assign an IP address for each guest VM within the IP range assigned for the network. The user can manually reconfigure guest VMs to assume different IP addresses.</para>
+ <para>Source NAT is automatically configured in the virtual router to forward outbound traffic for all guest VMs</para>
+</section>