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/08/12 03:28:51 UTC
[10/31] docs: Fix indentation according to coding convention
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/install-database-on-separate-node.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/install-database-on-separate-node.xml b/docs/en-US/install-database-on-separate-node.xml
index 362269c..bc76829 100644
--- a/docs/en-US/install-database-on-separate-node.xml
+++ b/docs/en-US/install-database-on-separate-node.xml
@@ -23,83 +23,83 @@
-->
<section id="install-database-on-separate-node">
- <title>Install the Database on a Separate Node</title>
- <para>This section describes how to install MySQL on a standalone machine, separate from the Management Server.
- This technique is intended for a deployment that includes several Management Server nodes.
- If you have a single-node Management Server deployment, you will typically use the same node for MySQL.
- See <xref linkend="install-database-on-management-server-node"/>.
- </para>
- <orderedlist>
- <listitem><para>If you already have a version of MySQL installed on the Management Server node, make one of the following choices, depending on what version of MySQL it is. The most recent version tested is 5.1.58.</para>
- <itemizedlist>
- <listitem><para>If you already have installed MySQL version 5.1.58 or later, skip to step 3.</para>
- </listitem>
- <listitem><para>If you have installed a version of MySQL earlier than 5.1.58, you can either skip to step 3 or uninstall MySQL and proceed to step 2 to install a more recent version.</para></listitem>
- </itemizedlist>
- <warning><para>It is important that you choose the right database version. Never downgrade a MySQL installation.</para></warning>
- </listitem>
- <listitem><para>Log in as root to your Database Node and run the following commands. If you are going to install a replica database, then log in to the master.</para>
- <programlisting>
+ <title>Install the Database on a Separate Node</title>
+ <para>This section describes how to install MySQL on a standalone machine, separate from the Management Server.
+ This technique is intended for a deployment that includes several Management Server nodes.
+ If you have a single-node Management Server deployment, you will typically use the same node for MySQL.
+ See <xref linkend="install-database-on-management-server-node"/>.
+ </para>
+ <orderedlist>
+ <listitem><para>If you already have a version of MySQL installed on the Management Server node, make one of the following choices, depending on what version of MySQL it is. The most recent version tested is 5.1.58.</para>
+ <itemizedlist>
+ <listitem><para>If you already have installed MySQL version 5.1.58 or later, skip to step 3.</para>
+ </listitem>
+ <listitem><para>If you have installed a version of MySQL earlier than 5.1.58, you can either skip to step 3 or uninstall MySQL and proceed to step 2 to install a more recent version.</para></listitem>
+ </itemizedlist>
+ <warning><para>It is important that you choose the right database version. Never downgrade a MySQL installation.</para></warning>
+ </listitem>
+ <listitem><para>Log in as root to your Database Node and run the following commands. If you are going to install a replica database, then log in to the master.</para>
+ <programlisting>
# yum install mysql-server
# chkconfig --level 35 mysqld on
- </programlisting>
- </listitem>
- <listitem><para>Edit the MySQL configuration (/etc/my.cnf or /etc/mysql/my.cnf, depending on your OS)
- and insert the following lines in the [mysqld] section. You can put these lines below the datadir
- line. The max_connections parameter should be set to 350 multiplied by the number of Management
- Servers you are deploying. This example assumes two Management Servers.</para>
- <programlisting>
+ </programlisting>
+ </listitem>
+ <listitem><para>Edit the MySQL configuration (/etc/my.cnf or /etc/mysql/my.cnf, depending on your OS)
+ and insert the following lines in the [mysqld] section. You can put these lines below the datadir
+ line. The max_connections parameter should be set to 350 multiplied by the number of Management
+ Servers you are deploying. This example assumes two Management Servers.</para>
+ <programlisting>
innodb_rollback_on_timeout=1
innodb_lock_wait_timeout=600
max_connections=700
log-bin=mysql-bin
binlog-format = 'ROW'
- </programlisting>
- <note><para>The binlog-format variable is supported in MySQL versions 5.1 and greater. It is not supported in MySQL 5.0. In some versions of MySQL, an underscore character is used in place of the hyphen in the variable name. For the exact syntax and spelling of each variable, consult the documentation for your version of MySQL.</para></note>
- </listitem>
- <listitem><para>Restart the MySQL service, then invoke MySQL as the root user.</para>
- <programlisting>
+ </programlisting>
+ <note><para>The binlog-format variable is supported in MySQL versions 5.1 and greater. It is not supported in MySQL 5.0. In some versions of MySQL, an underscore character is used in place of the hyphen in the variable name. For the exact syntax and spelling of each variable, consult the documentation for your version of MySQL.</para></note>
+ </listitem>
+ <listitem><para>Restart the MySQL service, then invoke MySQL as the root user.</para>
+ <programlisting>
# service mysqld restart
# mysql -u root
- </programlisting>
- </listitem>
- <listitem><para>Best Practice: On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution. Run the following commands, and substitute your own desired root password.</para>
- <programlisting>mysql> SET PASSWORD = PASSWORD('password');</programlisting>
- <para>From now on, start MySQL with mysql -p so it will prompt you for the password.</para>
- </listitem>
- <listitem><para>To grant access privileges to remote users, perform the following steps.</para>
- <orderedlist numeration="loweralpha">
- <listitem><para>Run the following commands from the mysql prompt:</para>
- <programlisting>
+ </programlisting>
+ </listitem>
+ <listitem><para>Best Practice: On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution. Run the following commands, and substitute your own desired root password.</para>
+ <programlisting>mysql> SET PASSWORD = PASSWORD('password');</programlisting>
+ <para>From now on, start MySQL with mysql -p so it will prompt you for the password.</para>
+ </listitem>
+ <listitem><para>To grant access privileges to remote users, perform the following steps.</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>Run the following commands from the mysql prompt:</para>
+ <programlisting>
mysql> GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION;
mysql> exit
- </programlisting>
- </listitem>
- <listitem><para>Restart the MySQL service.</para>
- <programlisting># service mysqld restart</programlisting>
- </listitem>
- <listitem><para>Open the MySQL server port (3306) in the firewall to allow remote clients to connect.</para>
- <programlisting># iptables -I INPUT -p tcp --dport 3306 -j ACCEPT</programlisting>
- </listitem>
- <listitem><para>Edit the /etc/sysconfig/iptables file and add the following line at the beginning of the INPUT chain.</para>
- <programlisting> -A INPUT -p tcp --dport 3306 -j ACCEPT</programlisting>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem><para>Set up the database. The following command creates the cloud user on the database.</para>
- <itemizedlist>
- <listitem><para>In dbpassword, specify the password to be assigned to the cloud user. You can choose to provide no password.</para></listitem>
- <listitem><para>In deploy-as, specify the username and password of the user deploying the database. In the following command, it is assumed the root user is deploying the database and creating the cloud user.</para></listitem>
- <listitem><para>(Optional) For encryption_type, use file or web to indicate the technique used to pass in the database encryption password. Default: file. See About Password and Key Encryption.</para></listitem>
- <listitem><para>(Optional) For management_server_key, substitute the default key that is used to encrypt confidential parameters in the &PRODUCT; properties file. Default: password. It is highly recommended that you replace this with a more secure value. See About Password and Key Encryption.</para></listitem>
- <listitem><para>(Optional) For database_key, substitute the default key that is used to encrypt confidential parameters in the &PRODUCT; database. Default: password. It is highly recommended that you replace this with a more secure value. See About Password and Key Encryption.</para></listitem>
- </itemizedlist>
- <programlisting># cloud-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key></programlisting>
- <para>When this script is finished, you should see a message like “Successfully initialized the database.”</para>
- </listitem>
- <listitem><para>Now that the database is set up, you can finish configuring the OS for the Management Server. This command will set up iptables, sudoers, and start the Management Server.</para>
- <programlisting># cloud-setup-management</programlisting>
- <para>You should see the message “Management Server setup is done.”</para>
- </listitem>
- </orderedlist>
+ </programlisting>
+ </listitem>
+ <listitem><para>Restart the MySQL service.</para>
+ <programlisting># service mysqld restart</programlisting>
+ </listitem>
+ <listitem><para>Open the MySQL server port (3306) in the firewall to allow remote clients to connect.</para>
+ <programlisting># iptables -I INPUT -p tcp --dport 3306 -j ACCEPT</programlisting>
+ </listitem>
+ <listitem><para>Edit the /etc/sysconfig/iptables file and add the following line at the beginning of the INPUT chain.</para>
+ <programlisting> -A INPUT -p tcp --dport 3306 -j ACCEPT</programlisting>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem><para>Set up the database. The following command creates the cloud user on the database.</para>
+ <itemizedlist>
+ <listitem><para>In dbpassword, specify the password to be assigned to the cloud user. You can choose to provide no password.</para></listitem>
+ <listitem><para>In deploy-as, specify the username and password of the user deploying the database. In the following command, it is assumed the root user is deploying the database and creating the cloud user.</para></listitem>
+ <listitem><para>(Optional) For encryption_type, use file or web to indicate the technique used to pass in the database encryption password. Default: file. See About Password and Key Encryption.</para></listitem>
+ <listitem><para>(Optional) For management_server_key, substitute the default key that is used to encrypt confidential parameters in the &PRODUCT; properties file. Default: password. It is highly recommended that you replace this with a more secure value. See About Password and Key Encryption.</para></listitem>
+ <listitem><para>(Optional) For database_key, substitute the default key that is used to encrypt confidential parameters in the &PRODUCT; database. Default: password. It is highly recommended that you replace this with a more secure value. See About Password and Key Encryption.</para></listitem>
+ </itemizedlist>
+ <programlisting># cloud-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key></programlisting>
+ <para>When this script is finished, you should see a message like “Successfully initialized the database.”</para>
+ </listitem>
+ <listitem><para>Now that the database is set up, you can finish configuring the OS for the Management Server. This command will set up iptables, sudoers, and start the Management Server.</para>
+ <programlisting># cloud-setup-management</programlisting>
+ <para>You should see the message “Management Server setup is done.”</para>
+ </listitem>
+ </orderedlist>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/install-management-server-multi-nodes.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/install-management-server-multi-nodes.xml b/docs/en-US/install-management-server-multi-nodes.xml
index 5b83265..17d0f86 100644
--- a/docs/en-US/install-management-server-multi-nodes.xml
+++ b/docs/en-US/install-management-server-multi-nodes.xml
@@ -23,52 +23,52 @@
-->
<section id="install-management-server-multi-nodes">
- <title>Prepare and Start Additional Management Servers</title>
- <para>For your second and subsequent Management Servers, you will install the Management Server software, connect it to the database, and set up the OS for the Management Server.
- </para>
- <orderedlist>
- <listitem><para>Perform the steps in <xref linkend="prepare-os"/>.</para>
- </listitem>
- <listitem><para>Download the Management Server onto the additional host where it will run. Get the software from the following link.</para>
- <para condition="cloudplatform"><ulink url="https://www.citrix.com/English/ss/downloads/">https://www.citrix.com/English/ss/downloads/</ulink></para>
+ <title>Prepare and Start Additional Management Servers</title>
+ <para>For your second and subsequent Management Servers, you will install the Management Server software, connect it to the database, and set up the OS for the Management Server.
+ </para>
+ <orderedlist>
+ <listitem><para>Perform the steps in <xref linkend="prepare-os"/>.</para>
+ </listitem>
+ <listitem><para>Download the Management Server onto the additional host where it will run. Get the software from the following link.</para>
+ <para condition="cloudplatform"><ulink url="https://www.citrix.com/English/ss/downloads/">https://www.citrix.com/English/ss/downloads/</ulink></para>
<para condition="cloudstack"><ulink url="FIXME">FIXME</ulink></para>
- <para condition="cloudplatform">You will need a <ulink url="http://www.citrix.com/lang/English/publicindex.asp?destURL=%2FEnglish%2FmyCitrix%2Findex.asp%3F">MyCitrix account</ulink>.</para>
- </listitem>
- <listitem><para>Install the packages. You should have a file in the form of “&PRODUCT;-VERSION-N-OSVERSION.tar.gz”. Untar the file and then run the install.sh script inside it. Replace the file and directory names below with those you are using:</para>
- <programlisting>
+ <para condition="cloudplatform">You will need a <ulink url="http://www.citrix.com/lang/English/publicindex.asp?destURL=%2FEnglish%2FmyCitrix%2Findex.asp%3F">MyCitrix account</ulink>.</para>
+ </listitem>
+ <listitem><para>Install the packages. You should have a file in the form of “&PRODUCT;-VERSION-N-OSVERSION.tar.gz”. Untar the file and then run the install.sh script inside it. Replace the file and directory names below with those you are using:</para>
+ <programlisting>
# tar xzf &PRODUCT;-VERSION-N-OSVERSION.tar.gz
# cd &PRODUCT;-VERSION-N-OSVERSION
# ./install.sh
- </programlisting>
- <para>You should see a few messages as the installer prepares, followed by a list of choices.</para>
- </listitem>
- <listitem><para>Choose M to install the Management Server software.</para>
- <programlisting> > M</programlisting>
- </listitem>
- <listitem><para>Wait for a message like “Complete! Done,” which indicates that the software was installed successfully.</para>
- </listitem>
- <listitem><para>(RHEL or CentOS) When the installation is finished, run the following commands to start essential services (the commands might be different depending on your OS):</para>
- <programlisting>
+ </programlisting>
+ <para>You should see a few messages as the installer prepares, followed by a list of choices.</para>
+ </listitem>
+ <listitem><para>Choose M to install the Management Server software.</para>
+ <programlisting> > M</programlisting>
+ </listitem>
+ <listitem><para>Wait for a message like “Complete! Done,” which indicates that the software was installed successfully.</para>
+ </listitem>
+ <listitem><para>(RHEL or CentOS) When the installation is finished, run the following commands to start essential services (the commands might be different depending on your OS):</para>
+ <programlisting>
# service rpcbind start
# service nfs start
# chkconfig nfs on
# chkconfig rpcbind on
- </programlisting>
- </listitem>
- <listitem><para>Configure the database client. Note the absence of the --deploy-as argument in this case.
- (For more details about the arguments to this command, see <xref linkend="install-database-on-separate-node"/>.)
- </para>
- <programlisting># cloud-setup-databases cloud:<dbpassword>@<dbhost> -e <encryption_type> -m <management_server_key> -k <database_key>
- </programlisting>
- </listitem>
- <listitem><para>(Trial installations only) If you are running the hypervisor on the same machine with the Management Server, edit /etc/sudoers and add the following line:</para>
- <programlisting>Defaults:cloud !requiretty</programlisting>
- </listitem>
- <listitem><para>Configure the OS and start the Management Server:</para>
- <programlisting># cloud-setup-management</programlisting>
- <para>The Management Server on this node should now be running.</para>
- </listitem>
- <listitem><para>Repeat these steps on each additional Management Server. </para></listitem>
- <listitem><para>Be sure to configure a load balancer for the Management Servers. See Management Server Load Balancing.</para></listitem>
- </orderedlist>
+ </programlisting>
+ </listitem>
+ <listitem><para>Configure the database client. Note the absence of the --deploy-as argument in this case.
+ (For more details about the arguments to this command, see <xref linkend="install-database-on-separate-node"/>.)
+ </para>
+ <programlisting># cloud-setup-databases cloud:<dbpassword>@<dbhost> -e <encryption_type> -m <management_server_key> -k <database_key>
+ </programlisting>
+ </listitem>
+ <listitem><para>(Trial installations only) If you are running the hypervisor on the same machine with the Management Server, edit /etc/sudoers and add the following line:</para>
+ <programlisting>Defaults:cloud !requiretty</programlisting>
+ </listitem>
+ <listitem><para>Configure the OS and start the Management Server:</para>
+ <programlisting># cloud-setup-management</programlisting>
+ <para>The Management Server on this node should now be running.</para>
+ </listitem>
+ <listitem><para>Repeat these steps on each additional Management Server. </para></listitem>
+ <listitem><para>Be sure to configure a load balancer for the Management Servers. See Management Server Load Balancing.</para></listitem>
+ </orderedlist>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/install-management-server.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/install-management-server.xml b/docs/en-US/install-management-server.xml
index c74c866..d8eb1e5 100644
--- a/docs/en-US/install-management-server.xml
+++ b/docs/en-US/install-management-server.xml
@@ -23,36 +23,36 @@
-->
<section id="install-management-server">
- <title>Install the Management Server on the First Host</title>
- <para>The first step in installation, whether you are installing the Management Server on one host or many, is to install the software on a single node.
- </para>
- <note><para>If you are planning to install the Management Server on multiple nodes for high availability, do not proceed to the additional nodes yet. That step will come later.</para></note>
- <orderedlist>
- <listitem><para>Download the Management Server onto the host where it will run. Get the software from the following link.</para>
- <para condition="cloudplatform"><ulink url="https://www.citrix.com/English/ss/downloads/">https://www.citrix.com/English/ss/downloads/</ulink></para>
- <para condition="cloudstack"><ulink url="FIXME">FIXME</ulink></para>
- <para condition="cloudplatform">You will need a <ulink url="http://www.citrix.com/lang/English/publicindex.asp?destURL=%2FEnglish%2FmyCitrix%2Findex.asp%3F">MyCitrix account</ulink>.</para>
- </listitem>
- <listitem><para>Install the packages. You should have a file in the form of “&PRODUCT;-VERSION-N-OSVERSION.tar.gz”. Untar the file and then run the install.sh script inside it. Replace the file and directory names below with those you are using:</para>
- <programlisting>
+ <title>Install the Management Server on the First Host</title>
+ <para>The first step in installation, whether you are installing the Management Server on one host or many, is to install the software on a single node.
+ </para>
+ <note><para>If you are planning to install the Management Server on multiple nodes for high availability, do not proceed to the additional nodes yet. That step will come later.</para></note>
+ <orderedlist>
+ <listitem><para>Download the Management Server onto the host where it will run. Get the software from the following link.</para>
+ <para condition="cloudplatform"><ulink url="https://www.citrix.com/English/ss/downloads/">https://www.citrix.com/English/ss/downloads/</ulink></para>
+ <para condition="cloudstack"><ulink url="FIXME">FIXME</ulink></para>
+ <para condition="cloudplatform">You will need a <ulink url="http://www.citrix.com/lang/English/publicindex.asp?destURL=%2FEnglish%2FmyCitrix%2Findex.asp%3F">MyCitrix account</ulink>.</para>
+ </listitem>
+ <listitem><para>Install the packages. You should have a file in the form of “&PRODUCT;-VERSION-N-OSVERSION.tar.gz”. Untar the file and then run the install.sh script inside it. Replace the file and directory names below with those you are using:</para>
+ <programlisting>
# tar xzf &PRODUCT;-VERSION-N-OSVERSION.tar.gz
# cd &PRODUCT;-VERSION-N-OSVERSION
# ./install.sh
- </programlisting>
- <para>You should see a few messages as the installer prepares, followed by a list of choices.</para>
- </listitem>
- <listitem><para>Choose M to install the Management Server software.</para>
- <programlisting> > M</programlisting>
- </listitem>
- <listitem><para>Wait for a message like “Complete! Done,” which indicates that the software was installed successfully.</para>
- </listitem>
- <listitem><para>(RHEL or CentOS) When the installation is finished, run the following commands to start essential services (the commands might be different depending on your OS):</para>
- <programlisting>
+ </programlisting>
+ <para>You should see a few messages as the installer prepares, followed by a list of choices.</para>
+ </listitem>
+ <listitem><para>Choose M to install the Management Server software.</para>
+ <programlisting> > M</programlisting>
+ </listitem>
+ <listitem><para>Wait for a message like “Complete! Done,” which indicates that the software was installed successfully.</para>
+ </listitem>
+ <listitem><para>(RHEL or CentOS) When the installation is finished, run the following commands to start essential services (the commands might be different depending on your OS):</para>
+ <programlisting>
# service rpcbind start
# service nfs start
# chkconfig nfs on
# chkconfig rpcbind on
- </programlisting>
- </listitem>
- </orderedlist>
+ </programlisting>
+ </listitem>
+ </orderedlist>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/installation-complete.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/installation-complete.xml b/docs/en-US/installation-complete.xml
index 197c3cf..8f4aa6f 100644
--- a/docs/en-US/installation-complete.xml
+++ b/docs/en-US/installation-complete.xml
@@ -23,17 +23,17 @@
-->
<section id="installation-complete">
- <title>Installation Complete! Next Steps</title>
- <para>Congratulations! You have now installed &PRODUCT; Management Server and the database it uses to persist system data.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/installation-complete.png" />
- </imageobject>
- <textobject><phrase>installation-complete.png: Finished installs with single Management Server and multiple Management Servers</phrase></textobject>
- </mediaobject>
- <para>What should you do next?</para>
- <itemizedlist>
- <listitem><para>Even without adding any cloud infrastructure, you can run the UI to get a feel for what's offered and how you will interact with &PRODUCT; on an ongoing basis. See Log In to the UI.</para></listitem>
- <listitem><para>When you're ready, add the cloud infrastructure and try running some virtual machines on it, so you can watch how &PRODUCT; manages the infrastructure. See Provision Your Cloud Infrastructure.</para></listitem>
- </itemizedlist>
+ <title>Installation Complete! Next Steps</title>
+ <para>Congratulations! You have now installed &PRODUCT; Management Server and the database it uses to persist system data.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/installation-complete.png" />
+ </imageobject>
+ <textobject><phrase>installation-complete.png: Finished installs with single Management Server and multiple Management Servers</phrase></textobject>
+ </mediaobject>
+ <para>What should you do next?</para>
+ <itemizedlist>
+ <listitem><para>Even without adding any cloud infrastructure, you can run the UI to get a feel for what's offered and how you will interact with &PRODUCT; on an ongoing basis. See Log In to the UI.</para></listitem>
+ <listitem><para>When you're ready, add the cloud infrastructure and try running some virtual machines on it, so you can watch how &PRODUCT; manages the infrastructure. See Provision Your Cloud Infrastructure.</para></listitem>
+ </itemizedlist>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/installation-steps-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/installation-steps-overview.xml b/docs/en-US/installation-steps-overview.xml
index 493ea24..ed2e3d1 100644
--- a/docs/en-US/installation-steps-overview.xml
+++ b/docs/en-US/installation-steps-overview.xml
@@ -23,60 +23,60 @@
-->
<section id="installation-steps-overview">
- <title>Overview of Installation Steps</title>
- <para>For anything more than a simple trial installation, you will need guidance for a variety of configuration choices. It is strongly recommended that you read the following:</para>
- <itemizedlist>
- <listitem><para>Choosing a Deployment Architecture</para></listitem>
- <listitem><para>Choosing a Hypervisor: Supported Features</para></listitem>
- <listitem><para>Network Setup</para></listitem>
- <listitem><para>Storage Setup</para></listitem>
- <listitem><para>Best Practices</para></listitem>
- </itemizedlist>
- <orderedlist>
- <listitem>
- <para>
- <emphasis role="bold">Prepare</emphasis>
- </para>
- <para>Make sure you have the required hardware ready</para>
- </listitem>
- <listitem>
- <para>(Optional) Fill out the preparation checklists</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Install the &PRODUCT; software</emphasis></para>
- </listitem>
- <listitem>
- <para>Install the Management Server (choose single-node or multi-node)</para>
- </listitem>
- <listitem>
- <para>Log in to the UI</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Provision your cloud infrastructure</emphasis></para>
- </listitem>
- <listitem>
- <para>Add a zone. Includes the first pod, cluster, and host</para>
- </listitem>
- <listitem>
- <para>Add more pods</para>
- </listitem>
- <listitem>
- <para>Add more clusters</para>
- </listitem>
- <listitem>
- <para>Add more hosts</para>
- </listitem>
- <listitem>
- <para>Add more primary storage</para>
- </listitem>
- <listitem>
- <para>Add more secondary storage</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Try using the cloud</emphasis></para>
- </listitem>
- <listitem>
- <para>Initialization and testing</para>
- </listitem>
+ <title>Overview of Installation Steps</title>
+ <para>For anything more than a simple trial installation, you will need guidance for a variety of configuration choices. It is strongly recommended that you read the following:</para>
+ <itemizedlist>
+ <listitem><para>Choosing a Deployment Architecture</para></listitem>
+ <listitem><para>Choosing a Hypervisor: Supported Features</para></listitem>
+ <listitem><para>Network Setup</para></listitem>
+ <listitem><para>Storage Setup</para></listitem>
+ <listitem><para>Best Practices</para></listitem>
+ </itemizedlist>
+ <orderedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Prepare</emphasis>
+ </para>
+ <para>Make sure you have the required hardware ready</para>
+ </listitem>
+ <listitem>
+ <para>(Optional) Fill out the preparation checklists</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Install the &PRODUCT; software</emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Install the Management Server (choose single-node or multi-node)</para>
+ </listitem>
+ <listitem>
+ <para>Log in to the UI</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Provision your cloud infrastructure</emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Add a zone. Includes the first pod, cluster, and host</para>
+ </listitem>
+ <listitem>
+ <para>Add more pods</para>
+ </listitem>
+ <listitem>
+ <para>Add more clusters</para>
+ </listitem>
+ <listitem>
+ <para>Add more hosts</para>
+ </listitem>
+ <listitem>
+ <para>Add more primary storage</para>
+ </listitem>
+ <listitem>
+ <para>Add more secondary storage</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Try using the cloud</emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Initialization and testing</para>
+ </listitem>
</orderedlist>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/installation.xml b/docs/en-US/installation.xml
index 3b82727..883a094 100644
--- a/docs/en-US/installation.xml
+++ b/docs/en-US/installation.xml
@@ -23,9 +23,9 @@
-->
<chapter id="installation">
- <title>Installation</title>
- <xi:include href="who-should-read-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="installation-steps-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="minimum-system-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="management-server-install-flow.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <title>Installation</title>
+ <xi:include href="who-should-read-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="installation-steps-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="minimum-system-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="management-server-install-flow.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/installation_overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/installation_overview.xml b/docs/en-US/installation_overview.xml
index 84a4503..eee444e 100644
--- a/docs/en-US/installation_overview.xml
+++ b/docs/en-US/installation_overview.xml
@@ -23,11 +23,11 @@
-->
<chapter id="installation_overview">
- <title>Installation Overview</title>
- <xi:include href="cloudstack_whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="cloudstack_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="deployment_architecture_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="installation_steps_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="cloudstack_system_requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-
+ <title>Installation Overview</title>
+ <xi:include href="cloudstack_whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="cloudstack_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="deployment_architecture_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="installation_steps_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="cloudstack_system_requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/introduction.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/introduction.xml b/docs/en-US/introduction.xml
index 3a30896..9aca8bd 100644
--- a/docs/en-US/introduction.xml
+++ b/docs/en-US/introduction.xml
@@ -23,8 +23,8 @@
-->
<section id="introduction">
- <title>Introduction</title>
- <xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <title>Introduction</title>
+ <xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="api-reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="developer-getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="developer-getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/ip-load-balancing.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ip-load-balancing.xml b/docs/en-US/ip-load-balancing.xml
index 1ec4663..ae569e7 100644
--- a/docs/en-US/ip-load-balancing.xml
+++ b/docs/en-US/ip-load-balancing.xml
@@ -23,12 +23,12 @@
-->
<section id="ip-load-balancing">
- <title>IP Load Balancing</title>
- <para>The user may choose to associate the same public IP for multiple guests. &PRODUCT; implements a TCP-level load balancer with the following policies.</para>
- <itemizedlist>
- <listitem><para>Round-robin</para></listitem>
- <listitem><para>Least connection</para></listitem>
- <listitem><para>Source IP</para></listitem>
- </itemizedlist>
- <para>This is similar to port forwarding but the destination may be multiple IP addresses.</para>
+ <title>IP Load Balancing</title>
+ <para>The user may choose to associate the same public IP for multiple guests. &PRODUCT; implements a TCP-level load balancer with the following policies.</para>
+ <itemizedlist>
+ <listitem><para>Round-robin</para></listitem>
+ <listitem><para>Least connection</para></listitem>
+ <listitem><para>Source IP</para></listitem>
+ </itemizedlist>
+ <para>This is similar to port forwarding but the destination may be multiple IP addresses.</para>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/ipaddress-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ipaddress-usage-record-format.xml b/docs/en-US/ipaddress-usage-record-format.xml
index e0551fc..1a0385b 100644
--- a/docs/en-US/ipaddress-usage-record-format.xml
+++ b/docs/en-US/ipaddress-usage-record-format.xml
@@ -23,20 +23,20 @@
-->
<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>
+ <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/incubator-cloudstack/blob/dcfa5a50/docs/en-US/job-status.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/job-status.xml b/docs/en-US/job-status.xml
index aebf8af..da0f76c 100644
--- a/docs/en-US/job-status.xml
+++ b/docs/en-US/job-status.xml
@@ -23,12 +23,12 @@
-->
<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>
+ <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/incubator-cloudstack/blob/dcfa5a50/docs/en-US/linux-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/linux-installation.xml b/docs/en-US/linux-installation.xml
index df7a8b7..60d389c 100644
--- a/docs/en-US/linux-installation.xml
+++ b/docs/en-US/linux-installation.xml
@@ -23,25 +23,25 @@
-->
<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://cloudstack.org/dl/cloud-set-guest-password"></ulink></para></listitem>
- <listitem><para>Windows: <ulink url="http://sourceforge.net/projects/cloudstack/files/Password%20Management%20Scripts/CloudInstanceManager.msi/download"></ulink></para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>Copy this file to /etc/init.d.</para>
- <para>On some Linux distributions, copy the file to /etc/rc.d/init.d.</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 /etc/network/if-up and /etc/network/if-down 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>
+ <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://cloudstack.org/dl/cloud-set-guest-password"></ulink></para></listitem>
+ <listitem><para>Windows: <ulink url="http://sourceforge.net/projects/cloudstack/files/Password%20Management%20Scripts/CloudInstanceManager.msi/download"></ulink></para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Copy this file to /etc/init.d.</para>
+ <para>On some Linux distributions, copy the file to /etc/rc.d/init.d.</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 /etc/network/if-up and /etc/network/if-down 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/incubator-cloudstack/blob/dcfa5a50/docs/en-US/loadbalancer-policy-port-forwarding-rule-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/loadbalancer-policy-port-forwarding-rule-usage-record-format.xml b/docs/en-US/loadbalancer-policy-port-forwarding-rule-usage-record-format.xml
index 86f5411..e27a49d 100644
--- a/docs/en-US/loadbalancer-policy-port-forwarding-rule-usage-record-format.xml
+++ b/docs/en-US/loadbalancer-policy-port-forwarding-rule-usage-record-format.xml
@@ -23,18 +23,18 @@
-->
<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>
+ <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/incubator-cloudstack/blob/dcfa5a50/docs/en-US/log-in.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/log-in.xml b/docs/en-US/log-in.xml
index 4425aa4..e72d27b 100644
--- a/docs/en-US/log-in.xml
+++ b/docs/en-US/log-in.xml
@@ -23,9 +23,9 @@
-->
<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>
+ <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>
@@ -42,7 +42,7 @@
<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="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" />
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/long-running-job-events.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/long-running-job-events.xml b/docs/en-US/long-running-job-events.xml
index 345a0d0..cae2b74 100644
--- a/docs/en-US/long-running-job-events.xml
+++ b/docs/en-US/long-running-job-events.xml
@@ -37,5 +37,5 @@
<listitem><para>ERROR. This event is generated when an operation has not been successfully performed</para></listitem>
</itemizedlist>
- </section>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/maintenance-mode-for-primary-storage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/maintenance-mode-for-primary-storage.xml b/docs/en-US/maintenance-mode-for-primary-storage.xml
index 657bc8b..54c3a0d 100644
--- a/docs/en-US/maintenance-mode-for-primary-storage.xml
+++ b/docs/en-US/maintenance-mode-for-primary-storage.xml
@@ -23,6 +23,6 @@
-->
<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>
+ <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>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/making-api-request.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/making-api-request.xml b/docs/en-US/making-api-request.xml
index 33c43c5..49ea158 100644
--- a/docs/en-US/making-api-request.xml
+++ b/docs/en-US/making-api-request.xml
@@ -2,7 +2,7 @@
<!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
@@ -23,19 +23,19 @@
-->
<section id="making-api-request">
- <title>Making API Requests</title>
- <para>All &PRODUCT; API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS:
- </para>
- <itemizedlist>
- <listitem><para>&PRODUCT; API URL: This is the web services API entry point(for example, http://www.cloud.com:8080/client/api)</para></listitem>
- <listitem><para>Command: The web services command you wish to execute, such as start a virtual machine or create a disk volume</para></listitem>
- <listitem><para>Parameters: Any additional required or optional parameters for the command</para></listitem>
- </itemizedlist>
- <para>A sample API GET request looks like the following:</para>
- <programlisting>http://localhost:8080/client/api?command=deployVirtualMachine&serviceOfferingId=1&diskOfferingId=1&templateId=2&zoneId=4&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D
- </programlisting>
- <para>Or in a more readable format:</para>
- <programlisting>
+ <title>Making API Requests</title>
+ <para>All &PRODUCT; API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS:
+ </para>
+ <itemizedlist>
+ <listitem><para>&PRODUCT; API URL: This is the web services API entry point(for example, http://www.cloud.com:8080/client/api)</para></listitem>
+ <listitem><para>Command: The web services command you wish to execute, such as start a virtual machine or create a disk volume</para></listitem>
+ <listitem><para>Parameters: Any additional required or optional parameters for the command</para></listitem>
+ </itemizedlist>
+ <para>A sample API GET request looks like the following:</para>
+ <programlisting>http://localhost:8080/client/api?command=deployVirtualMachine&serviceOfferingId=1&diskOfferingId=1&templateId=2&zoneId=4&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D
+ </programlisting>
+ <para>Or in a more readable format:</para>
+ <programlisting>
1. http://localhost:8080/client/api
2. ?command=deployVirtualMachine
3. &serviceOfferingId=1
@@ -44,11 +44,11 @@
6. &zoneId=4
7. &apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXqjB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ
8. &signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D
- </programlisting>
- <para>The first line is the &PRODUCT; API URL. This is the Cloud instance you wish to interact with.</para>
- <para>The second line refers to the command you wish to execute. In our example, we are attempting to deploy a fresh new virtual machine. It is preceded by a (?) to separate itself from the &PRODUCT; API URL.</para>
- <para>Lines 3-6 are the parameters for this given command. To see the command and its request parameters, please refer to the appropriate section in the &PRODUCT; API documentation. Each parameter field-value pair (field=value) is preceded by an ampersand character (&).</para>
- <para>Line 7 is the user API Key that uniquely identifies the account. See Signing API Requests on page 7.</para>
- <para>Line 8 is the signature hash created to authenticate the user account executing the API command. See Signing API Requests on page 7.</para>
- </section>
+ </programlisting>
+ <para>The first line is the &PRODUCT; API URL. This is the Cloud instance you wish to interact with.</para>
+ <para>The second line refers to the command you wish to execute. In our example, we are attempting to deploy a fresh new virtual machine. It is preceded by a (?) to separate itself from the &PRODUCT; API URL.</para>
+ <para>Lines 3-6 are the parameters for this given command. To see the command and its request parameters, please refer to the appropriate section in the &PRODUCT; API documentation. Each parameter field-value pair (field=value) is preceded by an ampersand character (&).</para>
+ <para>Line 7 is the user API Key that uniquely identifies the account. See Signing API Requests on page 7.</para>
+ <para>Line 8 is the signature hash created to authenticate the user account executing the API command. See Signing API Requests on page 7.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/management-server-install-flow.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/management-server-install-flow.xml b/docs/en-US/management-server-install-flow.xml
index dc6c651..b6c7052 100644
--- a/docs/en-US/management-server-install-flow.xml
+++ b/docs/en-US/management-server-install-flow.xml
@@ -23,14 +23,14 @@
-->
<section id="management-server-install-flow">
- <title>Management Server Installation</title>
- <xi:include href="management-server-installation-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="prepare-os.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="install-management-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <title>Management Server Installation</title>
+ <xi:include href="management-server-installation-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="prepare-os.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="install-management-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="install-database-on-management-server-node.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="install-database-on-separate-node.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="prepare-nfs-shares.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="install-management-server-multi-nodes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="prepare-system-vm-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="installation-complete.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="install-database-on-separate-node.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="prepare-nfs-shares.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="install-management-server-multi-nodes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="prepare-system-vm-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="installation-complete.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/management-server-installation-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/management-server-installation-overview.xml b/docs/en-US/management-server-installation-overview.xml
index 7c000c5..3ccbdcc 100644
--- a/docs/en-US/management-server-installation-overview.xml
+++ b/docs/en-US/management-server-installation-overview.xml
@@ -23,23 +23,23 @@
-->
<section id="management-server-installation-overview">
- <title>Management Server Installation Overview</title>
- <para>This section describes installing the Management Server. There are two slightly different installation flows, depending on how many Management Server nodes will be in your cloud:</para>
- <itemizedlist>
- <listitem><para>A single Management Server node, with MySQL on the same node.</para></listitem>
- <listitem><para>Multiple Management Server nodes, with MySQL on a node separate from the Management Servers.</para></listitem>
- </itemizedlist>
- <para>In either case, each machine must meet the system requirements described in System Requirements.</para>
- <warning><para>For the sake of security, be sure the public Internet can not access port 8096 or port 8250 on the Management Server.</para></warning>
- <para>
- The procedure for installing the Management Server is:
- </para>
- <orderedlist>
- <listitem><para>Prepare the Operating System</para></listitem>
- <listitem><para>Install the First Management Server</para></listitem>
- <listitem><para>Install and Configure the Database</para></listitem>
- <listitem><para>Prepare NFS Shares</para></listitem>
- <listitem><para>Prepare and Start Additional Management Servers (optional)</para></listitem>
- <listitem><para>Prepare the System VM Template</para></listitem>
- </orderedlist>
- </section>
+ <title>Management Server Installation Overview</title>
+ <para>This section describes installing the Management Server. There are two slightly different installation flows, depending on how many Management Server nodes will be in your cloud:</para>
+ <itemizedlist>
+ <listitem><para>A single Management Server node, with MySQL on the same node.</para></listitem>
+ <listitem><para>Multiple Management Server nodes, with MySQL on a node separate from the Management Servers.</para></listitem>
+ </itemizedlist>
+ <para>In either case, each machine must meet the system requirements described in System Requirements.</para>
+ <warning><para>For the sake of security, be sure the public Internet can not access port 8096 or port 8250 on the Management Server.</para></warning>
+ <para>
+ The procedure for installing the Management Server is:
+ </para>
+ <orderedlist>
+ <listitem><para>Prepare the Operating System</para></listitem>
+ <listitem><para>Install the First Management Server</para></listitem>
+ <listitem><para>Install and Configure the Database</para></listitem>
+ <listitem><para>Prepare NFS Shares</para></listitem>
+ <listitem><para>Prepare and Start Additional Management Servers (optional)</para></listitem>
+ <listitem><para>Prepare the System VM Template</para></listitem>
+ </orderedlist>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/management-server-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/management-server-overview.xml b/docs/en-US/management-server-overview.xml
index 12a5121..ed30142 100644
--- a/docs/en-US/management-server-overview.xml
+++ b/docs/en-US/management-server-overview.xml
@@ -23,36 +23,36 @@
-->
<section id="management-server-overview">
- <title>Management Server Overview</title>
- <para>The Management Server is the &PRODUCT; software that manages cloud resources. By interacting with the Management Server through its UI or API, you can configure and manage your cloud infrastructure.
- </para>
- <para>The Management Server runs on a dedicated server or VM. It controls allocation of virtual machines to hosts and assigns storage and IP addresses to the virtual machine instances. The Management Server runs in a Tomcat container and requires a MySQL database for persistence.
- </para>
- <para>The machine must meet the system requirements described in System Requirements.
- </para>
- <para>The Management Server:
- </para>
- <itemizedlist>
- <listitem>
- <para>Provides the web user interface for the administrator and a reference user interface for end users.</para>
- </listitem>
- <listitem>
- <para>Provides the APIs for &PRODUCT;.</para>
- </listitem>
- <listitem>
- <para>Manages the assignment of guest VMs to particular hosts.</para>
- </listitem>
- <listitem>
- <para>Manages the assignment of public and private IP addresses to particular accounts.</para>
- </listitem>
- <listitem>
- <para>Manages the allocation of storage to guests as virtual disks.</para>
- </listitem>
- <listitem>
- <para>Manages snapshots, templates, and ISO images, possibly replicating them across data centers.</para>
- </listitem>
- <listitem>
- <para>Provides a single point of configuration for the cloud.</para>
- </listitem>
- </itemizedlist>
- </section>
+ <title>Management Server Overview</title>
+ <para>The Management Server is the &PRODUCT; software that manages cloud resources. By interacting with the Management Server through its UI or API, you can configure and manage your cloud infrastructure.
+ </para>
+ <para>The Management Server runs on a dedicated server or VM. It controls allocation of virtual machines to hosts and assigns storage and IP addresses to the virtual machine instances. The Management Server runs in a Tomcat container and requires a MySQL database for persistence.
+ </para>
+ <para>The machine must meet the system requirements described in System Requirements.
+ </para>
+ <para>The Management Server:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Provides the web user interface for the administrator and a reference user interface for end users.</para>
+ </listitem>
+ <listitem>
+ <para>Provides the APIs for &PRODUCT;.</para>
+ </listitem>
+ <listitem>
+ <para>Manages the assignment of guest VMs to particular hosts.</para>
+ </listitem>
+ <listitem>
+ <para>Manages the assignment of public and private IP addresses to particular accounts.</para>
+ </listitem>
+ <listitem>
+ <para>Manages the allocation of storage to guests as virtual disks.</para>
+ </listitem>
+ <listitem>
+ <para>Manages snapshots, templates, and ISO images, possibly replicating them across data centers.</para>
+ </listitem>
+ <listitem>
+ <para>Provides a single point of configuration for the cloud.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/management_server_multi_node_install.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/management_server_multi_node_install.xml b/docs/en-US/management_server_multi_node_install.xml
index 5b6555a..30f6af9 100644
--- a/docs/en-US/management_server_multi_node_install.xml
+++ b/docs/en-US/management_server_multi_node_install.xml
@@ -23,8 +23,8 @@
-->
<chapter id="management_server_multi_node_install">
- <title>Management Server Multi-Node Installation</title>
- <xi:include href="multi_node_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="prepare_os.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="first_ms_node_install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <title>Management Server Multi-Node Installation</title>
+ <xi:include href="multi_node_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="prepare_os.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="first_ms_node_install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/management_server_overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/management_server_overview.xml b/docs/en-US/management_server_overview.xml
index 6b5d6fe..b5d74f3 100644
--- a/docs/en-US/management_server_overview.xml
+++ b/docs/en-US/management_server_overview.xml
@@ -21,33 +21,33 @@
specific language governing permissions and limitations
under the License.
-->
- <section id="management_server_overview">
- <title>Management Server Overview</title>
- <para>The Management Server is the &PRODUCT; software that manages cloud resources. By interacting with the Management Server through its UI or API, you can configure and manage your cloud infrastructure.</para>
- <para>The Management Server runs on a dedicated server or VM. It controls allocation of virtual machines to hosts and assigns storage and IP addresses to the virtual machine instances. The &PRODUCT; Management Server runs in a Tomcat container and requires a MySQL database for persistence.</para>
- <para>The machine must meet the system requirements described in System Requirements.</para>
- <para>The Management Server:</para>
- <itemizedlist>
- <listitem>
- <para>Provides the web user interface for the administrator and a reference user interface for end users.</para>
- </listitem>
- <listitem>
- <para>Provides the APIs for the &PRODUCT; platform.</para>
- </listitem>
- <listitem>
- <para>Manages the assignment of guest VMs to particular hosts.</para>
- </listitem>
- <listitem>
- <para>Manages the assignment of public and private IP addresses to particular accounts.</para>
- </listitem>
- <listitem>
- <para>Manages the allocation of storage to guests as virtual disks.</para>
- </listitem>
- <listitem>
- <para>Manages snapshots, templates, and ISO images, possibly replicating them across data centers.</para>
- </listitem>
- <listitem>
- <para>Provides a single point of configuration for the cloud.</para>
- </listitem>
- </itemizedlist>
- </section>
+ <section id="management_server_overview">
+ <title>Management Server Overview</title>
+ <para>The Management Server is the &PRODUCT; software that manages cloud resources. By interacting with the Management Server through its UI or API, you can configure and manage your cloud infrastructure.</para>
+ <para>The Management Server runs on a dedicated server or VM. It controls allocation of virtual machines to hosts and assigns storage and IP addresses to the virtual machine instances. The &PRODUCT; Management Server runs in a Tomcat container and requires a MySQL database for persistence.</para>
+ <para>The machine must meet the system requirements described in System Requirements.</para>
+ <para>The Management Server:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Provides the web user interface for the administrator and a reference user interface for end users.</para>
+ </listitem>
+ <listitem>
+ <para>Provides the APIs for the &PRODUCT; platform.</para>
+ </listitem>
+ <listitem>
+ <para>Manages the assignment of guest VMs to particular hosts.</para>
+ </listitem>
+ <listitem>
+ <para>Manages the assignment of public and private IP addresses to particular accounts.</para>
+ </listitem>
+ <listitem>
+ <para>Manages the allocation of storage to guests as virtual disks.</para>
+ </listitem>
+ <listitem>
+ <para>Manages snapshots, templates, and ISO images, possibly replicating them across data centers.</para>
+ </listitem>
+ <listitem>
+ <para>Provides a single point of configuration for the cloud.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/manual-live-migration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/manual-live-migration.xml b/docs/en-US/manual-live-migration.xml
index a82b52e..390b417 100644
--- a/docs/en-US/manual-live-migration.xml
+++ b/docs/en-US/manual-live-migration.xml
@@ -23,30 +23,30 @@
-->
<section id="manual-live-migration">
- <title>Moving VMs Between Hosts (Manual Live Migration)</title>
- <para>The CloudPlatform administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions:</para>
- <itemizedlist>
- <listitem><para>The root administrator is logged in. Domain admins and users can not perform manual live migration of VMs.</para></listitem>
- <listitem><para>The VM is running. Stopped VMs can not be live migrated.</para></listitem>
- <listitem><para>The destination host must be in the same cluster as the original host.</para></listitem>
- <listitem><para>The VM must not be using local disk storage.</para></listitem>
- <listitem><para>The destination host must have enough available capacity. If not, the VM will remain in the "migrating" state until memory becomes available.</para></listitem>
- <listitem><para>(OVM) If the VM is running on the OVM hypervisor, it must not have an ISO attached. Live migration of a VM with attached ISO is not supported in OVM.</para></listitem>
- </itemizedlist>
- <para>To manually live migrate a virtual machine</para>
- <orderedlist>
- <listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
- <listitem><para>In the left navigation, click Instances.</para></listitem>
- <listitem><para>Choose the VM that you want to migrate.</para></listitem>
- <listitem><para>Click the Migrate Instance button <inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/migrate-instance.png" />
- </imageobject>
- <textobject><phrase>Migrateinstance.png: button to migrate an instance</phrase></textobject>
- </inlinemediaobject>
- </para></listitem>
- <listitem><para>From the list of hosts, choose the one to which you want to move the VM.</para></listitem>
- <listitem><para>Click OK.</para></listitem>
- </orderedlist>
- </section>
+ <title>Moving VMs Between Hosts (Manual Live Migration)</title>
+ <para>The CloudPlatform administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions:</para>
+ <itemizedlist>
+ <listitem><para>The root administrator is logged in. Domain admins and users can not perform manual live migration of VMs.</para></listitem>
+ <listitem><para>The VM is running. Stopped VMs can not be live migrated.</para></listitem>
+ <listitem><para>The destination host must be in the same cluster as the original host.</para></listitem>
+ <listitem><para>The VM must not be using local disk storage.</para></listitem>
+ <listitem><para>The destination host must have enough available capacity. If not, the VM will remain in the "migrating" state until memory becomes available.</para></listitem>
+ <listitem><para>(OVM) If the VM is running on the OVM hypervisor, it must not have an ISO attached. Live migration of a VM with attached ISO is not supported in OVM.</para></listitem>
+ </itemizedlist>
+ <para>To manually live migrate a virtual machine</para>
+ <orderedlist>
+ <listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
+ <listitem><para>In the left navigation, click Instances.</para></listitem>
+ <listitem><para>Choose the VM that you want to migrate.</para></listitem>
+ <listitem><para>Click the Migrate Instance button <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/migrate-instance.png" />
+ </imageobject>
+ <textobject><phrase>Migrateinstance.png: button to migrate an instance</phrase></textobject>
+ </inlinemediaobject>
+ </para></listitem>
+ <listitem><para>From the list of hosts, choose the one to which you want to move the VM.</para></listitem>
+ <listitem><para>Click OK.</para></listitem>
+ </orderedlist>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/max-result-page-returned.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/max-result-page-returned.xml b/docs/en-US/max-result-page-returned.xml
index 3c12415..fdbf639 100644
--- a/docs/en-US/max-result-page-returned.xml
+++ b/docs/en-US/max-result-page-returned.xml
@@ -22,17 +22,17 @@
under the License.
-->
- <section id="max-result-page-returned">
- <title>Maximum Result Pages Returned</title>
- <para>
- For each cloud, there is a default upper limit on the number of results that any API command will return in a single page. This is to help prevent overloading the cloud servers and prevent DOS attacks. For example, if the page size limit is 500 and a command returns 10,000 results, the command will return 20 pages.
- </para>
- <para>The default page size limit can be different for each cloud. It is set in the global configuration parameter default.page.size. If your cloud has many users with lots of VMs, you might need to increase the value of this parameter. At the same time, be careful not to set it so high that your site can be taken down by an enormous return from an API call. For more information about how to set global configuration parameters, see "Describe Your Deployment" in the Installation Guide.</para>
- <para>To decrease the page size limit for an individual API command, override the global setting with the page and pagesize parameters, which are available in any list* command (listCapabilities, listDiskOfferings, etc.).</para>
- <itemizedlist>
- <listitem><para>Both parameters must be specified together.</para></listitem>
- <listitem><para>The value of the pagesize parameter must be smaller than the value of default.page.size. That is, you can not increase the number of possible items in a result page, only decrease it.</para></listitem>
- </itemizedlist>
- <para>For syntax information on the list* commands, see the API Reference.</para>
- </section>
+ <section id="max-result-page-returned">
+ <title>Maximum Result Pages Returned</title>
+ <para>
+ For each cloud, there is a default upper limit on the number of results that any API command will return in a single page. This is to help prevent overloading the cloud servers and prevent DOS attacks. For example, if the page size limit is 500 and a command returns 10,000 results, the command will return 20 pages.
+ </para>
+ <para>The default page size limit can be different for each cloud. It is set in the global configuration parameter default.page.size. If your cloud has many users with lots of VMs, you might need to increase the value of this parameter. At the same time, be careful not to set it so high that your site can be taken down by an enormous return from an API call. For more information about how to set global configuration parameters, see "Describe Your Deployment" in the Installation Guide.</para>
+ <para>To decrease the page size limit for an individual API command, override the global setting with the page and pagesize parameters, which are available in any list* command (listCapabilities, listDiskOfferings, etc.).</para>
+ <itemizedlist>
+ <listitem><para>Both parameters must be specified together.</para></listitem>
+ <listitem><para>The value of the pagesize parameter must be smaller than the value of default.page.size. That is, you can not increase the number of possible items in a result page, only decrease it.</para></listitem>
+ </itemizedlist>
+ <para>For syntax information on the list* commands, see the API Reference.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/migrate-datadisk-volume-new-storage-pool.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/migrate-datadisk-volume-new-storage-pool.xml b/docs/en-US/migrate-datadisk-volume-new-storage-pool.xml
index 0d545ba..552fb31 100644
--- a/docs/en-US/migrate-datadisk-volume-new-storage-pool.xml
+++ b/docs/en-US/migrate-datadisk-volume-new-storage-pool.xml
@@ -23,13 +23,13 @@
-->
<section id="migrate-datadisk-volume-new-storage-pool">
- <title>Migrating a Data Disk Volume to a New Storage Pool</title>
- <orderedlist>
- <listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
- <listitem><para>Detach the data disk from the VM. See Detaching and Moving Volumes <xref linkend="detach-move-volumes"/> (but skip the “reattach” step at the end. You will do that after migrating to new storage).</para></listitem>
- <listitem><para>Call the &PRODUCT; API command migrateVolume and pass in the volume ID and the ID of any storage pool in the zone.</para></listitem>
- <listitem><para>Watch for the volume status to change to Migrating, then back to Ready.</para></listitem>
- <listitem><para>Attach the volume to any desired VM running in the same cluster as the new storage server. See Attaching a Volume <xref linkend="attaching-volume"/> </para></listitem>
- </orderedlist>
- </section>
+ <title>Migrating a Data Disk Volume to a New Storage Pool</title>
+ <orderedlist>
+ <listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
+ <listitem><para>Detach the data disk from the VM. See Detaching and Moving Volumes <xref linkend="detach-move-volumes"/> (but skip the “reattach” step at the end. You will do that after migrating to new storage).</para></listitem>
+ <listitem><para>Call the &PRODUCT; API command migrateVolume and pass in the volume ID and the ID of any storage pool in the zone.</para></listitem>
+ <listitem><para>Watch for the volume status to change to Migrating, then back to Ready.</para></listitem>
+ <listitem><para>Attach the volume to any desired VM running in the same cluster as the new storage server. See Attaching a Volume <xref linkend="attaching-volume"/> </para></listitem>
+ </orderedlist>
+ </section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/dcfa5a50/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml b/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml
index 0ce06b0..67fe2f5 100644
--- a/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml
+++ b/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml
@@ -23,15 +23,15 @@
-->
<section id="migrate-vm-rootvolume-volume-new-storage-pool">
- <title>Migrating a VM Root Volume to a New Storage Pool</title>
- <para>When migrating the root disk volume, the VM must first be stopped, and users can not access the VM. After migration is complete, the VM can be restarted.</para>
- <orderedlist>
- <listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
- <listitem><para>Detach the data disk from the VM. See Detaching and Moving Volumes <xref linkend="detach-move-volumes"/> (but skip the “reattach” step at the end. You will do that after migrating to new storage).</para></listitem>
- <listitem><para>Stop the VM.</para></listitem>
- <listitem><para>Call the &PRODUCT; API command migrateVirtualMachine with the ID of the VM to migrate and the IDs of a destination host and destination storage pool in the same zone.</para></listitem>
- <listitem><para>Watch for the VM status to change to Migrating, then back to Stopped.</para></listitem>
- <listitem><para>Restart the VM.</para></listitem>
- </orderedlist>
- </section>
+ <title>Migrating a VM Root Volume to a New Storage Pool</title>
+ <para>When migrating the root disk volume, the VM must first be stopped, and users can not access the VM. After migration is complete, the VM can be restarted.</para>
+ <orderedlist>
+ <listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
+ <listitem><para>Detach the data disk from the VM. See Detaching and Moving Volumes <xref linkend="detach-move-volumes"/> (but skip the “reattach” step at the end. You will do that after migrating to new storage).</para></listitem>
+ <listitem><para>Stop the VM.</para></listitem>
+ <listitem><para>Call the &PRODUCT; API command migrateVirtualMachine with the ID of the VM to migrate and the IDs of a destination host and destination storage pool in the same zone.</para></listitem>
+ <listitem><para>Watch for the VM status to change to Migrating, then back to Stopped.</para></listitem>
+ <listitem><para>Restart the VM.</para></listitem>
+ </orderedlist>
+ </section>