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
[16/22] adding docs
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/time-zones.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/time-zones.xml b/docs/en-US/time-zones.xml
new file mode 100644
index 0000000..a886e5f
--- /dev/null
+++ b/docs/en-US/time-zones.xml
@@ -0,0 +1,114 @@
+ <section id="time-zones">
+ <title>Time Zones</title>
+ <para>The following time zone identifiers are accepted by the CloudPlatform API. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table. .</para>
+ <informaltable frame="all">
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" />
+ <colspec colname="c2" />
+ <colspec colname="c3" />
+ <tbody>
+ <row>
+ <entry><para>Etc/GMT+12</para></entry>
+ <entry><para>Etc/GMT+11</para></entry>
+ <entry><para>Pacific/Samoa</para></entry>
+ </row>
+ <row>
+ <entry><para>Pacific/Honolulu</para></entry>
+ <entry><para>US/Alaska</para></entry>
+ <entry><para>America/Los_Angeles</para></entry>
+ </row>
+ <row>
+ <entry><para>Mexico/BajaNorte</para></entry>
+ <entry><para>US/Arizona</para></entry>
+ <entry><para>US/Mountain</para></entry>
+ </row>
+ <row>
+ <entry><para>America/Chihuahua</para></entry>
+ <entry><para>America/Chicago</para></entry>
+ <entry><para>America/Costa_Rica</para></entry>
+ </row>
+ <row>
+ <entry><para>America/Mexico_City</para></entry>
+ <entry><para>Canada/Saskatchewan</para></entry>
+ <entry><para>America/Bogota</para></entry>
+ </row>
+ <row>
+ <entry><para>America/New_York</para></entry>
+ <entry><para>America/Caracas</para></entry>
+ <entry><para>America/Asuncion</para></entry>
+ </row>
+ <row>
+ <entry><para>America/Cuiaba</para></entry>
+ <entry><para>America/Halifax</para></entry>
+ <entry><para>America/La_Paz</para></entry>
+ </row>
+ <row>
+ <entry><para>America/Santiago</para></entry>
+ <entry><para>America/St_Johns</para></entry>
+ <entry><para>America/Araguaina</para></entry>
+ </row>
+ <row>
+ <entry><para>America/Argentina/Buenos_Aires</para></entry>
+ <entry><para>America/Cayenne</para></entry>
+ <entry><para>America/Godthab</para></entry>
+ </row>
+ <row>
+ <entry><para>America/Montevideo</para></entry>
+ <entry><para>Etc/GMT+2</para></entry>
+ <entry><para>Atlantic/Azores</para></entry>
+ </row>
+ <row>
+ <entry><para>Atlantic/Cape_Verde</para></entry>
+ <entry><para>Africa/Casablanca</para></entry>
+ <entry><para>Etc/UTC</para></entry>
+ </row>
+ <row>
+ <entry><para>Atlantic/Reykjavik</para></entry>
+ <entry><para>Europe/London</para></entry>
+ <entry><para>CET</para></entry>
+ </row>
+ <row>
+ <entry><para>Europe/Bucharest</para></entry>
+ <entry><para>Africa/Johannesburg</para></entry>
+ <entry><para>Asia/Beirut</para></entry>
+ </row>
+ <row>
+ <entry><para>Africa/Cairo</para></entry>
+ <entry><para>Asia/Jerusalem</para></entry>
+ <entry><para>Europe/Minsk</para></entry>
+ </row>
+ <row>
+ <entry><para>Europe/Moscow</para></entry>
+ <entry><para>Africa/Nairobi</para></entry>
+ <entry><para>Asia/Karachi</para></entry>
+ </row>
+ <row>
+ <entry><para>Asia/Kolkata</para></entry>
+ <entry><para>Asia/Bangkok</para></entry>
+ <entry><para>Asia/Shanghai</para></entry>
+ </row>
+ <row>
+ <entry><para>Asia/Kuala_Lumpur</para></entry>
+ <entry><para>Australia/Perth</para></entry>
+ <entry><para>Asia/Taipei</para></entry>
+ </row>
+ <row>
+ <entry><para>Asia/Tokyo</para></entry>
+ <entry><para>Asia/Seoul</para></entry>
+ <entry><para>Australia/Adelaide</para></entry>
+ </row>
+ <row>
+ <entry><para>Australia/Darwin</para></entry>
+ <entry><para>Australia/Brisbane</para></entry>
+ <entry><para>Australia/Canberra</para></entry>
+ </row>
+ <row>
+ <entry><para>Pacific/Guam</para></entry>
+ <entry><para>Pacific/Auckland</para></entry>
+ <entry><para></para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/trial-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/trial-installation.xml b/docs/en-US/trial-installation.xml
new file mode 100644
index 0000000..9e3e33a
--- /dev/null
+++ b/docs/en-US/trial-installation.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="trial-installation">
+ <title>Trial Installation</title>
+ <para>Coming soon.</para>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-alerts.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-alerts.xml b/docs/en-US/troubleshooting-alerts.xml
new file mode 100644
index 0000000..9127364
--- /dev/null
+++ b/docs/en-US/troubleshooting-alerts.xml
@@ -0,0 +1,39 @@
+<?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="troubleshooting-alerts">
+ <title>Alerts</title>
+ <para>The following is the list of alert type numbers.</para>
+ <programlisting>
+MEMORY = 0
+CPU = 1
+STORAGE =2
+STORAGE_ALLOCATED = 3
+PUBLIC_IP = 4
+PRIVATE_IP = 5
+HOST = 6
+USERVM = 7
+DOMAIN_ROUTER = 8
+CONSOLE_PROXY = 9
+ROUTING = 10// lost connection to default route (to the gateway)
+STORAGE_MISC = 11 // lost connection to default route (to the gateway)
+USAGE_SERVER = 12 // lost connection to default route (to the gateway)
+MANAGMENT_NODE = 13 // lost connection to default route (to the gateway)
+DOMAIN_ROUTER_MIGRATE = 14
+CONSOLE_PROXY_MIGRATE = 15
+USERVM_MIGRATE = 16
+VLAN = 17
+SSVM = 18
+USAGE_SERVER_RESULT = 19
+STORAGE_DELETE = 20;
+UPDATE_RESOURCE_COUNT = 21; //Generated when we fail to update the resource count
+USAGE_SANITY_RESULT = 22;
+DIRECT_ATTACHED_PUBLIC_IP = 23;
+LOCAL_STORAGE = 24;
+RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only
+
+ </programlisting>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-dataloss-on-exported-primary-storage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-dataloss-on-exported-primary-storage.xml b/docs/en-US/troubleshooting-dataloss-on-exported-primary-storage.xml
new file mode 100644
index 0000000..677bcc3
--- /dev/null
+++ b/docs/en-US/troubleshooting-dataloss-on-exported-primary-storage.xml
@@ -0,0 +1,30 @@
+<?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="troubleshooting-dataloss-on-exported-primary-storage">
+ <title>Data Loss on Exported Primary Storage</title>
+ <formalpara>
+ <title>Symptom</title>
+ <para>Loss of existing data on primary storage which has been exposed as a Linux NFS server export on an iSCSI volume. </para>
+ </formalpara>
+ <formalpara>
+ <title>Cause</title>
+ <para>It is possible that a client from outside the intended pool has mounted the storage. When this occurs, the LVM is wiped and all data in the volume is lost</para>
+ </formalpara>
+ <formalpara>
+ <title>Solution</title>
+ <para>When setting up LUN exports, restrict the range of IP addresses that are allowed access by specifying a subnet mask. For example:</para>
+ </formalpara>
+ <programlisting>echo “/export 192.168.1.0/24(rw,async,no_root_squash)” > /etc/exports</programlisting>
+ <para>Adjust the above command to suit your deployment needs.</para>
+ <formalpara>
+ <title>More Information</title>
+ <para>See the export procedure in the "Secondary Storage" section of the CloudPlatform Installation Guide</para>
+ </formalpara>
+
+
+
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-lb-rules-fails.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-lb-rules-fails.xml b/docs/en-US/troubleshooting-lb-rules-fails.xml
new file mode 100644
index 0000000..1808d06
--- /dev/null
+++ b/docs/en-US/troubleshooting-lb-rules-fails.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="troubleshooting-lb-rules-fails">
+ <title>Load balancer rules fail after changing network offering</title>
+ <formalpara>
+ <title>Symptom</title>
+ <para>After changing the network offering on a network, load balancer rules stop working.</para>
+ </formalpara>
+ <formalpara>
+ <title>Cause</title>
+ <para>Load balancing rules were created while using a network service offering that includes an external load balancer device such as NetScaler, and later the network service offering changed to one that uses the CloudPlatform virtual router.</para>
+ </formalpara>
+ <formalpara>
+ <title>Solution</title>
+ <para>Create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para>
+ </formalpara>
+
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml b/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml
new file mode 100644
index 0000000..60d769f
--- /dev/null
+++ b/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.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="troubleshooting-maintenance-mode-not-working-on-vCenter">
+ <title>Maintenance mode not working on vCenter</title>
+ <formalpara>
+ <title>Symptom</title>
+ <para>Host was placed in maintenance mode, but still appears live in vCenter. </para>
+ </formalpara>
+ <formalpara>
+ <title>Cause</title>
+ <para>The CloudPlatform administrator UI was used to place the host in scheduled maintenance mode. This mode is separate from vCenter's maintenance mode.</para>
+ </formalpara>
+ <formalpara>
+ <title>Solution</title>
+ <para>Use vCenter to place the host in maintenance mode.</para>
+ </formalpara>
+ <formalpara>
+ <title>More Information</title>
+ <para>See <xref linkend="scheduled-maintenance-maintenance-mode-hosts"/></para>
+ </formalpara>
+
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-recover-lost-virtual-router.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-recover-lost-virtual-router.xml b/docs/en-US/troubleshooting-recover-lost-virtual-router.xml
new file mode 100644
index 0000000..f4699d8
--- /dev/null
+++ b/docs/en-US/troubleshooting-recover-lost-virtual-router.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="troubleshooting-recover-lost-virtual-router">
+ <title>Recovering a Lost Virtual Router </title>
+ <formalpara>
+ <title>Symptom</title>
+ <para>A virtual router is running, but the host is disconnected. A virtual router no longer functions as expected.</para>
+ </formalpara>
+ <formalpara>
+ <title>Cause</title>
+ <para>The Virtual router is lost or down.</para>
+ </formalpara>
+ <formalpara>
+ <title>Solution</title>
+ <para>If you are sure that a virtual router is down forever, or no longer functions as expected, destroy it. You must create one afresh while keeping the backup router up and running (it is assumed this is in a redundant router setup):</para>
+ </formalpara>
+ <itemizedlist>
+ <listitem><para>Force stop the router. Use the stopRouter API with forced=true parameter to do so.</para></listitem>
+ <listitem><para>Before you continue with destroying this router, ensure that the backup router is running. Otherwise the network connection will be lost.</para></listitem>
+ <listitem><para>Destroy the router by using the destroyRouter API.</para></listitem>
+ </itemizedlist>
+ <para>Recreate the missing router by using the restartNetwork API with cleanup=false parameter. For more information about redundant router setup, see Creating a New Network Offering.</para>
+ <para>For more information about the API syntax, see the API Reference at <ulink url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack"></ulink>API Reference.</para>
+
+
+
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-unable-to-deploy-vms.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-unable-to-deploy-vms.xml b/docs/en-US/troubleshooting-unable-to-deploy-vms.xml
new file mode 100644
index 0000000..f1432c4
--- /dev/null
+++ b/docs/en-US/troubleshooting-unable-to-deploy-vms.xml
@@ -0,0 +1,21 @@
+<?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="troubleshooting-unable-to-deploy-vms">
+ <title>Unable to deploy VMs from uploaded vSphere template</title>
+ <formalpara>
+ <title>Symptom</title>
+ <para>When attempting to create a VM, the VM will not deploy. </para>
+ </formalpara>
+ <formalpara>
+ <title>Cause</title>
+ <para>If the template was created by uploading an OVA file that was created using vSphere Client, it is possible the OVA contained an ISO image. If it does, the deployment of VMs from the template will fail.</para>
+ </formalpara>
+ <formalpara>
+ <title>Solution</title>
+ <para>Remove the ISO and re-upload the template.</para>
+ </formalpara>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-unable-to-power-on-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-unable-to-power-on-vm.xml b/docs/en-US/troubleshooting-unable-to-power-on-vm.xml
new file mode 100644
index 0000000..ba11473
--- /dev/null
+++ b/docs/en-US/troubleshooting-unable-to-power-on-vm.xml
@@ -0,0 +1,27 @@
+<?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="troubleshooting-unable-to-power-on-vm">
+ <title>Unable to power on virtual machine on VMware</title>
+ <formalpara>
+ <title>Symptom</title>
+ <para>Virtual machine does not power on. You might see errors like: </para>
+ </formalpara>
+ <itemizedlist>
+ <listitem><para>Unable to open Swap File</para></listitem>
+ <listitem><para>Unable to access a file since it is locked</para></listitem>
+ <listitem><para> Unable to access Virtual machine configuration</para></listitem>
+ </itemizedlist>
+ <formalpara>
+ <title>Cause</title>
+ <para>A known issue on VMware machines. ESX hosts lock certain critical virtual machine files and file systems to prevent concurrent changes. Sometimes the files are not unlocked when the virtual machine is powered off. When a virtual machine attempts to power on, it can not access these critical files, and the virtual machine is unable to power on.</para>
+ </formalpara>
+ <formalpara>
+ <title>Solution</title>
+ <para>See the following:</para>
+ </formalpara>
+ <para><ulink url="http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=10051/">VMware Knowledge Base Article</ulink></para>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting-working-with-server-logs.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-working-with-server-logs.xml b/docs/en-US/troubleshooting-working-with-server-logs.xml
new file mode 100644
index 0000000..9255b5a
--- /dev/null
+++ b/docs/en-US/troubleshooting-working-with-server-logs.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="troubleshooting-working-with-server-logs">
+ <title>Working with Server Logs</title>
+ <para>The CloudPlatform Management Server logs all web site, middle tier, and database activities for diagnostics purposes in /var/log/cloud/management/. The CloudPlatform logs a variety of error messages. We recommend this command to find the problematic output in the Management Server log:.</para>
+ <note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
+ <programlisting>
+ grep -i -E 'exception|unable|fail|invalid|leak|warn|error' /var/log/cloud/management/management-server.log
+ </programlisting>
+ <para>The CloudPlatform processes requests with a Job ID. If you find an error in the logs and you are interested in debugging the issue you can grep for this job ID in the management server log. For example, suppose that you find the following ERROR message:</para>
+ <programlisting>
+ 2010-10-04 13:49:32,595 ERROR [cloud.vm.UserVmManagerImpl] (Job-Executor-11:job-1076) Unable to find any host for [User|i-8-42-VM-untagged]
+ </programlisting>
+ <para>Note that the job ID is 1076. You can track back the events relating to job 1076 with the following grep:</para>
+ <programlisting>
+ grep "job-1076)" management-server.log
+ </programlisting>
+ <para>The CloudPlatform Agent Server logs its activities in /var/log/cloud/agent/.</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/troubleshooting.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting.xml b/docs/en-US/troubleshooting.xml
new file mode 100644
index 0000000..c129dc9
--- /dev/null
+++ b/docs/en-US/troubleshooting.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="troubleshooting">
+ <para><xref linkend="appendix-a-time-zones" />IP Load Balancing</para>
+ <para><xref linkend="troubleshooting-alerts" />DNS and DHCP</para>
+ <para><xref linkend="troubleshooting-working-with-server-logs" />VPN</para>
+ <para><xref linkend="troubleshooting-dataloss-on-exported-primary-storage" />Configuring VPN</para>
+ <para><xref linkend="troubleshooting-recover-lost-virtual-router" />Using VPN with Windows</para>
+ <para><xref linkend="troubleshooting-maintenance-mode-not-working-on-vCenter" />Using VPN with Mac</para>
+ <para><xref linkend="troubleshooting-unable-to-deploy-vms" />Templates</para>
+ <para><xref linkend="troubleshooting-unable-to-power-on-vm" />Events</para>
+ <para><xref linkend="troubleshooting-lb-rules-fails" />Templates</para>
+
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/tuning.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/tuning.xml b/docs/en-US/tuning.xml
new file mode 100644
index 0000000..91b0f0c
--- /dev/null
+++ b/docs/en-US/tuning.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="tuning">
+ <title>Tuning</title>
+ <para>This section provides tips on how to improve the performance of your cloud.</para>
+ <xi:include href="performance-monitoring.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="increase-management-server-max-memory.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="set-database-buffer-pool-size.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="set-monitor-total-vm-limits-per-host.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="configure-xenserver-dom0-memory.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/ui.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ui.xml b/docs/en-US/ui.xml
new file mode 100644
index 0000000..d01f1d2
--- /dev/null
+++ b/docs/en-US/ui.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;
+]>
+<chapter id="ui">
+ <title>User Interface</title>
+ <xi:include href="log-in.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/upgrade-virtual-router-with-service-offering.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/upgrade-virtual-router-with-service-offering.xml b/docs/en-US/upgrade-virtual-router-with-service-offering.xml
new file mode 100644
index 0000000..72cb433
--- /dev/null
+++ b/docs/en-US/upgrade-virtual-router-with-service-offering.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="upgrade-virtual-router-with-service-offering">
+ <title>Upgrading a Virtual Router with System Service Offerings</title>
+ <para>When CloudPlatform creates a virtual router, it uses default settings which are defined in a default system service offering. See <xref linkend="system-service-offerings"/>. All the virtual routers in a single guest network use the same system service offering. You can upgrade the capabilities of the virtual router by creating and applying a custom system service offering.</para>
+ <orderedlist>
+ <listitem><para>Define your custom system service offering. See <xref linkend="creating-system-service-offerings"/>. In System VM Type, choose Domain Router.</para></listitem>
+ <listitem><para>Associate the system service offering with a network offering. See <xref linkend="creating-network-offerings"/></para></listitem>
+ <listitem><para>3. Apply the network offering to the network where you want the virtual routers to use the new system service offering. If this is a new network, follow the steps in Adding an Additional Guest Network on page 66. To change the service offering for existing virtual routers, follow the steps in <xref linkend="change-network-offering-on-guest-network"/>.</para></listitem>
+ </orderedlist>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/upload-existing-volume-to-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/upload-existing-volume-to-vm.xml b/docs/en-US/upload-existing-volume-to-vm.xml
new file mode 100644
index 0000000..da6e157
--- /dev/null
+++ b/docs/en-US/upload-existing-volume-to-vm.xml
@@ -0,0 +1,57 @@
+<?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="upload-existing-volume-to-vm">
+ <title>Uploading an Existing Volume to a Virtual Machine</title>
+ <para>Existing data can be made accessible to a virtual machine. This is called uploading a volume to the VM. For example, this is useful to upload data from a local file system and attach it to a VM. Root administrators, domain administrators, and end users can all upload existing volumes to VMs.</para>
+ <para>The upload is performed using HTTP. The uploaded volume is placed in the zone's secondary storage</para>
+ <para>You cannot upload a volume if the preconfigured volume limit has already been reached. The default limit for the cloud is set in the global configuration parameter max.account.volumes, but administrators can also set per-domain limits that are different from the global default. See Setting Usage Limits </para>
+ <para>To upload a volume:</para>
+ <orderedlist>
+ <listitem><para>(Optional) Create an MD5 hash (checksum) of the disk image file that you are going to upload. After uploading the data disk, CloudPlatform will use this value to verify that no data corruption has occurred.</para></listitem>
+ <listitem><para>Log in to the CloudPlatform UI as an administrator or user</para></listitem>
+ <listitem><para>In the left navigation bar, click Storage.</para></listitem>
+ <listitem><para>Click Upload Volume.</para></listitem>
+ <listitem><para>Provide the following:</para>
+ <itemizedlist>
+ <listitem><para>Name and Description. Any desired name and a brief description that can be shown in the UI.</para></listitem>
+ <listitem><para>Availability Zone. Choose the zone where you want to store the volume. VMs running on hosts in this zone can attach the volume.</para></listitem>
+ <listitem><para>Format. Choose one of the following to indicate the disk image format of the volume.</para>
+ <informaltable>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+
+ <thead>
+ <row>
+ <entry><para>Hypervisor</para></entry>
+ <entry><para>Disk Image Format</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>XenServer</para></entry>
+ <entry><para>VHD</para></entry>
+ </row>
+ <row>
+ <entry><para>VMware</para></entry>
+ <entry><para>OVA</para></entry>
+ </row>
+ <row>
+ <entry><para>KVM</para></entry>
+ <entry><para>QCOW2</para></entry>
+ </row>
+ <row>
+ <entry><para>OVM</para></entry>
+ <entry><para>RAW</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable></listitem>
+ <listitem><para>URL. The secure HTTP or HTTPS URL that CloudPlatform can use to access your disk. The type of file at the URL must match the value chosen in Format. For example, if Format is VHD, the URL might look like the following:</para>
+ <para>http://yourFileServerIP/userdata/myDataDisk.vhd</para></listitem>
+ <listitem><para>MD5 checksum. (Optional) Use the hash that you created in step 1.</para></listitem></itemizedlist></listitem>
+ <listitem><para>Wait until the status of the volume shows that the upload is complete. Click Instances - Volumes, find the name you specified in step 5, and make sure the status is Uploaded.</para></listitem>
+ </orderedlist>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/upload-template.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/upload-template.xml b/docs/en-US/upload-template.xml
new file mode 100644
index 0000000..2021b6b
--- /dev/null
+++ b/docs/en-US/upload-template.xml
@@ -0,0 +1,44 @@
+<?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="upload-template">
+ <title>Uploading Templates</title>
+ <note><para>If you are uploading a template that was created using vSphere Client, be sure the OVA file does not contain an ISO. If it does, the deployment of VMs from the template will fail.</para></note>
+ <para>Templates are uploaded based on a URL. HTTP is the supported access protocol. Templates are frequently large files. You can optionally gzip them to decrease upload times.</para>
+ <para>To upload a template:</para>
+ <orderedlist>
+ <listitem><para>In the left navigation bar, click Templates.</para></listitem>
+ <listitem><para>Click Create Template.</para></listitem>
+ <listitem><para>Provide the following:</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so
+ choose something descriptive.</para></listitem>
+ <listitem><para>URL. The Management Server will download the file from the specified URL, such as http://my.web.server/filename.vhd.gz.</para></listitem>
+ <listitem><para>Zone. Choose the zone where you want the template to be available, or All Zones to make it available throughout CloudPlatform.</para></listitem>
+ <listitem><para>OS Type: This helps CloudPlatform and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following:</para>
+ <itemizedlist>
+ <listitem><para>If the operating system of the stopped VM is listed, choose it.</para></listitem>
+ <listitem><para>If the OS type of the stopped VM is not listed, choose Other.</para>
+ <note><para>Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para><emphasis role="bold">Hypervisor</emphasis></para></listitem>
+ <listitem><para><emphasis role="bold">Format</emphasis>. The format of the template upload file, such as VHD
+ or OVA.</para></listitem>
+ <listitem><para><emphasis role="bold">Password Enabled</emphasis>. Choose Yes if your template has the
+ CloudPlatform password change script installed. See Adding Password
+ Management to Your Templates</para></listitem>
+ <listitem><para><emphasis role="bold">Extractable</emphasis>. Choose Yes if the template is available for extraction. If this option is selected, end users can
+ download a full image of a template.</para></listitem>
+ <listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all
+ users of this CloudPlatform installation. The template will appear in the
+ Community Templates list. See <xref linkend="private-public-template"/></para></listitem>
+ <listitem><para><emphasis role="bold">Featured</emphasis>. Choose Yes if you would like this template to be
+ more prominent for users to select. The template will appear in the Featured
+ Templates list. Only an administrator can make a template Featured.</para></listitem>
+ </itemizedlist></listitem>
+
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/usage-record-format.xml b/docs/en-US/usage-record-format.xml
new file mode 100644
index 0000000..21dd326
--- /dev/null
+++ b/docs/en-US/usage-record-format.xml
@@ -0,0 +1,17 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book 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="usage-record-format">
+ <title>Usage Record Format</title>
+ <xi:include href="virtual-machine-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="network-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="ipaddress-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="disk-volume-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="template-iso-snapshot-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="loadbalancer-policy-port-forwarding-rule-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="network-offering-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="VPN-user-usage-record-format.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/usage-types.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/usage-types.xml b/docs/en-US/usage-types.xml
new file mode 100644
index 0000000..868d331
--- /dev/null
+++ b/docs/en-US/usage-types.xml
@@ -0,0 +1,101 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book 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="usage-types">
+ <title>Usage Types</title>
+ <para>The following table shows all usage types.</para>
+ <informaltable>
+ <tgroup cols="3">
+ <colspec colname="c1" colnum="1" colwidth="4cm" />
+ <colspec colname="c2" colnum="2" colwidth="8cm" />
+ <colspec colname="c3" colnum="3" colwidth="5cm" />
+ <thead>
+ <row>
+ <entry>Type ID</entry>
+ <entry>Type Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>1</entry>
+ <entry>RUNNING_VM</entry>
+ <entry>Tracks the total running time of a VM per usage record period. If the VM is upgraded during the usage period, you will get a separate Usage Record for the new upgraded VM.</entry>
+ </row>
+ <row>
+ <entry><para>2</para></entry>
+ <entry><para>ALLOCATED_VM</para></entry>
+ <entry><para>Tracks the total time the VM has been created to the time when it has been destroyed. This usage type is also useful in determining usage for specific templates such as Windows-based templates.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>3</para></entry>
+ <entry><para>IP_ADDRESS</para></entry>
+ <entry><para>Tracks the public IP address owned by the account.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>4</para></entry>
+ <entry><para>NETWORK_BYTES_SENT</para></entry>
+ <entry><para>Tracks the total number of bytes sent by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>5</para></entry>
+ <entry><para>NETWORK_BYTES_RECEIVED</para></entry>
+ <entry><para>Tracks the total number of bytes received by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>6</para></entry>
+ <entry><para>VOLUME</para></entry>
+ <entry><para>Tracks the total time a disk volume has been created to the time when it has been destroyed.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>7</para></entry>
+ <entry><para>TEMPLATE</para></entry>
+ <entry><para>Tracks the total time a template (either created from a snapshot or uploaded to the cloud) has been created to the time it has been destroyed. The size of the template is also returned.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>8</para></entry>
+ <entry><para>ISO</para></entry>
+ <entry><para>Tracks the total time an ISO has been uploaded to the time it has been removed from the cloud. The size of the ISO is also returned.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>9</para></entry>
+ <entry><para>SNAPSHOT</para></entry>
+ <entry><para>Tracks the total time from when a snapshot has been created to the time it have been destroyed.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>11</para></entry>
+ <entry><para>LOAD_BALANCER_POLICY</para></entry>
+ <entry><para>Tracks the total time a load balancer policy has been created to the time it has been removed. Cloud.com does not track whether a VM has been assigned to a policy.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>12</para></entry>
+ <entry><para>PORT_FORWARDING_RULE</para></entry>
+ <entry><para>Tracks the time from when a port forwarding rule was created until the time it was removed.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>13</para></entry>
+ <entry><para>NETWORK_OFFERING</para></entry>
+ <entry><para>The time from when a network offering was assigned to a VM until it is removed.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>14</para></entry>
+ <entry><para>VPN_USERS</para></entry>
+ <entry><para>The time from when a VPN user is created until it is removed.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/use-project-view.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/use-project-view.xml b/docs/en-US/use-project-view.xml
new file mode 100644
index 0000000..6935ee8
--- /dev/null
+++ b/docs/en-US/use-project-view.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="use-project-view">
+ <title>Using the Project View</title>
+ <para>If you are a member of a project, you can use CloudPlatform’s project view to see project members, resources consumed, and more. The project view shows only information related to one project. It is a useful way to filter out other information so you can concentrate on a project status and resources.</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI.</para></listitem>
+ <listitem><para>Click Project View.</para></listitem>
+ <listitem><para>The project dashboard appears, showing the project’s VMs, volumes, users, events, network settings, and more. From the dashboard, you can:</para>
+ <itemizedlist>
+ <listitem><para>Click the Accounts tab to view and manage project members. If you are the project administrator, you can add new members, remove members, or change the role of a member from user to admin. Only one member at a time can have the admin role, so if you set another user’s role to admin, your role will change to regular user.</para></listitem>
+ <listitem><para>(If invitations are enabled) Click the Invitations tab to view and manage invitations that
+ have been sent to new project members but not yet accepted. Pending invitations will
+ remain in this list until the new member accepts, the invitation timeout is reached, or
+ you cancel the invitation.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/user-data-and-meta-data.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/user-data-and-meta-data.xml b/docs/en-US/user-data-and-meta-data.xml
new file mode 100644
index 0000000..6724af7
--- /dev/null
+++ b/docs/en-US/user-data-and-meta-data.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="user-data-and-meta-data">
+ <title>User Data and Meta Data</title>
+ <para>CloudPlatform provides API access to attach user data to a deployed VM. Deployed VMs also have access to instance metadata via the virtual router.</para>
+ <para>User data can be accessed once the IP address of the virtual router is known. Once the IP address is known, use the following steps to access the user data:</para>
+ <orderedlist>
+ <listitem><para>Run the following command to find the virtual router.</para><programlisting># cat /var/lib/dhclient/dhclient-eth0.leases | grep dhcp-server-identifier | tail -1</programlisting></listitem>
+ <listitem><para>Access user data by running the following command using the result of the above command</para><programlisting># curl http://10.1.1.1/latest/user-data</programlisting></listitem>
+ </orderedlist>
+ <para>Meta Data can be accessed similarly, using a URL of the form http://10.1.1.1/latest/meta-data/{metadata type}. (For backwards compatibility, the previous URL http://10.1.1.1/latest/{metadata type} is also supported.) For metadata type, use one of the following:</para>
+ <itemizedlist>
+ <listitem><para>service-offering. A description of the VMs service offering</para></listitem>
+ <listitem><para>availability-zone. The Zone name</para></listitem>
+ <listitem><para>local-ipv4. The guest IP of the VM</para></listitem>
+ <listitem><para>local-hostname. The hostname of the VM</para></listitem>
+ <listitem><para>public-ipv4. The first public IP for the router. (E.g. the first IP of eth2)</para></listitem>
+ <listitem><para>public-hostname. This is the same as public-ipv4</para></listitem>
+ <listitem><para>instance-id. The instance name of the VM</para></listitem>
+ </itemizedlist>
+
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/user-services-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/user-services-overview.xml b/docs/en-US/user-services-overview.xml
new file mode 100644
index 0000000..3c24590
--- /dev/null
+++ b/docs/en-US/user-services-overview.xml
@@ -0,0 +1,77 @@
+<section id="user-services-overview">
+ <title>User Services Overview</title>
+ <para>In addition to the physical and logical infrastructure of your cloud, and the CloudPlatform software and servers, you also need a layer of user services so that people can actually make use of the cloud. This means not just a user UI, but a set of options and resources that users can choose from, such as templates for creating virtual machines, disk storage, and more. If you are running a commercial service, you will be keeping track of what services and resources users are consuming and charging them for that usage. Even if you do not charge anything for people to use your cloud – say, if the users are strictly internal to your organization, or just friends who are sharing your cloud – you can still keep track of what services they use and how much of them.</para>
+ <section id="offerings-and-templates">
+ <title>Service Offerings, Disk Offerings, Network Offerings, and Templates</title>
+ <para>A user creating a new instance can make a variety of choices about its characteristics and capabilities. CloudPlatform provides several ways to present users with choices when creating a new instance:</para>
+ <itemizedlist>
+ <listitem><para>Service Offerings, defined by the CloudPlatform administrator, provide a choice of CPU speed, number of CPUs, RAM size, tags on the root disk, and other choices. See Creating a New Compute Offering.</para></listitem>
+ <listitem><para>Disk Offerings, defined by the CloudPlatform administrator, provide a choice of disk size for primary data storage. See Creating a New Disk Offering.</para></listitem>
+ <listitem><para>Network Offerings, defined by the CloudPlatform administrator, describe the feature set that is available to end users from the virtual router or external networking devices on a given guest network. See Network Offerings.</para></listitem>
+ <listitem><para> Templates, defined by the CloudPlatform administrator or by any CloudPlatform user, are the base OS images that the user can choose from when creating a new instance. For example, CloudPlatform includes CentOS as a template. See Working with Templates.</para></listitem>
+ </itemizedlist>
+ <para>In addition to these choices that are provided for users, there is another type of service offering which is available only to the CloudPlatform root administrator, and is used for configuring virtual infrastructure resources. For more information, see Upgrading a Virtual Router with System Service Offerings.</para>
+ </section>
+ <section id="accounts-users-domains">
+ <title>Accounts, Users, and Domains</title>
+ <para>An account typically represents a customer of the service provider or a department in a large organization. Multiple users can exist in an account. Users are like aliases in the account. Users in the same account are not isolated from each other, but they are isolated from users in other accounts. Most installations need not surface the notion of users; they just have one user per account.</para>
+ <para>Accounts are grouped by domains. Domains usually contain accounts that have some logical relationship to each other and a set of delegated administrators with some authority over the domain and its subdomains. For example, a service provider with several resellers could create a domain for each reseller.</para>
+ <para>Administrators are accounts with special privileges in the system. There may be multiple administrators in the system. Administrators can create or delete other administrators, and change the password for any user in the system. Root administrators have complete access to the system, including managing templates, service offerings, customer care administrators, and domains. Domain administrators can perform administrative operations for users who belong to that domain. Domain administrators do not have visibility into physical servers or other domains.</para>
+ </section>
+ <section id="using-ldap-server">
+ <title>Using an LDAP Server for User Authentication</title>
+ <para>You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate CloudPlatform end-users. Just map CloudPlatform accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by CloudPlatform for matching common values such as the user’s email address and name. CloudPlatform will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user.</para>
+ <para>To set up LDAP authentication in CloudPlatform, call the CloudPlatform API command ldapConfig and provide the following:</para>
+ <itemizedlist>
+ <listitem><para>Hostname or IP address and listening port of the LDAP server</para></listitem>
+ <listitem><para>Base directory and query filter</para></listitem>
+ <listitem><para>Search user DN credentials, which give CloudPlatform permission to search on the LDAP server</para></listitem>
+ <listitem><para>SSL keystore and password, if SSL is used</para></listitem>
+ </itemizedlist>
+ <section id="example-ldap-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>
+ <section id="search-base">
+ <title>Search Base</title>
+ <para>Coming soon: TODO</para>
+ </section>
+ <section id="query-filter">
+ <title>Query Filter</title>
+ <para>Coming soon: TODO</para>
+ </section>
+ <section id="search-user-bind-dn">
+ <title>Search User Bind DN</title>
+ <para>Coming soon: TODO</para>
+ </section>
+ <section id="ssl-keystore-path-and-password">
+ <title>SSL Keystore Path and Password</title>
+ <para>Coming soon: TODO</para>
+ </section>
+
+ </section>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/using-multiple-guest-networks.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-multiple-guest-networks.xml b/docs/en-US/using-multiple-guest-networks.xml
new file mode 100644
index 0000000..1ff0804
--- /dev/null
+++ b/docs/en-US/using-multiple-guest-networks.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="using-multiple-guest-networks">
+ <title>Using Multiple Guest Networks</title>
+ <para>In zones that use advanced networking, additional networks for guest traffic may be added at any time after the initial installation. You can also customize the domain name associated with the network by specifying a DNS suffix for each network.</para>
+ <para>A VM's networks are defined at VM creation time. A VM cannot add or remove networks after it has been created, although the user can go into the guest and remove the IP address from the NIC on a particular network.</para>
+ <para>Each VM has just one default network. The virtual router's DHCP reply will set the guest's default gateway as that for the default network. Multiple non-default networks may be added to a guest in addition to the single, required default network. The administrator can control which networks are available as the default network.</para>
+ <para>Additional networks can either be available to all accounts or be assigned to a specific account. Networks that are available to all accounts are zone-wide. Any user with access to the zone can create a VM with access to that network. These zone-wide networks provide little or no isolation between guests. Networks that are assigned to a specific account provide strong isolation.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/using-netscaler-load-balancers.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-netscaler-load-balancers.xml b/docs/en-US/using-netscaler-load-balancers.xml
new file mode 100644
index 0000000..61fb6fa
--- /dev/null
+++ b/docs/en-US/using-netscaler-load-balancers.xml
@@ -0,0 +1,42 @@
+<?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="using-netscaler-load-balancers">
+ <title>About Using a NetScaler Load Balancer</title>
+ <para>Citrix NetScaler is supported as an external network element for load balancing in zones that use advanced networking (also called advanced zones). Set up an external load balancer when you want to provide load balancing through means other than CloudPlatform’s provided virtual router.</para>
+ <para>The NetScaler can be set up in direct (outside the firewall) mode. It must be added before any load balancing rules are deployed on guest VMs in the zone.</para>
+ <para>The functional behavior of the NetScaler with CloudPlatform is the same as described in the CloudPlatform documentation for using an F5 external load balancer. The only exception is that the F5 supports routing domains, and NetScaler does not. NetScaler can not yet be used as a firewall.</para>
+ <para>The Citrix NetScaler comes in three varieties. The following table summarizes how these variants are treated in CloudPlatform.</para>
+ <informaltable>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry><para>NetScaler ADC Type</para></entry>
+ <entry><para>Description of Capabilities</para></entry>
+ <entry><para>CloudPlatform 3.0.3 Supported Features</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>MPX</para></entry>
+ <entry><para>Physical appliance. Capable of deep packet inspection. Can act as application firewall and load balancer</para></entry>
+ <entry><para>In advanced zones, load balancer functionality fully supported without limitation. In basic zones, static NAT, elastic IP (EIP), and elastic load balancing (ELB) are also provided</para></entry>
+
+ </row>
+ <row>
+ <entry><para>VPX</para></entry>
+ <entry><para>Virtual appliance. Can run as VM on XenServer, ESXi, and Hyper-V hypervisors. Same functionality as MPX</para></entry>
+ <entry><para>Supported only on ESXi. Same functional support as for MPX. CloudPlatform will treat VPX and MPX as the same device type</para></entry>
+ </row>
+ <row>
+ <entry><para>SDX</para></entry>
+ <entry><para>Physical appliance. Can create multiple fully isolated VPX instances on a single appliance to support multi-tenant usage</para></entry>
+ <entry><para>CloudPlatform will dynamically provision, configure, and manage the lifecycle of VPX instances on the SDX. Provisioned instances are added into CloudPlatform automatically – no manual configuration by the administrator is required. Once a VPX instance is added into CloudPlatform, it is treated the same as a VPX on an ESXi host.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/using-sshkeys.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-sshkeys.xml b/docs/en-US/using-sshkeys.xml
new file mode 100644
index 0000000..a753b32
--- /dev/null
+++ b/docs/en-US/using-sshkeys.xml
@@ -0,0 +1,87 @@
+<?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="using-sshkeys">
+ <title>Using the SSH Keys for Authentication on Cloud</title>
+ <para>In addition to the username and password authentication, CloudStack supports using SSH
+ keys to log in to the cloud infrastructure for additional security for your cloud
+ infrastructure. You can use the createSSHKeyPair API to generate the SSH keys.</para>
+ <para>Because each cloud user has their own ssh key, one cloud user cannot log in to another
+ cloud user's instances unless they share their ssh key files. Using a single SSH key pair,
+ you can manage multiple instances.</para>
+ <sect1 id="create-template">
+ <title> Creating an Instance Template that Supports SSH Keys</title>
+ <para></para>
+ <orderedlist>
+ <listitem><para>Create a instance template that supports SSH Keys.</para>
+ <orderedlist numeration="loweralpha"><listitem><para>Create a new instance by using the template provided by cloudstack.</para>
+ <para>For more information on creating a new instance, see </para></listitem>
+ <listitem><para>Download the cloudstack script from <ulink url="http://sourceforge.net/projects/cloudstack/files/SSH%20Key%20Gen%20Script/">The SSH Key Gen Script</ulink>to the instance you have created.</para>
+ <programlisting>wget http://downloads.sourceforge.net/project/cloudstack/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fcloudstack%2Ffiles%2FSSH%2520Key%2520Gen%2520Script%2F&ts=1331225219&use_mirror=iweb</programlisting></listitem>
+ <listitem><para>Copy the file to /etc/init.d.</para>
+ <programlisting>cp cloud-set-guest-sshkey.in /etc/init.d/</programlisting></listitem>
+ <listitem><para>Give the necessary permissions on the script:</para>
+ <programlisting>chmod +x /etc/init.d/cloud-set-guest-sshkey.in</programlisting></listitem>
+ <listitem><para>Run the script while starting up the operating system:</para>
+ <programlisting>chkconfig --add cloud-set-guest-sshkey.in</programlisting></listitem>
+ <listitem><para>Stop the instance.</para></listitem>
+ </orderedlist></listitem>
+ </orderedlist>
+ </sect1>
+ <sect1 id="gen-ssh-keypair">
+ <title>Creating the SSH Keypair</title>
+ <para>You must make a call to the createSSHKeyPair api method. You can either use the cloudstack python api library or the curl commands to make the call to the cloudstack api.</para>
+ <para>For example, make a call from the cloudstack server to create a SSH keypair called "keypair-doc" for the admin account in the root domain:</para>
+ <note><para>Ensure that you adjust these values to meet your needs. If you are making the API call from a different server, your URL/PORT will be different, and you will need to use the API keys.</para></note>
+ <orderedlist>
+ <listitem><para>Run the following curl command:</para>
+ <programlisting>curl --globoff "http://localhost:8096/?command=createSSHKeyPair&name=keypair-doc&account=admin&domainid=5163440e-c44b-42b5-9109-ad75cae8e8a2"</programlisting>
+ <para>The output is something similar to what is given below:</para>
+ <programlisting><?xml version="1.0" encoding="ISO-8859-1"?><createsshkeypairresponse cloud-stack-version="3.0.0.20120228045507"><keypair><name>keypair-doc</name><fingerprint>f6:77:39:d5:5e:77:02:22:6a:d8:7f:ce:ab:cd:b3:56</fingerprint><privatekey>-----BEGIN RSA PRIVATE KEY-----
+MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci
+dXYBeZVwakDVsU2MLGl/K+wefwefwefwefwefJyKJaogMKn7BperPD6n1wIDAQAB
+AoGAdXaJ7uyZKeRDoy6wA0UmF0kSPbMZCR+UTIHNkS/E0/4U+6lhMokmFSHtu
+mfDZ1kGGDYhMsdytjDBztljawfawfeawefawfawfawQQDCjEsoRdgkduTy
+QpbSGDIa11Jsc+XNDx2fgRinDsxXI/zJYXTKRhSl/LIPHBw/brW8vzxhOlSOrwm7
+VvemkkgpAkEAwSeEw394LYZiEVv395ar9MLRVTVLwpo54jC4tsOxQCBlloocK
+lYaocpk0yBqqOUSBawfIiDCuLXSdvBo1Xz5ICTM19vgvEp/+kMuECQBzm
+nVo8b2Gvyagqt/KEQo8wzH2THghZ1qQ1QRhIeJG2aissEacF6bGB2oZ7Igim5L14
+4KR7OeEToyCLC2k+02UCQQCrniSnWKtDVoVqeK/zbB32JhW3Wullv5p5zUEcd
+KfEEuzcCUIxtJYTahJ1pvlFkQ8anpuxjSEDp8x/18bq3
+-----END RSA PRIVATE KEY-----
+</privatekey></keypair></createsshkeypairresponse></programlisting></listitem>
+ <listitem><para>Copy the key data into a file. The file looks like this:</para>
+ <programlisting>-----BEGIN RSA PRIVATE KEY-----
+MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci
+dXYBeZVwakDVsU2MLGl/K+wefwefwefwefwefJyKJaogMKn7BperPD6n1wIDAQAB
+AoGAdXaJ7uyZKeRDoy6wA0UmF0kSPbMZCR+UTIHNkS/E0/4U+6lhMokmFSHtu
+mfDZ1kGGDYhMsdytjDBztljawfawfeawefawfawfawQQDCjEsoRdgkduTy
+QpbSGDIa11Jsc+XNDx2fgRinDsxXI/zJYXTKRhSl/LIPHBw/brW8vzxhOlSOrwm7
+VvemkkgpAkEAwSeEw394LYZiEVv395ar9MLRVTVLwpo54jC4tsOxQCBlloocK
+lYaocpk0yBqqOUSBawfIiDCuLXSdvBo1Xz5ICTM19vgvEp/+kMuECQBzm
+nVo8b2Gvyagqt/KEQo8wzH2THghZ1qQ1QRhIeJG2aissEacF6bGB2oZ7Igim5L14
+4KR7OeEToyCLC2k+02UCQQCrniSnWKtDVoVqeK/zbB32JhW3Wullv5p5zUEcd
+KfEEuzcCUIxtJYTahJ1pvlFkQ8anpuxjSEDp8x/18bq3
+-----END RSA PRIVATE KEY-----</programlisting></listitem>
+ <listitem><para>Save the file.</para></listitem>
+ </orderedlist>
+ </sect1>
+ <sect1>
+ <title>Creating an Instance</title>
+ <para>After you save the SSH keypair file, you must create an instance by using the template that you created at <xref linkend="create-template"/>. Ensure that you use the same SSH key name that you created at <xref linkend="gen-ssh-keypair"/>.</para>
+ <note><para>You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair.</para></note>
+ <para>A sample curl command to create a new instance is:</para>
+ <programlisting>curl --globoff http://localhost:<port numbet>/?command=deployVirtualMachine\&zoneId=1\&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813\&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5\&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5\&account=admin\&domainid=1\&keypair=keypair-doc</programlisting>
+ <para>Substitute the template, service offering and security group IDs (if you are using the security group feature) that are in your cloud environment.</para>
+ </sect1>
+ <sect1 id="login-using-sshkey">
+ <title>Logging In Using the SSH Keypair</title>
+ <para>To test your SSH key generation is successful, check whether you can log in to the cloud setup.</para>
+ <para>For exaple, from a Linux OS, run:</para>
+ <programlisting>ssh -i ~/.ssh/keypair-doc <ip address></programlisting>
+ <para>The -i parameter tells the ssh client to use a ssh key found at ~/.ssh/keypair-doc.</para>
+ </sect1>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/using-swift-for-secondary-storage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-swift-for-secondary-storage.xml b/docs/en-US/using-swift-for-secondary-storage.xml
new file mode 100644
index 0000000..a3b873b
--- /dev/null
+++ b/docs/en-US/using-swift-for-secondary-storage.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="using-swift-for-secondary-storage">
+ <title>Using Swift for Secondary Storage</title>
+ <para>CloudPlatform supports OpenStack Object Storage (<ulink url="http://swift.openstack.org/"> Swift</ulink>) for secondary storage. When using Swift, you configure Swift storage for the entire CloudPlatform, then set up NFS secondary storage for each zone as usual. The NFS storage in each zone acts as a staging area through which all templates and other secondary storage data pass before being forwarded to Swift. The Swift storage acts as a cloud-wide resource, making templates and other data available to any zone in the cloud. There is no hierarchy in the Swift storage, just one Swift container per storage object. Any secondary storage in the whole cloud can pull a container from Swift at need. It is not necessary to copy templates and snapshots from one zone to another, as would be required when using zone NFS alone. Everything is available everywhere</para>
+ <para>Swift storage must be set up before you add NFS secondary storage to zones. This is accomplished through some additional configuration steps on a fresh Management Server installation, before you add the first zone. The procedure is described in Adding a Zone in the Advanced Installation Guide.</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/using-vpn-with-mac.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-vpn-with-mac.xml b/docs/en-US/using-vpn-with-mac.xml
new file mode 100644
index 0000000..0104d85
--- /dev/null
+++ b/docs/en-US/using-vpn-with-mac.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="using-vpn-with-mac">
+ <title>Using VPN with Mac OS X</title>
+ <para>In Mac OS X, in Network Preferences – Advanced, make sure Send all traffic over VPN connection is not checked.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/using-vpn-with-windows.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-vpn-with-windows.xml b/docs/en-US/using-vpn-with-windows.xml
new file mode 100644
index 0000000..77389f9
--- /dev/null
+++ b/docs/en-US/using-vpn-with-windows.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="using-vpn-with-windows">
+ <title>Using VPN with Windows</title>
+ <para>The procedure to use VPN varies by Windows version. Generally, the user must edit the VPN properties and make sure that the default route is not the VPN. The following steps are for Windows L2TP clients on Windows Vista. The commands should be similar for other Windows versions.</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI and click on the source NAT IP for the account. The VPN tab should display the IPsec preshared key. Make a note of this and the source NAT IP. The UI also lists one or more users and their passwords. Choose one of these users, or, if none exists, add a user and password.</para></listitem>
+ <listitem><para>On the Windows box, go to Control Panel, then select Network and Sharing center. Click Setup a connection or network.</para></listitem>
+ <listitem><para>In the next dialog, select No, create a new connection.</para></listitem>
+ <listitem><para>In the next dialog, select Use my Internet Connection (VPN).</para></listitem>
+ <listitem><para>In the next dialog, enter the source NAT IP from step 1 and give the connection a name. Check Don't connect now.</para></listitem>
+ <listitem><para>In the next dialog, enter the user name and password selected in step 1.</para></listitem>
+ <listitem><para>Click Create.</para></listitem>
+ <listitem><para>Go back to the Control Panel and click Network Connections to see the new connection. The connection is not active yet.</para></listitem>
+ <listitem><para>Right-click the new connection and select Properties. In the Properties dialog, select the Networking tab.</para></listitem>
+ <listitem><para>In Type of VPN, choose L2TP IPsec VPN, then click IPsec settings. Select Use preshared key. Enter the preshared key from Step 1.</para></listitem>
+ <listitem><para>The connection is ready for activation. Go back to Control Panel -> Network Connections and double-click the created connection.</para></listitem>
+ <listitem><para>Enter the user name and password from Step 1.</para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/vcenter-maintenance-mode.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vcenter-maintenance-mode.xml b/docs/en-US/vcenter-maintenance-mode.xml
new file mode 100644
index 0000000..90732b0
--- /dev/null
+++ b/docs/en-US/vcenter-maintenance-mode.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="vcenter-maintenance-mode">
+ <title>vCenter and Maintenance Mode</title>
+ <para>To enter maintenance mode on a vCenter host, both vCenter and CloudPlatform must be used in concert. CloudPlatform and vCenter have separate maintenance modes that work closely together.</para>
+ <orderedlist>
+ <listitem><para>Place the host into CloudPlatform's "scheduled maintenance" mode. This does not invoke the vCenter maintenance mode, but only causes VMs to be migrated off the host</para>
+ <para>When the CloudPlatform maintenance mode is requested, the host first moves into the Prepare for Maintenance state. In this state it cannot be the target of new guest VM starts. Then all VMs will be migrated off the server. Live migration will be used to move VMs off the host. This allows the guests to be migrated to other hosts with no disruption to the guests. After this migration is completed, the host will enter the Ready for Maintenance mode.</para></listitem>
+ <listitem><para>Wait for the "Ready for Maintenance" indicator to appear in the UI.</para></listitem>
+ <listitem><para>Now use vCenter to perform whatever actions are necessary to maintain the host. During this time, the host cannot be the target of new VM allocations.</para></listitem>
+ <listitem><para>When the maintenance tasks are complete, take the host out of maintenance mode as follows:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>First use vCenter to exit the vCenter maintenance mode.</para>
+ <para>This makes the host ready for CloudPlatform to reactivate it.</para></listitem>
+ <listitem><para>Then use CloudPlatform's administrator UI to cancel the CloudPlatform maintenance mode</para>
+ <para>When the host comes back online, the VMs that were migrated off of it are migrated back to it and new VMs can be added.</para></listitem>
+ </orderedlist></listitem>
+ </orderedlist>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/virtual-machine-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/virtual-machine-usage-record-format.xml b/docs/en-US/virtual-machine-usage-record-format.xml
new file mode 100644
index 0000000..9df22f0
--- /dev/null
+++ b/docs/en-US/virtual-machine-usage-record-format.xml
@@ -0,0 +1,22 @@
+<section id="virtual-machine-usage-record-format">
+ <title>Virtual Machine Usage Record Format</title>
+ <para>For running and allocated virtual machine usage, 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 VM running time)</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>virtualMachineId – The ID of the virtual machine</para></listitem>
+ <listitem><para>name – The name of the virtual machine</para></listitem>
+ <listitem><para>offeringid – The ID of the service offering</para></listitem>
+ <listitem><para>templateid – The ID of the template or the ID of the parent template. The parent template value is present when the current template was created from a volume.</para></listitem>
+ <listitem><para>usageid – Virtual machine</para></listitem>
+ <listitem><para>type – Hypervisor</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/virtual-router.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/virtual-router.xml b/docs/en-US/virtual-router.xml
new file mode 100644
index 0000000..e2bde35
--- /dev/null
+++ b/docs/en-US/virtual-router.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="virtual-router">
+ <title>Virtual Router</title>
+ <para>The virtual router is a type of System Virtual Machine. The virtual router is one of the most frequently used service providers in CloudPlatform. The end user has no direct access to the virtual router. Users can ping the virtual router and take actions that affect it (such as setting up port forwarding), but users do not have SSH access into the virtual router.</para>
+ <para>There is no mechanism for the administrator to log in to the virtual router. Virtual routers can be restarted by administrators, but this will interrupt public network access and other services for end users. A basic test in debugging networking issues is to attempt to ping the virtual router from a guest VM. Some of the characteristics of the virtual router are determined by its associated system service offering..</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/vlan-provisioning.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vlan-provisioning.xml b/docs/en-US/vlan-provisioning.xml
new file mode 100644
index 0000000..5921bb3
--- /dev/null
+++ b/docs/en-US/vlan-provisioning.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="vlan-provisioning">
+ <title>VLAN Provisioning</title>
+ <para>CloudPlatform automatically creates and destroys interfaces bridged to VLANs on the hosts. In general the administrator does not need to manage this process.</para>
+ <para>CloudPlatform manages VLANs differently based on hypervisor type. For XenServer or KVM, the VLANs are created on only the hosts where they will be used and then they are destroyed when all guests that require them have been terminated or moved to another host. .</para>
+ <para>For vSphere the VLANs are provisioned on all hosts in the cluster even if there is no guest running on a particular Host that requires the VLAN. This allows the administrator to perform live migration and other functions in vCenter without having to create the VLAN on the destination Host. Additionally, the VLANs are not removed from the Hosts when they are no longer needed. </para>
+ </section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/vm-lifecycle.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vm-lifecycle.xml b/docs/en-US/vm-lifecycle.xml
new file mode 100644
index 0000000..b9b86e7
--- /dev/null
+++ b/docs/en-US/vm-lifecycle.xml
@@ -0,0 +1,20 @@
+<section id="vm-lifecycle">
+ <title>VM Lifecycle</title>
+ <para>Virtual machines can be in the following states:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/basic_deployment.png" />
+ </imageobject>
+ <textobject><phrase>basic_deployment.png: Basic two-machine CloudStack deployment</phrase></textobject>
+ </mediaobject>
+ <para>Once a virtual machine is destroyed, it cannot be recovered. All the resources used by the virtual machine will be reclaimed by the system. This includes the virtual machine’s IP address.</para>
+ <para>A stop will attempt to gracefully shut down the operating system, which typically involves terminating all the running applications. If the operation system cannot be stopped, it will be forcefully terminated. This has the same effect as pulling the power cord to a physical machine.</para>
+ <para>A reboot is a stop followed by a start.</para>
+ <para>CloudPlatform preserves the state of the virtual machine hard disk until the machine is destroyed.</para>
+ <para>A running virtual machine may fail because of hardware or network issues. A failed virtual machine is in the down state.</para>
+ <para>The system places the virtual machine into the down state if it does not receive the heartbeat from the hypervisor for three minutes.</para>
+ <para>The user can manually restart the virtual machine from the down state.</para>
+ <para>The system will start the virtual machine from the down state automatically if the virtual machine is marked as HA-enabled.</para>
+
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/vm-storage-migration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vm-storage-migration.xml b/docs/en-US/vm-storage-migration.xml
new file mode 100644
index 0000000..fdbbba0
--- /dev/null
+++ b/docs/en-US/vm-storage-migration.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="vm-storage-migration">
+ <title>VM Storage Migration</title>
+ <para>Supported in XenServer, KVM, and VMware.</para>
+ <note><para>This procedure is different from moving disk volumes from one VM to another. See Detaching and Moving Volumes <xref linkend="detach-move-volumes" />.</para></note>
+ <para>You can migrate a virtual machine’s root disk volume or any additional data disk volume from one storage pool to another in the same zone.</para>
+ <para>You can use the storage migration feature to achieve some commonly desired administration goals, such as balancing the load on storage pools and increasing the reliability of virtual machines by moving them away from any storage pool that is experiencing issues.</para>
+ <xi:include href="migrate-datadisk-volume-new-storage-pool.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="migrate-vm-rootvolume-volume-new-storage-pool.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/volume-deletion-garbage-collection.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/volume-deletion-garbage-collection.xml b/docs/en-US/volume-deletion-garbage-collection.xml
new file mode 100644
index 0000000..9f50ac5
--- /dev/null
+++ b/docs/en-US/volume-deletion-garbage-collection.xml
@@ -0,0 +1,17 @@
+<?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="volume-deletion-garbage-collection">
+ <title>Volume Deletion and Garbage Collection</title>
+ <para>The deletion of a volume does not delete the snapshots that have been created from the volume</para>
+ <para>When a VM is destroyed, data disk volumes that are attached to the VM are not deleted.</para>
+ <para>Volumes are permanently destroyed using a garbage collection process. The global configuration variables expunge.delay and expunge.interval determine when the physical deletion of volumes will occur.</para>
+ <itemizedlist>
+ <listitem><para>expunge.delay: determines how old the volume must be before it is destroyed, in seconds</para></listitem>
+ <listitem><para>expunge.interval: determines how often to run the garbage collection check</para></listitem>
+ </itemizedlist>
+ <para>Administrators should adjust these values depending on site policies around data retention.</para>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/volume-status.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/volume-status.xml b/docs/en-US/volume-status.xml
new file mode 100644
index 0000000..88f3717
--- /dev/null
+++ b/docs/en-US/volume-status.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="volume-status">
+ <title>Volume Status</title>
+ <para>When a snapshot operation is triggered by means of a recurring snapshot policy, a snapshot is skipped if a volume has remained inactive since its last snapshot was taken. A volume is considered to be inactive if it is either detached or attached to a VM that is not running. CloudPlatform ensures that at least one snapshot is taken since the volume last became inactive.</para>
+ <para>When a snapshot is taken manually, a snapshot is always created regardless of whether a volume has been active or not.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e874fdb2/docs/en-US/vpc.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vpc.xml b/docs/en-US/vpc.xml
new file mode 100644
index 0000000..cd298a1
--- /dev/null
+++ b/docs/en-US/vpc.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="vpc">
+ <title>Virtual Private Cloud</title>
+ <para></para>
+ <para>To add a Virtual Private Cloud (VPC):</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>In the Select view, select VPC.</para></listitem>
+ <listitem><para>Click Add VPC. Provide the following information:</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Name</emphasis>: A short name for the VPC that you are creating.</para></listitem>
+ <listitem><para><emphasis role="bold">Description</emphasis>: A brief description of the VPC.</para></listitem>
+ <listitem><para><emphasis role="bold">Zone</emphasis>: Choose the zone where you want the VPC to be available.</para></listitem>
+ <listitem><para><emphasis role="bold">CIDR</emphasis>: To accept the traffic only from the IP addresses within a particular address block, enter a CIDR or a comma-separated list of CIDRs. The CIDR is the base IP address of the incoming traffic. For example, 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0.</para></listitem>
+ <listitem><para><emphasis role="bold">Network Domain</emphasis>: If you want to assign a special domain name to this network, specify the DNS suffix.</para></listitem>
+ </itemizedlist></listitem>
+
+ </orderedlist>
+
+</section>