etan39
/
cloudstack
mirror of https://github.com/apache/cloudstack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Patch from Joe Brockmeier for docs starting with i, j, l, m

This commit is contained in:
Chip Childers 2012-08-08 09:26:11 -04:00
parent f0823a2f08
commit 562cace168
43 changed files with 1088 additions and 296 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/en-US/import-ami.xml
View File

@ -1,11 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="import-ami">
<title>Importing Amazon Machine Images</title>
<para>The following procedures describe how to import an Amazon Machine Image (AMI) into CloudPlatform when using the XenServer hypervisor.</para>
<para>The following procedures describe how to import an Amazon Machine Image (AMI) into &PRODUCT; when using the XenServer hypervisor.</para>
<para>Assume you have an AMI file and this file is called CentOS_6.2_x64. Assume further that you are working on a CentOS host. If the AMI is a Fedora image, you need to be working on a Fedora host initially.</para>
<para>You need to have a XenServer host with a file-based storage repository (either a local ext3 SR or an NFS SR) to convert to a VHD once the image file has been customized on the Centos/Fedora host.</para>
<note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
@ -16,7 +35,7 @@
<listitem><para>Install the kernel-xen package into the image. This downloads the PV kernel and ramdisk to the image.</para><programlisting># yum -c /mnt/loop/centos54/etc/yum.conf --installroot=/mnt/loop/centos62/ -y install kernel-xen</programlisting></listitem>
<listitem><para>Create a grub entry in /boot/grub/grub.conf.</para><programlisting># mkdir -p /mnt/loop/centos62/boot/grub
# touch /mnt/loop/centos62/boot/grub/grub.conf
# echo "" > /mnt/loop/centos62/boot/grub/grub.conf
# echo "" &gt; /mnt/loop/centos62/boot/grub/grub.conf
</programlisting></listitem>
<listitem><para>Determine the name of the PV kernel that has been installed into the image.</para>
<programlisting># cd /mnt/loop/centos62
@ -69,7 +88,7 @@ passwd: all authentication tokens updated successfully.
PermitRootLogin yes
PasswordAuthentication yes
</programlisting></listitem>
<listitem><para>If you need the template to be enabled to reset passwords from the CloudPlatform UI or API,
<listitem><para>If you need the template to be enabled to reset passwords from the &PRODUCT; UI or API,
install the password change script into the image at this point. See
<xref linkend="add-password-management-to-templates"/>.</para></listitem>
<listitem><para>Unmount and delete loopback mount.</para><programlisting># umount /mnt/loop/centos54

21
docs/en-US/increase-management-server-max-memory.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="increase-management-server-max-memory">
<title>Increase Management Server Maximum Memory</title>
<para>If the Management Server is subject to high demand, the default maximum JVM memory allocation can be insufficient. To increase the memory:</para>

23
docs/en-US/incremental-snapshots-backup.xml
View File

@ -1,12 +1,31 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="incremental-snapshots-backup">
<title>Incremental Snapshots and Backup </title>
<para>Snapshots are created on primary storage where a disk resides. After a snapshot is created, it is immediately backed up to secondary storage and removed from primary storage for optimal utilization of space on primary storage.</para>
<para>CloudPlatform does incremental backups for some hypervisors. When incremental backups are supported, every N backup is a full backup.</para>
<para>&PRODUCT; does incremental backups for some hypervisors. When incremental backups are supported, every N backup is a full backup.</para>
<informaltable>
<tgroup cols="4" align="left" colsep="1" rowsep="1">

23
docs/en-US/initial-setup-of-external-firewalls-loadbalancers.xml
View File

@ -1,11 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="initial-setup-of-external-firewalls-loadbalancer">
<title>Initial Setup of External Firewalls and Load Balancers</title>
<para>When the first VM is created for a new account, CloudPlatform programs the external firewall and load balancer to work with the VM. The following objects are created on the firewall:</para>
<para>When the first VM is created for a new account, &PRODUCT; programs the external firewall and load balancer to work with the VM. The following objects are created on the firewall:</para>
<itemizedlist>
<listitem><para>A new logical interface to connect to the account's private VLAN. The interface IP is always the first IP of the account's private subnet (e.g. 10.1.1.1). </para></listitem>
<listitem><para>A source NAT rule that forwards all outgoing traffic from the account's private VLAN to the public Internet, using the account's public IP address as the source address</para></listitem>

