You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ke...@apache.org on 2013/10/08 21:27:36 UTC
[32/70] [partial] Adding documents from 4.2
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/ip-vlan-tenant.xml
----------------------------------------------------------------------
diff --git a/en-US/ip-vlan-tenant.xml b/en-US/ip-vlan-tenant.xml
new file mode 100644
index 0000000..d58d49b
--- /dev/null
+++ b/en-US/ip-vlan-tenant.xml
@@ -0,0 +1,212 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="ip-vlan-tenant">
+ <title>Reserving Public IP Addresses and VLANs for Accounts</title>
+ <para>&PRODUCT; provides you the ability to reserve a set of public IP addresses and VLANs
+ exclusively for an account. During zone creation, you can continue defining a set of VLANs and
+ multiple public IP ranges. This feature extends the functionality to enable you to dedicate a
+ fixed set of VLANs and guest IP addresses for a tenant.</para>
+ <para>Note that if an account has consumed all the VLANs and IPs dedicated to it, the account can
+ acquire two more resources from the system. &PRODUCT; provides the root admin with two
+ configuration parameter to modify this default behavior—use.system.public.ips and
+ use.system.guest.vlans. These global parameters enable the root admin to disallow an account
+ from acquiring public IPs and guest VLANs from the system, if the account has dedicated
+ resources and these dedicated resources have all been consumed. Both these configurations are
+ configurable at the account level.</para>
+ <para>This feature provides you the following capabilities:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Reserve a VLAN range and public IP address range from an Advanced zone and assign it to
+ an account</para>
+ </listitem>
+ <listitem>
+ <para>Disassociate a VLAN and public IP address range from an account</para>
+ </listitem>
+ <listitem>
+ <para>View the number of public IP addresses allocated to an account</para>
+ </listitem>
+ <listitem>
+ <para>Check whether the required range is available and is conforms to account limits.</para>
+ <para>The maximum IPs per account limit cannot be superseded.</para>
+ </listitem>
+ </itemizedlist>
+ <section id="howto-dedicate-ip">
+ <title>Dedicating IP Address Ranges to an Account</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as administrator.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation bar, click Infrastructure.</para>
+ </listitem>
+ <listitem>
+ <para>In Zones, click View All.</para>
+ </listitem>
+ <listitem>
+ <para>Choose the zone you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Physical Network tab.</para>
+ </listitem>
+ <listitem>
+ <para>In the Public node of the diagram, click Configure.</para>
+ </listitem>
+ <listitem>
+ <para>Click the IP Ranges tab.</para>
+ <para>You can either assign an existing IP range to an account, or create a new IP range and
+ assign to an account.</para>
+ </listitem>
+ <listitem>
+ <para>To assign an existing IP range to an account, perform the following:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem>
+ <para>Locate the IP range you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add Account <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/addAccount-icon.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>addAccount-icon.png: button to assign an IP range to an account.</phrase>
+ </textobject>
+ </inlinemediaobject>button.</para>
+ <para>The Add Account dialog is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Specify the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Account</emphasis>: The account to which you want to
+ assign the IP address range.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Domain</emphasis>: The domain associated with the
+ account.</para>
+ </listitem>
+ </itemizedlist>
+ <para>To create a new IP range and assign an account, perform the following:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem>
+ <para>Specify the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Gateway</emphasis></para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Netmask</emphasis></para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">VLAN</emphasis></para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Start IP</emphasis></para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">End IP</emphasis></para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Account</emphasis>: Perform the following:</para>
+ <orderedlist numeration="lowerroman">
+ <listitem>
+ <para>Click Account.</para>
+ <para>The Add Account page is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Specify the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold"><emphasis role="bold"
+ >Account</emphasis></emphasis>: The account to which you want to
+ assign an IP address range.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold"><emphasis role="bold"
+ >Domain</emphasis></emphasis>: The domain associated with the
+ account.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click Add.</para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="howto-dedicate-vlan">
+ <title>Dedicating VLAN Ranges to an Account</title>
+ <orderedlist>
+ <listitem>
+ <para>After the &PRODUCT; Management Server is installed, log in to the &PRODUCT; UI as
+ administrator.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation bar, click Infrastructure.</para>
+ </listitem>
+ <listitem>
+ <para>In Zones, click View All.</para>
+ </listitem>
+ <listitem>
+ <para>Choose the zone you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Physical Network tab.</para>
+ </listitem>
+ <listitem>
+ <para>In the Guest node of the diagram, click Configure.</para>
+ </listitem>
+ <listitem>
+ <para>Select the Dedicated VLAN Ranges tab.</para>
+ </listitem>
+ <listitem>
+ <para>Click Dedicate VLAN Range.</para>
+ <para>The Dedicate VLAN Range dialog is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Specify the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold"><emphasis role="bold">VLAN Range</emphasis></emphasis>: The
+ VLAN range that you want to assign to an account.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold"><emphasis role="bold">Account</emphasis></emphasis>: The
+ account to which you want to assign the selected VLAN range.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold"><emphasis role="bold">Domain</emphasis></emphasis>: The
+ domain associated with the account.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/ipaddress-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/en-US/ipaddress-usage-record-format.xml b/en-US/ipaddress-usage-record-format.xml
new file mode 100644
index 0000000..1a0385b
--- /dev/null
+++ b/en-US/ipaddress-usage-record-format.xml
@@ -0,0 +1,42 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<section id="ipaddress-usage-record-format">
+ <title>IP Address Usage Record Format</title>
+ <para>For IP address 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</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 - IP address ID</para></listitem>
+ <listitem><para>startdate, enddate - The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
+ <listitem><para>issourcenat - Whether source NAT is enabled for the IP address</para></listitem>
+ <listitem><para>iselastic - True if the IP address is elastic.</para></listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/ipv6-support.xml
----------------------------------------------------------------------
diff --git a/en-US/ipv6-support.xml b/en-US/ipv6-support.xml
new file mode 100644
index 0000000..bc14c8e
--- /dev/null
+++ b/en-US/ipv6-support.xml
@@ -0,0 +1,191 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="ipv6-support">
+ <title>IPv6 Support in &PRODUCT;</title>
+ <para>&PRODUCT; supports Internet Protocol version 6 (IPv6), the recent version of the Internet
+ Protocol (IP) that defines routing the network traffic. IPv6 uses a 128-bit address that
+ exponentially expands the current address space that is available to the users. IPv6 addresses
+ consist of eight groups of four hexadecimal digits separated by colons, for example,
+ 5001:0dt8:83a3:1012:1000:8s2e:0870:7454. &PRODUCT; supports IPv6 for public IPs in shared
+ networks. With IPv6 support, VMs in shared networks can obtain both IPv4 and IPv6 addresses from
+ the DHCP server. You can deploy VMs either in a IPv6 or IPv4 network, or in a dual network
+ environment. If IPv6 network is used, the VM generates a link-local IPv6 address by itself, and
+ receives a stateful IPv6 address from the DHCPv6 server.</para>
+ <para>IPv6 is supported only on KVM and XenServer hypervisors. The IPv6 support is only an
+ experimental feature.</para>
+ <para>Here's the sequence of events when IPv6 is used: </para>
+ <orderedlist>
+ <listitem>
+ <para>The administrator creates an IPv6 shared network in an advanced zone.</para>
+ </listitem>
+ <listitem>
+ <para>The user deploys a VM in an IPv6 shared network.</para>
+ </listitem>
+ <listitem>
+ <para>The user VM generates an IPv6 link local address by itself, and gets an IPv6 global or
+ site local address through DHCPv6.</para>
+ <para>For information on API changes, see <xref linkend="changed-apicommands-4.1"/>.</para>
+ </listitem>
+ </orderedlist>
+ <section id="guidelines-ipv6">
+ <title>Prerequisites and Guidelines</title>
+ <para>Consider the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para>CIDR size must be 64 for IPv6 networks.</para>
+ </listitem>
+ <listitem>
+ <para>The DHCP client of the guest VMs should support generating DUID based on Link-layer
+ Address (DUID- LL). DUID-LL derives from the MAC address of guest VMs, and therefore the
+ user VM can be identified by using DUID. See <ulink
+ url="http://tools.ietf.org/html/rfc3315">Dynamic Host Configuration Protocol for IPv6
+ </ulink>for more information.</para>
+ </listitem>
+ <listitem>
+ <para>The gateway of the guest network generates Router Advisement and Response messages to
+ Router Solicitation. The M (Managed Address Configuration) flag of Router Advisement
+ should enable stateful IP address configuration. Set the M flag to where the end nodes
+ receive their IPv6 addresses from the DHCPv6 server as opposed to the router or
+ switch.</para>
+ <note>
+ <para>The M flag is the 1-bit Managed Address Configuration flag for Router Advisement.
+ When set, Dynamic Host Configuration Protocol (DHCPv6) is available for address
+ configuration in addition to any IPs set by using stateless address
+ auto-configuration.</para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>Use the System VM template exclusively designed to support IPv6. Download the System
+ VM template from <ulink url="http://cloudstack.apt-get.eu/systemvm/"
+ >http://cloudstack.apt-get.eu/systemvm/</ulink>.</para>
+ </listitem>
+ <listitem>
+ <para>The concept of Default Network applies to IPv6 networks. However, unlike IPv4
+ &PRODUCT; does not control the routing information of IPv6 in shared network; the choice
+ of Default Network will not affect the routing in the user VM.</para>
+ </listitem>
+ <listitem>
+ <para>In a multiple shared network, the default route is set by the rack router, rather than
+ the DHCP server, which is out of &PRODUCT; control. Therefore, in order for the user VM to
+ get only the default route from the default NIC, modify the configuration of the user VM,
+ and set non-default NIC's <code>accept_ra</code> to 0 explicitly. The
+ <code>accept_ra</code> parameter accepts Router Advertisements and auto-configure
+ <code>/proc/sys/net/ipv6/conf/interface</code> with received data.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="limitsipv6">
+ <title>Limitations of IPv6 in &PRODUCT; </title>
+ <para>The following are not yet supported:</para>
+ <orderedlist>
+ <listitem>
+ <para>Security groups</para>
+ </listitem>
+ <listitem>
+ <para>Userdata and metadata</para>
+ </listitem>
+ <listitem>
+ <para>Passwords</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="network-conf-dhcpv6">
+ <title>Guest VM Configuration for DHCPv6</title>
+ <para>For the guest VMs to get IPv6 address, run dhclient command manually on each of the VMs.
+ Use DUID-LL to set up dhclient. </para>
+ <note><para>The IPv6 address is lost when a VM is stopped and started. Therefore, use the same procedure
+ to get an IPv6 address when a VM is stopped and started.</para></note>
+ <orderedlist>
+ <listitem>
+ <para>Set up dhclient by using DUID-LL.</para>
+ <para>Perform the following for DHCP Client 4.2 and above:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem>
+ <para>Run the following command on the selected VM to get the dhcpv6 offer from
+ VR:</para>
+ <programlisting>dhclient -6 -D LL <dev></programlisting>
+ </listitem>
+ </orderedlist>
+ <para>Perform the following for DHCP Client 4.1:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem>
+ <para>Open the following to the dhclient configuration file:</para>
+ <programlisting>vi /etc/dhcp/dhclient.conf</programlisting>
+ </listitem>
+ <listitem>
+ <para>Add the following to the dhclient configuration file:</para>
+ <programlisting>send dhcp6.client-id = concat(00:03:00, hardware);</programlisting>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem>
+ <para>Get IPv6 address from DHCP server as part of the system or network restart.</para>
+ <para>Based on the operating systems, perform the following:</para>
+ <para>On CentOS 6.2:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem>
+ <para>Open the Ethernet interface configuration file:</para>
+ <programlisting>vi /etc/sysconfig/network-scripts/ifcfg-eth0</programlisting>
+ <para>The <code>ifcfg-eth0</code> file controls the first NIC in a system.</para>
+ </listitem>
+ <listitem>
+ <para>Make the necessary configuration changes, as given below:</para>
+ <programlisting>DEVICE=eth0
+HWADDR=06:A0:F0:00:00:38
+NM_CONTROLLED=no
+ONBOOT=yes
+BOOTPROTO=dhcp6
+TYPE=Ethernet
+USERCTL=no
+PEERDNS=yes
+IPV6INIT=yes
+DHCPV6C=yes</programlisting>
+ </listitem>
+ <listitem>
+ <para>Open the following:</para>
+ <programlisting>vi /etc/sysconfig/network</programlisting>
+ </listitem>
+ <listitem>
+ <para>Make the necessary configuration changes, as given below:</para>
+ <programlisting>NETWORKING=yes
+HOSTNAME=centos62mgmt.lab.vmops.com
+NETWORKING_IPV6=yes
+IPV6_AUTOCONF=no</programlisting>
+ </listitem>
+ </orderedlist>
+ <para>On Ubuntu 12.10</para>
+ <orderedlist numeration="loweralpha">
+ <listitem>
+ <para>Open the following:</para>
+ <programlisting>etc/network/interfaces:</programlisting>
+ </listitem>
+ <listitem>
+ <para>Make the necessary configuration changes, as given below:</para>
+ <programlisting>iface eth0 inet6 dhcp
+autoconf 0
+accept_ra 1</programlisting>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ </orderedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/isolated-networks.xml
----------------------------------------------------------------------
diff --git a/en-US/isolated-networks.xml b/en-US/isolated-networks.xml
new file mode 100644
index 0000000..c856044
--- /dev/null
+++ b/en-US/isolated-networks.xml
@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="isolated-networks">
+ <title>Isolated Networks</title>
+ <para>An isolated network can be accessed only by virtual machines of a single account. Isolated
+ networks have the following properties.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Resources such as VLAN are allocated and garbage collected dynamically</para>
+ </listitem>
+ <listitem>
+ <para>There is one network offering for the entire network</para>
+ </listitem>
+ <listitem>
+ <para>The network offering can be upgraded or downgraded but it is for the entire
+ network</para>
+ </listitem>
+ </itemizedlist>
+ <para>For more information, see <xref linkend="configure-guest-traffic-in-advanced-zone"/>.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/job-status.xml
----------------------------------------------------------------------
diff --git a/en-US/job-status.xml b/en-US/job-status.xml
new file mode 100644
index 0000000..da0f76c
--- /dev/null
+++ b/en-US/job-status.xml
@@ -0,0 +1,34 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<section id="job-status">
+ <title>Job Status</title>
+ <para>The key to using an asynchronous command is the job ID that is returned immediately once the command has been executed. With the job ID, you can periodically check the job status by making calls to queryAsyncJobResult command. The command will return three possible job status integer values:</para>
+ <itemizedlist>
+ <listitem><para>0 - Job is still in progress. Continue to periodically poll for any status changes.</para></listitem>
+ <listitem><para>1 - Job has successfully completed. The job will return any successful response values associated with command that was originally executed.</para></listitem>
+ <listitem><para>2 - Job has failed to complete. Please check the "jobresultcode" tag for failure reason code and "jobresult" for the failure reason.</para></listitem>
+ </itemizedlist>
+</section>
+
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/kvm-topology-req.xml
----------------------------------------------------------------------
diff --git a/en-US/kvm-topology-req.xml b/en-US/kvm-topology-req.xml
new file mode 100644
index 0000000..0dff491
--- /dev/null
+++ b/en-US/kvm-topology-req.xml
@@ -0,0 +1,24 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="kvm-topology-req">
+ <title>KVM Topology Requirements</title>
+ <para>The Management Servers communicate with KVM hosts on port 22 (ssh).</para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/large_scale_redundant_setup.xml
----------------------------------------------------------------------
diff --git a/en-US/large_scale_redundant_setup.xml b/en-US/large_scale_redundant_setup.xml
new file mode 100644
index 0000000..427a42d
--- /dev/null
+++ b/en-US/large_scale_redundant_setup.xml
@@ -0,0 +1,42 @@
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<section id="large_scale_redundant_setup">
+ <title>Large-Scale Redundant Setup</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/large-scale-redundant-setup.png" />
+ </imageobject>
+ <textobject><phrase>Large-Scale Redundant Setup</phrase></textobject>
+ </mediaobject>
+ <para>This diagram illustrates the network architecture of a large-scale &PRODUCT; deployment.</para>
+ <itemizedlist>
+ <listitem><para>A layer-3 switching layer is at the core of the data center. A router redundancy protocol like VRRP should be deployed. Typically high-end core switches also include firewall modules. Separate firewall appliances may also be used if the layer-3 switch does not have integrated firewall capabilities. The firewalls are configured in NAT mode. The firewalls provide the following functions:</para>
+ <itemizedlist>
+ <listitem><para>Forwards HTTP requests and API calls from the Internet to the Management Server. The Management Server resides on the management network.</para></listitem>
+ <listitem><para>When the cloud spans multiple zones, the firewalls should enable site-to-site VPN such that servers in different zones can directly reach each other.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>A layer-2 access switch layer is established for each pod. Multiple switches can be stacked to increase port count. In either case, redundant pairs of layer-2 switches should be deployed.</para></listitem>
+ <listitem><para>The Management Server cluster (including front-end load balancers, Management Server nodes, and the MySQL database) is connected to the management network through a pair of load balancers.</para></listitem>
+ <listitem><para>Secondary storage servers are connected to the management network.</para></listitem>
+ <listitem><para>Each pod contains storage and computing servers. Each storage and computing server should have redundant NICs connected to separate layer-2 access switches.</para></listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/layer2-switch.xml
----------------------------------------------------------------------
diff --git a/en-US/layer2-switch.xml b/en-US/layer2-switch.xml
new file mode 100644
index 0000000..acef5a7
--- /dev/null
+++ b/en-US/layer2-switch.xml
@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="layer2-switch">
+ <title>Layer-2 Switch</title>
+ <para>The layer-2 switch is the access switching layer inside the pod.</para>
+ <itemizedlist>
+ <listitem>
+ <para>It should trunk all VLANs into every computing host.</para>
+ </listitem>
+ <listitem>
+ <para>It should switch traffic for the management network containing computing and storage
+ hosts. The layer-3 switch will serve as the gateway for the management network.</para>
+ </listitem>
+ </itemizedlist>
+ <formalpara>
+ <title>Example Configurations</title>
+ <para>This section contains example configurations for specific switch models for pod-level
+ layer-2 switching. It assumes VLAN management protocols such as VTP or GVRP have been
+ disabled. The scripts must be changed appropriately if you choose to use VTP or GVRP.</para>
+ </formalpara>
+ <xi:include href="dell62xx-layer2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="cisco3750-layer2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/lb-policy-pfwd-rule-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/en-US/lb-policy-pfwd-rule-usage-record-format.xml b/en-US/lb-policy-pfwd-rule-usage-record-format.xml
new file mode 100644
index 0000000..e27a49d
--- /dev/null
+++ b/en-US/lb-policy-pfwd-rule-usage-record-format.xml
@@ -0,0 +1,40 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<section id="loadbalancer-policy-port-forwarding-rule-usage-record-format">
+ <title>Load Balancer Policy or Port Forwarding Rule Usage Record Format</title>
+ <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 - ID of the load balancer policy or port forwarding rule</para></listitem>
+ <listitem><para>usagetype - A number representing the usage type (see Usage Types)</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/cloudstack-docs/blob/b23872a5/en-US/libcloud-examples.xml
----------------------------------------------------------------------
diff --git a/en-US/libcloud-examples.xml b/en-US/libcloud-examples.xml
new file mode 100644
index 0000000..d2db526
--- /dev/null
+++ b/en-US/libcloud-examples.xml
@@ -0,0 +1,75 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<section id="libcloud-examples">
+ <title>Apache Libcloud</title>
+ <para>There are many tools available to interface with the &PRODUCT; API. Apache Libcloud is one of those. In this section
+ we provide a basic example of how to use Libcloud with &PRODUCT;. It assumes that you have access to a &PRODUCT; endpoint and that you have the API access key and secret key of a user.</para>
+ <para>To install Libcloud refer to the libcloud website. If you are familiar with Pypi simply do:</para>
+ <programlisting>pip install apache-libcloud</programlisting>
+ <para>You should see the following output:</para>
+ <programlisting>
+pip install apache-libcloud
+Downloading/unpacking apache-libcloud
+ Downloading apache-libcloud-0.12.4.tar.bz2 (376kB): 376kB downloaded
+ Running setup.py egg_info for package apache-libcloud
+
+Installing collected packages: apache-libcloud
+ Running setup.py install for apache-libcloud
+
+Successfully installed apache-libcloud
+Cleaning up...
+ </programlisting>
+
+ <para>You can then open a Python interactive shell, create an instance of a &PRODUCT; driver and call the available methods via the libcloud API.</para>
+
+ <programlisting>
+ <![CDATA[
+>>> from libcloud.compute.types import Provider
+>>> from libcloud.compute.providers import get_driver
+>>> Driver = get_driver(Provider.CLOUDSTACK)
+>>> apikey='plgWJfZK4gyS3mOMTVmjUVg-X-jlWlnfaUJ9GAbBbf9EdM-kAYMmAiLqzzq1ElZLYq_u38zCm0bewzGUdP66mg'
+>>> secretkey='VDaACYb0LV9eNjTetIOElcVQkvJck_J_QljX_FcHRj87ZKiy0z0ty0ZsYBkoXkY9b7eq1EhwJaw7FF3akA3KBQ'
+>>> host='http://localhost:8080'
+>>> path='/client/api'
+>>> conn=Driver(apikey,secretkey,secure='False',host='localhost:8080',path=path)
+>>> conn=Driver(key=apikey,secret=secretkey,secure=False,host='localhost',port='8080',path=path)
+>>> conn.list_images()
+[<NodeImage: id=13ccff62-132b-4caf-b456-e8ef20cbff0e, name=tiny Linux, driver=CloudStack ...>]
+>>> conn.list_sizes()
+[<NodeSize: id=ef2537ad-c70f-11e1-821b-0800277e749c, name=tinyOffering, ram=100 disk=0 bandwidth=0 price=0 driver=CloudStack ...>, <NodeSize: id=c66c2557-12a7-4b32-94f4-48837da3fa84, name=Small Instance, ram=512 disk=0 bandwidth=0 price=0 driver=CloudStack ...>, <NodeSize: id=3d8b82e5-d8e7-48d5-a554-cf853111bc50, name=Medium Instance, ram=1024 disk=0 bandwidth=0 price=0 driver=CloudStack ...>]
+>>> images=conn.list_images()
+>>> offerings=conn.list_sizes()
+>>> node=conn.create_node(name='toto',image=images[0],size=offerings[0])
+>>> help(node)
+>>> node.get_uuid()
+'b1aa381ba1de7f2d5048e248848993d5a900984f'
+>>> node.name
+u'toto'
+]]>
+ </programlisting>
+
+ <para>One of the interesting use cases of Libcloud is that you can use multiple Cloud Providers, such as AWS, Rackspace, OpenNebula, vCloud and so on. You can then create Driver instances to each of these clouds and create your own multi cloud application.</para>
+
+ </section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/limit-accounts-domains.xml
----------------------------------------------------------------------
diff --git a/en-US/limit-accounts-domains.xml b/en-US/limit-accounts-domains.xml
new file mode 100644
index 0000000..78a642b
--- /dev/null
+++ b/en-US/limit-accounts-domains.xml
@@ -0,0 +1,371 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="limit-accounts-domains">
+ <title>Limiting Resource Usage</title>
+ <para>&PRODUCT; allows you to control resource usage based on the types of resources, such as CPU,
+ RAM, Primary storage, and Secondary storage. A new set of resource types has been added to the
+ existing pool of resources to support the new customization model—need-basis usage, such
+ as large VM or small VM. The new resource types are now broadly classified as CPU, RAM, Primary
+ storage, and Secondary storage. The root administrator is able to impose resource usage limit by
+ the following resource types for Domain, Project, and Accounts. </para>
+ <itemizedlist>
+ <listitem>
+ <para>CPUs</para>
+ </listitem>
+ <listitem>
+ <para>Memory (RAM)</para>
+ </listitem>
+ <listitem>
+ <para>Primary Storage (Volumes)</para>
+ </listitem>
+ <listitem>
+ <para>Secondary Storage (Snapshots, Templates, ISOs)</para>
+ </listitem>
+ </itemizedlist>
+ <para>To control the behaviour of this feature, the following configuration parameters have been
+ added:</para>
+ <informaltable>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry><para>Parameter Name</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>max.account.cpus</para></entry>
+ <entry><para>Maximum number of CPU cores that can be used for an account. </para>
+ <para>Default is 40.</para></entry>
+ </row>
+ <row>
+ <entry><para>max.account.ram (MB)</para></entry>
+ <entry><para>Maximum RAM that can be used for an account. </para>
+ <para>Default is 40960.</para></entry>
+ </row>
+ <row>
+ <entry><para>max.account.primary.storage (GB)</para></entry>
+ <entry><para>Maximum primary storage space that can be used for an account. </para>
+ <para>Default is 200.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>max.account.secondary.storage (GB)</para></entry>
+ <entry><para>Maximum secondary storage space that can be used for an account. </para>
+ <para>Default is 400.</para></entry>
+ </row>
+ <row>
+ <entry><para>max.project.cpus</para></entry>
+ <entry>
+ <para>Maximum number of CPU cores that can be used for an account. </para>
+ <para>Default is 40.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>max.project.ram (MB)</para></entry>
+ <entry>
+ <para>Maximum RAM that can be used for an account. </para>
+ <para>Default is 40960.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>max.project.primary.storage (GB)</para></entry>
+ <entry>
+ <para>Maximum primary storage space that can be used for an account. </para>
+ <para>Default is 200.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>max.project.secondary.storage (GB)</para></entry>
+ <entry>
+ <para>Maximum secondary storage space that can be used for an account. </para>
+ <para>Default is 400.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <section id="user-permission-rn">
+ <title>User Permission</title>
+ <para>The root administrator, domain administrators and users are able to list resources. Ensure
+ that proper logs are maintained in the <filename>vmops.log</filename> and
+ <filename>api.log</filename> files.</para>
+ <itemizedlist>
+ <listitem>
+ <para>The root admin will have the privilege to list and update resource limits.</para>
+ </listitem>
+ <listitem>
+ <para>The domain administrators are allowed to list and change these resource limits only
+ for the sub-domains and accounts under their own domain or the sub-domains. </para>
+ </listitem>
+ <listitem>
+ <para>The end users will the privilege to list resource limits. Use the listResourceLimits
+ API.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="consideration-rn">
+ <title>Limit Usage Considerations</title>
+ <itemizedlist>
+ <listitem>
+ <para>Primary or Secondary storage space refers to the stated size of the volume and not the
+ physical size— the actual consumed size on disk in case of thin provisioning.</para>
+ </listitem>
+ <listitem>
+ <para>If the admin reduces the resource limit for an account and set it to less than the
+ resources that are currently being consumed, the existing VMs/templates/volumes are not
+ destroyed. Limits are imposed only if the user under that account tries to execute a new
+ operation using any of these resources. For example, the existing behavior in the case of
+ a VM are: </para>
+ <itemizedlist>
+ <listitem>
+ <para>migrateVirtualMachine: The users under that account will be able to migrate the
+ running VM into any other host without facing any limit issue.</para>
+ </listitem>
+ <listitem>
+ <para>recoverVirtualMachine: Destroyed VMs cannot be recovered.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>For any resource type, if a domain has limit X, sub-domains or accounts under that
+ domain can have there own limits. However, the sum of resource allocated to a sub-domain
+ or accounts under the domain at any point of time should not exceed the value X.</para>
+ <para>For example, if a domain has the CPU limit of 40 and the sub-domain D1 and account A1
+ can have limits of 30 each, but at any point of time the resource allocated to D1 and A1
+ should not exceed the limit of 40.</para>
+ </listitem>
+ <listitem>
+ <para>If any operation needs to pass through two of more resource limit check, then the
+ lower of 2 limits will be enforced, For example: if an account has the VM limit of 10 and
+ CPU limit of 20, and a user under that account requests 5 VMs of 4 CPUs each. The user
+ can deploy 5 more VMs because VM limit is 10. However, the user cannot deploy any more
+ instances because the CPU limit has been exhausted.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="per-domain-limits">
+ <title>Limiting Resource Usage in a Domain</title>
+ <para>&PRODUCT; allows the configuration of limits on a domain basis. With a domain limit in
+ place, all users still have their account limits. They are additionally limited, as a group,
+ to not exceed the resource limits set on their domain. Domain limits aggregate the usage of
+ all accounts in the domain as well as all the accounts in all the sub-domains of that domain.
+ Limits set at the root domain level apply to the sum of resource usage by the accounts in all
+ the domains and sub-domains below that root domain.</para>
+ <para>To set a domain limit:</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation tree, click Domains.</para>
+ </listitem>
+ <listitem>
+ <para>Select the domain you want to modify. The current domain limits are displayed. </para>
+ <para>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>
+ <listitem>
+ <para>Edit the following as per your requirement:</para>
+ <informaltable>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry><para>Parameter Name</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>Instance Limits</para></entry>
+ <entry><para>The number of instances that can be used in a domain.</para></entry>
+ </row>
+ <row>
+ <entry><para>Public IP Limits</para></entry>
+ <entry>
+ <para>The number of public IP addresses that can be used in a
+ domain.</para></entry>
+ </row>
+ <row>
+ <entry><para>Volume Limits</para></entry>
+ <entry><para>The number of disk volumes that can be created in a domain. </para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>Snapshot Limits</para></entry>
+ <entry>The number of snapshots that can be created in a domain.</entry>
+ </row>
+ <row>
+ <entry><para>Template Limits</para></entry>
+ <entry><para>The number of templates that can be registered in a
+ domain.</para></entry>
+ </row>
+ <row>
+ <entry><para>VPC limits</para></entry>
+ <entry><para>The number of VPCs that can be created in a domain.</para></entry>
+ </row>
+ <row>
+ <entry><para>CPU limits</para></entry>
+ <entry>
+ <para>The number of CPU cores that can be used for a domain.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>Memory limits (MB)</para></entry>
+ <entry>
+ <para>The number of RAM that can be used for a domain.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>Primary Storage limits (GB)</para></entry>
+ <entry>
+ <para>The primary storage space that can be used for a domain.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>Secondary Storage limits (GB)</para></entry>
+ <entry>
+ <para>The secondary storage space that can be used for a domain.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ <listitem>
+ <para>Click Apply.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <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 by using Global
+ configuration parameters, and they affect all accounts within a cloud. The relevant parameters
+ are those beginning with max.account, for example: max.account.snapshots.</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 &PRODUCT; 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. </para>
+ <para>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>
+ <listitem>
+ <para>Edit the following as per your requirement:</para>
+ <informaltable>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry><para>Parameter Name</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>Instance Limits</para></entry>
+ <entry><para>The number of instances that can be used in an account.</para>
+ <para>The default is 20.</para></entry>
+ </row>
+ <row>
+ <entry><para>Public IP Limits</para></entry>
+ <entry>
+ <para>The number of public IP addresses that can be used in an account.</para>
+ <para>The default is 20.</para></entry>
+ </row>
+ <row>
+ <entry><para>Volume Limits</para></entry>
+ <entry><para>The number of disk volumes that can be created in an account.</para>
+ <para>The default is 20.</para></entry>
+ </row>
+ <row>
+ <entry><para>Snapshot Limits</para></entry>
+ <entry><para>The number of snapshots that can be created in an account.</para>
+ <para>The default is 20.</para></entry>
+ </row>
+ <row>
+ <entry><para>Template Limits</para></entry>
+ <entry><para>The number of templates that can be registered in an account.</para>
+ <para>The default is 20.</para></entry>
+ </row>
+ <row>
+ <entry><para>VPC limits</para></entry>
+ <entry><para>The number of VPCs that can be created in an account.</para>
+ <para>The default is 20.</para></entry>
+ </row>
+ <row>
+ <entry><para>CPU limits</para></entry>
+ <entry>
+ <para>The number of CPU cores that can be used for an account.</para>
+ <para>The default is 40.</para></entry>
+ </row>
+ <row>
+ <entry><para>Memory limits (MB)</para></entry>
+ <entry>
+ <para>The number of RAM that can be used for an account.</para>
+ <para>The default is 40960.</para></entry>
+ </row>
+ <row>
+ <entry><para>Primary Storage limits (GB)</para></entry>
+ <entry>
+ <para>The primary storage space that can be used for an account.</para>
+ <para>The default is 200.</para></entry>
+ </row>
+ <row>
+ <entry><para>Secondary Storage limits (GB)</para></entry>
+ <entry>
+ <para>The secondary storage space that can be used for an account.</para>
+ <para>The default is 400.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ <listitem>
+ <para>Click Apply.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/linux-installation.xml
----------------------------------------------------------------------
diff --git a/en-US/linux-installation.xml b/en-US/linux-installation.xml
new file mode 100644
index 0000000..14a2f51
--- /dev/null
+++ b/en-US/linux-installation.xml
@@ -0,0 +1,70 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="linux-installation">
+ <title>Linux OS Installation</title>
+ <para>Use the following steps to begin the Linux OS installation:</para>
+ <orderedlist>
+ <listitem>
+ <para>Download the script file cloud-set-guest-password:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Linux: <ulink
+ url="http://download.cloud.com/templates/4.2/bindir/cloud-set-guest-password.in"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Windows: <ulink
+ url="http://sourceforge.net/projects/cloudstack/files/Password%20Management%20Scripts/CloudInstanceManager.msi/download"
+ />
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Copy this file to /etc/init.d.</para>
+ <para>On some Linux distributions, copy the file to
+ <filename>/etc/rc.d/init.d</filename>.</para>
+ </listitem>
+ <listitem>
+ <para>Run the following command to make the script executable:</para>
+ <programlisting>chmod +x /etc/init.d/cloud-set-guest-password</programlisting>
+ </listitem>
+ <listitem>
+ <para>Depending on the Linux distribution, continue with the appropriate step.</para>
+ <para>On Fedora, CentOS/RHEL, and Debian, run:</para>
+ <programlisting>chkconfig --add cloud-set-guest-password</programlisting>
+ <para condition="community">On Ubuntu with VMware tools, link the script file to the
+ <filename>/etc/network/if-up</filename> and <filename>/etc/network/if-down</filename>
+ folders, and run the script:</para>
+ <programlisting condition="community">#ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-up/cloud-set-guest-password
+#ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-down/cloud-set-guest-password</programlisting>
+ <para condition="community">If you are using Ubuntu 11.04, start by creating a directory
+ called /var/lib/dhcp3 on your Ubuntu machine (works around a known issue with this version
+ of Ubuntu). On all Ubuntu versions: Run “sudo update-rc.d cloud-set-guest-password defaults
+ 98”. To test, run "mkpasswd" and check that it is generating a new password. If the
+ “mkpasswd” command does not exist, run "sudo apt-get install whois" (or sudo apt-get install
+ mkpasswd, depending on your Ubuntu version) and repeat.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/load-balancer-rules.xml
----------------------------------------------------------------------
diff --git a/en-US/load-balancer-rules.xml b/en-US/load-balancer-rules.xml
new file mode 100644
index 0000000..884647c
--- /dev/null
+++ b/en-US/load-balancer-rules.xml
@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="load-balancer-rules">
+ <title>Load Balancer Rules</title>
+ <para>A &PRODUCT; user or administrator may create load balancing rules that balance traffic
+ received at a public IP to one or more VMs. A user creates a rule, specifies an algorithm, and
+ assigns the rule to a set of VMs.</para>
+ <note>
+ <para>If you create load balancing rules while using a network service offering that includes an
+ external load balancer device such as NetScaler, and later change the network service offering
+ to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual
+ router for each of your existing load balancing rules so that they continue to
+ function.</para>
+ </note>
+ <para/>
+ <xi:include href="add-load-balancer-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="sticky-session-policies-for-lb-rules.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="health-checks-for-lb-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/log-in-root-admin.xml
----------------------------------------------------------------------
diff --git a/en-US/log-in-root-admin.xml b/en-US/log-in-root-admin.xml
new file mode 100644
index 0000000..0243bd6
--- /dev/null
+++ b/en-US/log-in-root-admin.xml
@@ -0,0 +1,46 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="log-in-root-admin">
+ <title>Logging In as the Root Administrator</title>
+ <para>After the Management Server software is installed and running, you can run the &PRODUCT; user interface. This UI is there to help you provision, view, and manage your cloud infrastructure.</para>
+ <orderedlist>
+ <listitem><para>Open your favorite Web browser and go to this URL. Substitute the IP address of your own Management Server:</para>
+ <programlisting>http://<management-server-ip-address>:8080/client</programlisting>
+ <para>After logging into a fresh Management Server installation, a guided tour splash screen appears. On later visits, you’ll be taken directly into the Dashboard.</para>
+ </listitem>
+ <listitem><para>If you see the first-time splash screen, choose one of the following.</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Continue with basic setup.</emphasis> Choose this if you're just trying &PRODUCT;, and you want a guided walkthrough of the simplest possible configuration so that you can get started right away. We'll help you set up a cloud with the following features: a single machine that runs &PRODUCT; software and uses NFS to provide storage; a single machine running VMs under the XenServer or KVM hypervisor; and a shared public network.</para>
+ <para>The prompts in this guided tour should give you all the information you need, but if you want just a bit more detail, you can follow along in the Trial Installation Guide.</para>
+ </listitem>
+ <listitem><para><emphasis role="bold">I have used &PRODUCT; before.</emphasis> Choose this if you have already gone through a design phase and planned a more sophisticated deployment, or you are ready to start scaling up a trial cloud that you set up earlier with the basic setup screens. In the Administrator UI, you can start using the more powerful features of &PRODUCT;, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere.</para>
+ <para>The root administrator Dashboard appears.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>You should set a new root administrator password. If you chose basic setup, you’ll be prompted to create a new password right away. If you chose experienced user, use the steps in <xref linkend="changing-root-password" />.</para></listitem>
+ </orderedlist>
+ <warning><para>You are logging in as the root administrator. This account manages the &PRODUCT; deployment, including physical infrastructure. The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person. Please change the default password to a new, unique password.</para></warning>
+ <para></para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/log-in.xml
----------------------------------------------------------------------
diff --git a/en-US/log-in.xml b/en-US/log-in.xml
new file mode 100644
index 0000000..84328ce
--- /dev/null
+++ b/en-US/log-in.xml
@@ -0,0 +1,48 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="log-in">
+ <title>Log In to the UI</title>
+ <para>&PRODUCT; provides a web-based UI that can be used by both administrators and end users. The appropriate version of the UI is displayed depending on the credentials used to log in. The UI is available in popular browsers including IE7, IE8, IE9, Firefox 3.5+, Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own management server IP address)</para>
+ <programlisting>http://<management-server-ip-address>:8080/client</programlisting>
+ <para>On a fresh Management Server installation, a guided tour splash screen appears. On later visits, you’ll see a login screen where you specify the following to proceed to your Dashboard:</para>
+ <formalpara>
+ <title>Username</title>
+ <para>The user ID of your account. The default username is admin.</para>
+ </formalpara>
+ <formalpara>
+ <title>Password</title>
+ <para>The password associated with the user ID. The password for the default username is password.</para>
+ </formalpara>
+ <formalpara>
+ <title>Domain</title>
+ <para>If you are a root user, leave this field blank.</para>
+ </formalpara>
+ <para>If you are a user in the sub-domains, enter the full path to the domain, excluding the root domain.</para>
+ <para>For example, suppose multiple levels are created under the root domain, such as Comp1/hr. The users in the Comp1 domain should enter Comp1 in the Domain field, whereas the users in the Comp1/sales domain should enter Comp1/sales.</para>
+ <para>For more guidance about the choices that appear when you log in to this UI, see Logging In as the Root Administrator.</para>
+ <xi:include href="end-user-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="root-admin-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="log-in-root-admin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="changing-root-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/long-running-job-events.xml
----------------------------------------------------------------------
diff --git a/en-US/long-running-job-events.xml b/en-US/long-running-job-events.xml
new file mode 100644
index 0000000..cae2b74
--- /dev/null
+++ b/en-US/long-running-job-events.xml
@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<section id="long-running-job-events">
+ <title>Long Running Job Events</title>
+ <para>The events log records three types of standard events.</para>
+ <itemizedlist>
+ <listitem><para>INFO. This event is generated when an operation has been successfully performed.</para></listitem>
+ <listitem><para>WARN. This event is generated in the following circumstances.</para>
+ <itemizedlist>
+ <listitem><para>When a network is disconnected while monitoring a template download.</para></listitem>
+ <listitem><para>When a template download is abandoned.</para></listitem>
+ <listitem><para>When an issue on the storage server causes the volumes to fail over to the mirror storage server.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>ERROR. This event is generated when an operation has not been successfully performed</para></listitem>
+ </itemizedlist>
+
+ </section>
+
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/lxc-install.xml
----------------------------------------------------------------------
diff --git a/en-US/lxc-install.xml b/en-US/lxc-install.xml
new file mode 100644
index 0000000..40f6a0a
--- /dev/null
+++ b/en-US/lxc-install.xml
@@ -0,0 +1,110 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ <!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+ %BOOK_ENTITIES;
+ ]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ -->
+
+<section id="lxc-install">
+ <title>LXC Installation and Configuration</title>
+ <section id="lxc-requirements">
+ <title>System Requirements for LXC Hosts</title>
+ <para>LXC requires the Linux kernel cgroups functionality which is available starting 2.6.24. Although you are not required to run these distributions, the following are recommended:</para>
+ <itemizedlist>
+ <listitem><para>CentOS / RHEL: 6.3</para></listitem>
+ <listitem><para>Ubuntu: 12.04(.1)</para></listitem>
+ </itemizedlist>
+ <para>The main requirement for LXC hypervisors is the libvirt and Qemu version. No matter what
+ Linux distribution you are using, make sure the following requirements are met:</para>
+ <itemizedlist>
+ <listitem><para>libvirt: 1.0.0 or higher</para></listitem>
+ <listitem><para>Qemu/KVM: 1.0 or higher</para></listitem>
+ </itemizedlist>
+ <para>The default bridge in &PRODUCT; is the Linux native bridge implementation (bridge module). &PRODUCT; includes an option to work with OpenVswitch, the requirements are listed below</para>
+ <itemizedlist>
+ <listitem><para>libvirt: 1.0.0 or higher</para></listitem>
+ <listitem><para>openvswitch: 1.7.1 or higher</para></listitem>
+ </itemizedlist>
+ <para>In addition, the following hardware requirements apply:</para>
+ <itemizedlist>
+ <listitem><para>Within a single cluster, the hosts must be of the same distribution version.</para></listitem>
+ <listitem><para>All hosts within a cluster must be homogenous. The CPUs must be of the same type, count, and feature flags.</para></listitem>
+ <listitem><para>Must support HVM (Intel-VT or AMD-V enabled)</para></listitem>
+ <listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem>
+ <listitem><para>4 GB of memory</para></listitem>
+ <listitem><para>At least 1 NIC</para></listitem>
+ <listitem><para>When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running</para></listitem>
+ </itemizedlist>
+ </section>
+ <section id="lxc-install-overview">
+ <title>LXC Installation Overview</title>
+ <para>LXC does not have any native system VMs, instead KVM will be used to run system VMs. This means that your host will need to support both LXC and KVM, thus most of the installation and configuration will be identical to the KVM installation. The material in this section doesn't duplicate KVM installation docs. It provides the &PRODUCT;-specific steps that are needed to prepare a KVM host to work with &PRODUCT;.</para>
+ <warning><para>Before continuing, make sure that you have applied the latest updates to your host.</para></warning>
+ <warning><para>It is NOT recommended to run services on this host not controlled by &PRODUCT;.</para></warning>
+ <para>The procedure for installing an LXC Host is:</para>
+ <orderedlist>
+ <listitem><para>Prepare the Operating System</para></listitem>
+ <listitem><para>Install and configure libvirt</para></listitem>
+ <listitem><para>Configure Security Policies (AppArmor and SELinux)</para></listitem>
+ <listitem><para>Install and configure the Agent</para></listitem>
+ </orderedlist>
+ </section>
+ <section id="lxc-install-prepare-os">
+ <xi:include href="hypervisor-host-install-prepare-os.xml#xpointer(/section/*)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
+ <section id="lxc-install-agent">
+ <title>Install and configure the Agent</title>
+ <para>To manage LXC instances on the host &PRODUCT; uses a Agent. This Agent communicates with the Management server and controls all the instances on the host.</para>
+ <para>First we start by installing the agent:</para>
+ <para>In RHEL or CentOS:</para>
+ <programlisting language="Bash"><command>$ yum install cloudstack-agent</command></programlisting>
+ <para>In Ubuntu:</para>
+ <programlisting language="Bash"><command>$ apt-get install cloudstack-agent</command></programlisting>
+ <para>Next step is to update the Agent configuration setttings. The settings are in <filename>/etc/cloudstack/agent/agent.properties</filename></para>
+ <orderedlist>
+ <listitem>
+ <para>Set the Agent to run in LXC mode:</para>
+ <programlisting>hypervisor.type=lxc</programlisting>
+ </listitem>
+ <listitem>
+ <para>Optional: If you would like to use direct networking (instead of the default bridge networking), configure these lines:</para>
+ <programlisting>libvirt.vif.driver=com.cloud.hypervisor.kvm.resource.DirectVifDriver</programlisting>
+ <programlisting>network.direct.source.mode=private</programlisting>
+ <programlisting>network.direct.device=eth0</programlisting>
+ </listitem>
+ </orderedlist>
+ <para>The host is now ready to be added to a cluster. This is covered in a later section, see <xref linkend="host-add" />. It is recommended that you continue to read the documentation before adding the host!</para>
+ </section>
+ <section id="lxc-install-libvirt">
+ <xi:include href="hypervisor-host-install-libvirt.xml#xpointer(/section/*)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
+ <section id="lxc-install-security-policies">
+ <xi:include href="hypervisor-host-install-security-policies.xml#xpointer(/section/*)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
+ <section id="lxc-install-network">
+ <xi:include href="hypervisor-host-install-network.xml#xpointer(/section/*)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
+ <section id="lxc-install-firewall">
+ <xi:include href="hypervisor-host-install-firewall.xml#xpointer(/section/*)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
+ <section id="lxc-install-finish">
+ <xi:include href="hypervisor-host-install-finish.xml#xpointer(/section/*)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/lxc-topology-req.xml
----------------------------------------------------------------------
diff --git a/en-US/lxc-topology-req.xml b/en-US/lxc-topology-req.xml
new file mode 100644
index 0000000..315863d
--- /dev/null
+++ b/en-US/lxc-topology-req.xml
@@ -0,0 +1,24 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="lxc-topology-req">
+ <title>LXC Topology Requirements</title>
+ <para>The Management Servers communicate with LXC hosts on port 22 (ssh).</para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/maintain-hypervisors-on-hosts.xml
----------------------------------------------------------------------
diff --git a/en-US/maintain-hypervisors-on-hosts.xml b/en-US/maintain-hypervisors-on-hosts.xml
new file mode 100644
index 0000000..43f3f79
--- /dev/null
+++ b/en-US/maintain-hypervisors-on-hosts.xml
@@ -0,0 +1,29 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="maintain-hypervisors-on-hosts">
+ <title>Maintaining Hypervisors on Hosts</title>
+ <para>When running hypervisor software on hosts, be sure all the hotfixes provided by the hypervisor vendor are applied. Track the release of hypervisor patches through your hypervisor vendor’s support channel, and apply patches as soon as possible after they are released. &PRODUCT; will not track or notify you of required hypervisor patches. It is essential that your hosts are completely up to date with the provided hypervisor patches. The hypervisor vendor is likely to refuse to support any system that is not up to date with patches.</para>
+ <note><para>The lack of up-do-date hotfixes can lead to data corruption and lost VMs.</para></note>
+ <para>(XenServer) For more information, see <ulink url="http://docs.cloudstack.org/Knowledge_Base/Possible_VM_corruption_if_XenServer_Hotfix_is_not_Applied/Highly_Recommended_Hotfixes_for_XenServer_5.6_SP2">Highly Recommended Hotfixes for XenServer in the &PRODUCT; Knowledge Base</ulink>.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/maintenance-mode-for-primary-storage.xml
----------------------------------------------------------------------
diff --git a/en-US/maintenance-mode-for-primary-storage.xml b/en-US/maintenance-mode-for-primary-storage.xml
new file mode 100644
index 0000000..54c3a0d
--- /dev/null
+++ b/en-US/maintenance-mode-for-primary-storage.xml
@@ -0,0 +1,28 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<section id="maintenance-mode-for-primary-storage.xml">
+ <title>Maintenance Mode for Primary Storage</title>
+ <para>Primary storage may be placed into maintenance mode. This is useful, for example, to replace faulty RAM in a storage device. Maintenance mode for a storage device will first stop any new guests from being provisioned on the storage device. Then it will stop all guests that have any volume on that storage device. When all such guests are stopped the storage device is in maintenance mode and may be shut down. When the storage device is online again you may cancel maintenance mode for the device. The &PRODUCT; will bring the device back online and attempt to start all guests that were running at the time of the entry into maintenance mode.</para>
+ </section>