23
docs/en-US/initialize-and-test.xml
View File

@ -1,9 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="initialize-and-test">
<title>Initialize and Test</title>
<para>TODO</para>
</section>
</section>

26
docs/en-US/install-database-on-management-server-node.xml
View File

@ -1,14 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE book 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="install-database-on-management-server-node">
<title>Install the Database on the Management Server Node</title>
<para>This section describes how to install MySQL on the same machine with the Management Server.
This technique is intended for a simple deployment that has a single Management Server node.
If you have a multi-node Management Server deployment, you will typically use a separate node for MySQL.
See <xref linkend="install-database-on-separate-node" />.
<para>This section describes how to install MySQL on the same machine with the Management Server. This technique is intended for a simple deployment that has a single Management Server node. If you have a multi-node Management Server deployment, you will typically use a separate node for MySQL. See <xref linkend="install-database-on-separate-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>

23
docs/en-US/install-database-on-separate-node.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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.
@ -83,4 +102,4 @@ mysql> exit
<para>You should see the message “Management Server setup is done.”</para>
</listitem>
</orderedlist>
</section>
</section>

28
docs/en-US/install-management-server-multi-nodes.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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.
@ -11,8 +30,9 @@
<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><ulink url="https://www.citrix.com/English/ss/downloads/">https://www.citrix.com/English/ss/downloads/</ulink></para>
<para>You will need a <ulink url="http://www.citrix.com/lang/English/publicindex.asp?destURL=%2FEnglish%2FmyCitrix%2Findex.asp%3F">MyCitrix account</ulink>.</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>
@ -51,4 +71,4 @@
<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>
</section>

35
docs/en-US/install-management-server.xml
View File

@ -1,20 +1,37 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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>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>
<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><ulink url="https://www.citrix.com/English/ss/downloads/">https://www.citrix.com/English/ss/downloads/</ulink></para>
<para>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><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>

21
docs/en-US/installation-complete.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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>

113
docs/en-US/installation-steps-overview.xml
View File

@ -1,13 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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>
<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>
@ -15,50 +32,50 @@
<listitem><para>Storage Setup</para></listitem>
<listitem><para>Best Practices</para></listitem>
</itemizedlist>
<orderedlist>
<listitem>
<para>
<emphasis role="bold">Prepare</emphasis>
</para>
<para>
1. Make sure you have the required hardware ready
</para>
<para>
2. (Optional) Fill out the preparation checklists
</para>
<para>
<emphasis role="bold">Install the &PRODUCT; software</emphasis>
</para>
<para>
3. Install the Management Server (choose single-node or multi-node)
</para>
<para>
4. Log in to the UI
</para>
<para>
<emphasis role="bold">Provision your cloud infrastructure</emphasis>
</para>
<para>
5. Add a zone. Includes the first pod, cluster, and host
</para>
<para>
6. Add more pods
</para>
<para>
7. Add more clusters
</para>
<para>
8. Add more hosts
</para>
<para>
9. Add more primary storage
</para>
<para>
10. Add more secondary storage
</para>
<para>
<emphasis role="bold">Try using the cloud</emphasis>
</para>
<para>
11. Initialization and testing
</para>
</section>
<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>
</section>

21
docs/en-US/installation.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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.
-->
<chapter id="installation">
<title>Installation</title>
<xi:include href="who-should-read-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

21
docs/en-US/installation_overview.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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.
-->
<chapter id="installation_overview">
<title>Installation Overview</title>
<xi:include href="cloudstack_whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

139
docs/en-US/installation_steps_overview.xml
View File

@ -1,60 +1,81 @@
<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>
<para>
<emphasis role="bold">Prepare</emphasis>
</para>
<para>
1. Make sure you have the required hardware ready
</para>
<para>
2. (Optional) Fill out the preparation checklists
</para>
<para>
<emphasis role="bold">Install the CloudStack software</emphasis>
</para>
<para>
3. Install the CloudStack Management Server (single-node, or multi-node)
</para>
<para>
4. Log in to the CloudStack UI
</para>
<para>
<emphasis role="bold">Provision your cloud infrastructure</emphasis>
</para>
<para>
5. Add a zone. Includes the first pod, cluster, and host
</para>
<para>
6. Add more pods
</para>
<para>
7. Add more clusters
</para>
<para>
8. Add more hosts
</para>
<para>
9. Add more primary storage
</para>
<para>
10. Add more secondary storage
</para>
<para>
<emphasis role="bold">Try using the cloud</emphasis>
</para>
<para>
11. Initialization and testing
</para>
</section>
<?xml version='1.0' encoding='utf-8' ?>
<!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="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>
</section>

21
docs/en-US/introduction.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="introduction">
<title>Introduction</title>
<xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

21
docs/en-US/ip-forwarding-firewalling.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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-forwarding-firewalling">
<title>IP Forwarding and Firewalling</title>
<para>By default, all incoming traffic to the public IP address is rejected. All outgoing traffic from the guests is translated via NAT to the public IP address and is allowed.</para>

23
docs/en-US/ip-load-balancing.xml
View File

@ -1,11 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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-load-balancing">
<title>IP Load Balancing</title>
<para>The user may choose to associate the same public IP for multiple guests. CloudPlatform implements a TCP-level load balancer with the following policies.</para>
<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>

49
docs/en-US/ipaddress-usage-record-format.xml
View File

@ -1,19 +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>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>
</section>

23
docs/en-US/isolated-networks.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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>
@ -11,6 +30,4 @@
<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>
</section>

26
docs/en-US/job-status.xml
View File

@ -1,3 +1,27 @@
<?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>
@ -6,5 +30,5 @@
<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>
</section>

38
docs/en-US/linux-installation.xml
View File

@ -1,35 +1,47 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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://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>
<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><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>
<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>

27
docs/en-US/load-balancer-rules.xml
View File

@ -1,10 +1,29 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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 CloudPlatform 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 CloudPlatform 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>
</section>
<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>
</section>

49
docs/en-US/loadbalancer-policy-port-forwarding-rule-usage-record-format.xml
View File

@ -1,17 +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>
<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>
</section>

21
docs/en-US/log-in-root-admin.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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>

21
docs/en-US/log-in.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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>

21
docs/en-US/long-running-job-events.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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>

27
docs/en-US/maintain-hypervisors-on-hosts.xml
View File

@ -1,11 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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. CloudPlatform 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>
<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 CloudPlatform Knowledge Base</ulink></para>
</section>
<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>

23
docs/en-US/maintenance-mode-for-primary-storage.xml
View File

@ -1,9 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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 CloudPlatform 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>
<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>

32
docs/en-US/making-api-request.xml
View File

@ -1,15 +1,33 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="making-api-request">
<title>Making API Requests</title>
<para>
All CloudStack API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS:
<para>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>CloudStack API URL: This is the web services API entry point(for example, http://www.cloud.com:8080/client/api)</para></listitem>
<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>
@ -27,9 +45,9 @@
7. &amp;apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXqjB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ
8. &amp;signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D
</programlisting>
<para>The first line is the CloudStack 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 CloudStack 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 CloudStack API documentation. Each parameter field-value pair (field=value) is preceded by an ampersand character (&amp;).</para>
<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 (&amp;).</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>

21
docs/en-US/manage-cloud.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="manage-cloud">
<title>Managing the Cloud</title>
<para><xref linkend="change-database-config" />vCenter Maintenance Mode</para>

21
docs/en-US/management-server-install-flow.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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" />

31
docs/en-US/management-server-installation-overview.xml
View File

@ -1,8 +1,30 @@
<section id="management-server-installation-overview">
<?xml version='1.0' encoding='utf-8' ?>
<!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="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>
<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>
@ -21,4 +43,3 @@
<listitem><para>Prepare the System VM Template</para></listitem>
</orderedlist>
</section>

61
docs/en-US/management-server-overview.xml
View File

@ -1,57 +1,58 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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>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>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>The machine must meet the system requirements described in System Requirements.
</para>
<para>
The Management Server:
<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>
<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>
<para>Provides the APIs for &PRODUCT;.</para>
</listitem>
<listitem>
<para>
Manages the assignment of guest VMs to particular hosts.
</para>
<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>
<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>
<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>
<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>
<para>Provides a single point of configuration for the cloud.</para>
</listitem>
</itemizedlist>
</section>

21
docs/en-US/management_server_multi_node_install.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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.
-->
<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" />

67
docs/en-US/management_server_overview.xml
View File

@ -1,52 +1,53 @@
<?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="management_server_overview">
<title>Management Server Overview</title>
<para>
The Management Server is the CloudStack 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 CloudStack 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>
<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>
<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 CloudStack platform.
</para>
<para>Provides the APIs for the &PRODUCT; platform.</para>
</listitem>
<listitem>
<para>
Manages the assignment of guest VMs to particular hosts.
</para>
<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>
<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>
<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>
<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>
<para>Provides a single point of configuration for the cloud.</para>
</listitem>
</itemizedlist>
</section>

24
docs/en-US/manual-live-migration.xml
View File

@ -1,3 +1,27 @@
<?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="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>

24
docs/en-US/max-result-page-returned.xml
View File

@ -1,3 +1,27 @@
<?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="max-result-page-returned">
<title>Maximum Result Pages Returned</title>
<para>

25
docs/en-US/migrate-datadisk-volume-new-storage-pool.xml
View File

@ -1,14 +1,33 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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 CloudPlatform UI as a user or admin.</para></listitem>
<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 CloudPlatform API command migrateVolume and pass in the volume ID and the ID of any storage pool in the zone.</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>

25
docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml
View File

@ -1,16 +1,35 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="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 CloudPlatform UI as a user or admin.</para></listitem>
<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 CloudPlatform 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>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>

30
docs/en-US/minimum-system-requirements.xml
View File

@ -1,17 +1,32 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="minimum-system-requirements">
<title>Minimum System Requirements</title>
<section id="management-server-system-requirements">
<title>Management Server, Database, and Storage System Requirements</title>
<para>
The machines that will run the Management Server and MySQL database must meet the following requirements.
The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS.
The Management Server may be placed on a virtual machine.
</para>
<para>The machines that will run the Management Server and MySQL database must meet the following requirements. The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS. The Management Server may be placed on a virtual machine.</para>
<itemizedlist>
<listitem><para>Operating system:</para>
<itemizedlist>
@ -51,8 +66,7 @@
<listitem><para>Oracle VM (OVM) Installation and Configuration</para></listitem>
</itemizedlist>
<warning>
<para>
Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with CloudStack. For example, the requirements for XenServer are listed under Citrix XenServer Installation.
<para>Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with CloudStack. For example, the requirements for XenServer are listed under Citrix XenServer Installation.
</para>
</warning>
</section>

21
docs/en-US/modify-delete-service-offerings.xml
View File

@ -1,8 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="modify-delete-service-offerings">
<title>Modifying or Deleting a Service Offering</title>
<para>Service offerings cannot be changed once created. This applies to both compute offerings and disk offerings.</para>

24
docs/en-US/multi_node_overview.xml
View File

@ -1,3 +1,27 @@
<?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="multi_node_installation_overview">
<title>Management Server Multi-Node Installation Overview</title>
<para>

23
docs/en-US/multiple-system-vm-vmware.xml
View File

@ -1,9 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!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="multiple-system-vm-vmware">
<title>Multiple System VM Support for VMware</title>
<para>Every CloudPlatform zone has single System VM for template processing tasks such as downloading templates, uploading templates, and uploading ISOs. In a zone where VMware is being used, additional System VMs can be launched to process VMware-specific tasks such as taking snapshots and creating private templates. The CloudPlatform management server launches additional System VMs for VMware-specific tasks as the load increases. The management server monitors and weights all commands sent to these System VMs and performs dynamic load balancing and scaling-up of more System VMs.</para>
<para>Every &PRODUCT; zone has single System VM for template processing tasks such as downloading templates, uploading templates, and uploading ISOs. In a zone where VMware is being used, additional System VMs can be launched to process VMware-specific tasks such as taking snapshots and creating private templates. The &PRODUCT; management server launches additional System VMs for VMware-specific tasks as the load increases. The management server monitors and weights all commands sent to these System VMs and performs dynamic load balancing and scaling-up of more System VMs.</para>
</section>