apache/cloudstack
1
0
Fork 0
mirror of https://github.com/apache/cloudstack.git synced 2025-11-03 04:12:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into vpc

Browse Source
This commit is contained in:
Alena Prokharchyk 2012-07-16 15:43:16 -07:00
commit 7c2b123d94
352 changed files with 11250 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -18,9 +18,8 @@ http://cloudstack.org/download.html
* XCP
## Mailing lists
[Announcement Mailing List](https://lists.sourceforge.net/lists/listinfo/cloudstack-announce)
[Development Mailing List](https://lists.sourceforge.net/mailman/listinfo/cloudstack-devel)
[Users Mailing list](https://lists.sourceforge.net/mailman/listinfo/cloudstack-users)
[Commits mailing list](https://lists.sourceforge.net/mailman/listinfo/cloudstack-commits)
[Development Mailing List](mailto:cloudstack-dev-subscribe@incubator.apache.org)
[Users Mailing list](mailto:cloudstack-users-subscribe@incubator.apache.org)
[Commits mailing list](mailto:cloudstack-commits-subscribe@incubator.apache.org)

12
build/build-marvin.xml
View File

@ -56,4 +56,16 @@
</exec>
<echo message="distributable tarball at: ${marvin.dist.dir}/Marvin-*.tar.gz"/>
</target>
<target name="install-marvin" depends="package-marvin" description="installs marvin on the local machine">
<echo message="Uninstalling Marvin" />
<exec dir="${marvin.dist.dir}" executable="pip">
<arg line="uninstall -y marvin"/>
</exec>
<echo message="Installing Marvin" />
<exec dir="${marvin.dist.dir}" executable="pip">
<arg value="install" />
<arg value="Marvin-0.1.0.tar.gz" />
</exec>
</target>
</project>

27
build/build-tests.xml
View File

@ -49,6 +49,10 @@
<property name="agent-simulator.jar" value="cloud-agent-simulator.jar" />
<property name="testclient.jar" value="cloud-test.jar" />
<property name="simulator.setup.dir" value="${base.dir}/setup/db/" />
<property name="marvin.sandbox.dir" value="${base.dir}/tools/marvin/marvin/sandbox/" />
<property name="marvin.config" value="${base.dir}/tools/marvin/marvin/sandbox/demo/simulator/simulator.cfg" />
<property name="marvin.config.abspath" location="${marvin.config}" />
<!-- =================== Agent Simulator ==================== -->
<path id="agent-simulator.classpath">
@ -98,12 +102,33 @@
<copy todir="${agent-simulator.dist.dir}/conf">
<fileset dir="${agent.dir}/conf">
<include name="log4j-cloud.xml" />
<include name="simulator.properties" />
</fileset>
</copy>
</target>
<!-- =================== Agent Simulator ==================== -->
<!-- Run Simulator Tests -->
<target name="setup-simulator" depends="clean-all">
<mkdir dir="${simulator.setup.dir}/override">
</mkdir>
<copy overwrite="true" file="${simulator.setup.dir}/templates.simulator.sql" tofile="${simulator.setup.dir}/override/templates.sql" />
<mkdir dir="${build.dir}/override">
</mkdir>
<copy overwrite="true" file="${build.dir}/replace.properties" tofile="${build.dir}/override/replace.properties" />
<!-- Replace the COMPONENT-SPEC for components-simulator.xml -->
<copy overwrite="true" file="${build.dir}/simulator.properties" tofile="${build.dir}/override/replace.properties" />
</target>
<target name="run-simulator" depends="setup-simulator, build-all-with-simulator, deploy-server, deploydb-simulator, debug">
</target>
<target name="run-marvin" depends="install-marvin">
<exec dir="${marvin.sandbox.dir}/" executable="bash">
<arg line="run-marvin.sh -d localhost -m localhost -c ${marvin.config.abspath}" />
</exec>
</target>
<!-- -->
<!-- =================== QA Testing Client ==================== -->
<target name="-init-test" depends="-init">

19
build/build-usage.xml
View File

@ -29,7 +29,9 @@
<import file="${oss.build.dir}/build-cloud.xml" optional="false"/>
<property name="usage.dir" location="${base.dir}/usage" />
<property name="usage.dist.dir" location="${dist.dir}/usage" />
<!-- ToDo: get actual PID -->
<property name="pid" value="4567"/>
<!-- ===================== Usage.Jar ===================== -->
<path id="usage.classpath">
<path refid="deps.classpath" />
@ -55,4 +57,19 @@
</copy>
</target>
<target name="run-usage" depends="build-usage">
<java classname="com.cloud.usage.UsageServer" fork="true">
<classpath refid="usage.classpath"/>
<jvmarg value="-Dpid=${pid}"/>
</java>
</target>
<target name="debug-usage" depends="build-usage">
<java classname="com.cloud.usage.UsageServer" fork="true">
<classpath refid="usage.classpath"/>
<jvmarg value="-Dpid=${pid}"/>
<jvmarg value="-Xrunjdwp:transport=dt_socket,address=8788,server=y,suspend=n"/>
</java>
</target>
</project>

11
build/simulator.properties Normal file
View File

@ -0,0 +1,11 @@
DBUSER=cloud
DBPW=cloud
MSLOG=vmops.log
APISERVERLOG=api.log
DBHOST=localhost
DBROOTPW=
AGENTLOGDIR=logs
AGENTLOG=logs/agent.log
MSMNTDIR=/mnt
COMPONENTS-SPEC=components-simulator.xml
AWSAPILOG=awsapi.log

35
docs/configs/Author_Group/Apache/Author_Group.xml Normal file
View File

@ -0,0 +1,35 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<authorgroup>
<author>
<firstname>Apache CloudStack Project</firstname>
<surname></surname>
<affiliation>
<orgname></orgname>
<orgdiv></orgdiv>
</affiliation>
<email>cloudstack-docs@incubator.apache.org</email>
</author>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<affiliation>
<orgname>Citrix</orgname>
<orgdiv>Cloud Platform Group</orgdiv>
</affiliation>
<email>jessica.tomechak@cirix.com</email>
</author>
<author>
<firstname>Radhika</firstname>
<surname>PC</surname>
<affiliation>
<orgname>Citrix</orgname>
<orgdiv>Cloud Platform Group</orgdiv>
</affiliation>
<email>radhika.puthiyetath@citrix.com</email>
</author>
</authorgroup>

27
docs/configs/Book_Info/Main_Book_Info/Book_Info.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<bookinfo id="book-cloudstack">
<title>Technical Documentation</title>
<subtitle>Revised June 14, 2012 9:03 pm Pacific</subtitle>
<productname>Apache CloudStack</productname>
<productnumber>3.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
How to design, install, manage, customize, and troubleshoot a public or private cloud powered by CloudStack.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>

35
docs/configs/Legal_Notice/Legal_Notice.xml Normal file
View File

@ -0,0 +1,35 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files/Publican/DocBook_DTD/docbookx.dtd" [
]>
<legalnotice>
<para>
The text and illustrations in this document are licensed by the Apache CloudStack Project
under a Creative Commons Attribution–Share Alike 3.0
Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is
available at _http://creativecommons.org/licenses/by-sa/3.0/_. The
original authors of this document designate the Apache CloudStack Project
as the "Attribution Party" for
purposes of CC-BY-SA. In accordance with CC-BY-SA, if you
distribute this document or an adaptation of it, you must provide
the URL for the original version.
Specifications are subject to change without notice.
Citrix
Systems, Inc., the Citrix logo, Citrix XenServer, and Citrix XenCenter
are trademarks or registered trademarks of Citrix
Systems, Inc.
Linux® is the registered trademark of Linus Torvalds in the United
States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
MySQL® is a registered trademark of MySQL AB in the United States,
the European Union and other countries.
All other brands or products are trademarks or registered
trademarks of their respective holders.
</para>
</legalnotice>

5
docs/configs/main/README.txt Normal file
View File

@ -0,0 +1,5 @@
The publican.cfg file in this directory should point to the main book file that will build 100% of the content in the CloudStack documentation XML source files. Swap this .cfg file up to the cloudstack-docs directory to build everything.
For example, to build the English language total documentation set, which includes everything in the cloudstack-docs/en-US directory, use this publican.cfg file with a command like:
publican build --formats=html --langs=en-US

26
docs/en-US/Author_Group.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<authorgroup>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<affiliation>
<orgname>Citrix</orgname>
<orgdiv>Cloud Platform Group</orgdiv>
</affiliation>
<email>jessica.tomechak@citrix.com</email>
</author>
<author>
<firstname>Radhika</firstname>
<surname>PC</surname>
<affiliation>
<orgname>Citrix</orgname>
<orgdiv>Cloud Platform Group</orgdiv>
</affiliation>
<email>radhika.puthiyetath@citrix.com</email>
</author>
</authorgroup>

27
docs/en-US/Book_Info.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<bookinfo id="book-release-notes-3.0.4">
<title>CloudPlatform (powered by Apache CloudStack) version 3.0.4 Release Notes</title>
<subtitle>Revised June 14, 2012 5:48 pm Pacific</subtitle>
<productname>Citrix CloudPlatform 3.0.4 Powered by Apache CloudStack</productname>
<productnumber></productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Release notes for patch release of CloudPlatform to support the XenServer patch XS602E003.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>

7
docs/en-US/Common_Content/Legal_Notice.xml Normal file
View File

@ -0,0 +1,7 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files/Publican/DocBook_DTD/docbookx.dtd" [
]>
<legalnotice>
<para>© 2012 Citrix Systems, Inc. All rights reserved. Specifications are subject to change without notice. Citrix Systems, Inc., the Citrix logo, Citrix XenServer, Citrix XenCenter, and CloudPlatform are trademarks or registered trademarks of Citrix Systems, Inc. All other brands or products are trademarks or registered trademarks of their respective holders.</para>
</legalnotice>

21
docs/en-US/LDAPserver-for-user-authentication.xml Normal file
View File

@ -0,0 +1,21 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="LDAPserver-for-user-authentication">
<title>Using an LDAP Server for User Authentication</title>
<para>You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate CloudPlatform end-users. Just map CloudPlatform accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by CloudPlatform for matching common values such as the user’s email address and name. CloudPlatform will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user..</para>
<para>To set up LDAP authentication in CloudPlatform, call the CloudPlatform API command ldapConfig and provide the following:</para>
<itemizedlist>
<listitem><para>Hostname or IP address and listening port of the LDAP server</para></listitem>
<listitem> <para>Base directory and query filter</para></listitem>
<listitem><para>Search user DN credentials, which give CloudPlatform permission to search on the LDAP server</para></listitem>
<listitem><para>SSL keystore and password, if SSL is used</para></listitem>
</itemizedlist>
<xi:include href="example-LDAP-configuration-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="search-base.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="query-filter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="search-user-bind-dn.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="SSL-keystore-path-and-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

13
docs/en-US/Preface.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<preface id="pref-cloudstack-Preface">
<title>Preface</title>
<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</xi:fallback>
</xi:include>
</preface>

27
docs/en-US/Revision_History.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<appendix id="appe-cloudstack-Revision_History">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
<revnumber>0-0</revnumber>
<date>Tue May 29 2012</date>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<email/>
</author>
<revdescription>
<simplelist>
<member>Initial creation of book by publican</member>
</simplelist>
</revdescription>
</revision>
</revhistory>
</simpara>
</appendix>

10
docs/en-US/SSL-keystore-path-and-password.xml Normal file
View File

@ -0,0 +1,10 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="SSL-keystore-path-and-password">
<title>SSL Keystore Path and Password</title>
<para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
</section>

17
docs/en-US/VPN-user-usage-record-format.xml Normal file
View File

@ -0,0 +1,17 @@
<section id="VPN-user-usage-record-format">
<title>VPN User 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 – VPN user ID</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>

9
docs/en-US/about-pods.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="about-pods">
<title>About Pods</title>
<para>TODO</para>
</section>

12
docs/en-US/about-virtual-networks.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="about-virtual-networks">
<title>About Virtual Networks</title>
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In CloudPlatform, a virtual network can be shared or isolated.</para>
<para><xref linkend="isolated-networks" />XenServer and Maintenance Mode</para>
<para><xref linkend="shared-networks" />Working with Usage</para>
<para><xref linkend="runtime-allocation-virtual-network-resources" />XenServer and Maintenance Mode</para>
</section>

15
docs/en-US/about-working-with-vms.xml Normal file
View File

@ -0,0 +1,15 @@
<section id="about-working-with-vms">
<title>About Working with Virtual Machines</title>
<para>CloudPlatform provides administrators with complete control over the lifecycle of all guest VMs executing in the cloud. CloudPlatform provides several guest management operations for end users and administrators. VMs may be stopped, started, rebooted, and destroyed.</para>
<para>Guest VMs have a name and group. VM names and groups are opaque to CloudPlatform and are available for end users to organize their VMs. Each VM can have three names for use in different contexts. Only two of these names can be controlled by the user:</para>
<itemizedlist>
<listitem><para>Instance name – a unique, immutable ID that is generated by CloudPlatform and can not be modified by the user. This name conforms to the requirements in IETF RFC 1123.</para></listitem>
<listitem><para>Display name – the name displayed in the CloudPlatform web UI. Can be set by the user. Defaults to instance name.</para></listitem>
<listitem><para>Name – host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name</para></listitem>
</itemizedlist>
<para>Guest VMs can be configured to be Highly Available (HA). An HA-enabled VM is monitored by the system. If the system detects that the VM is down, it will attempt to restart the VM, possibly on a different host. For more information, see HA-Enabled Virtual Machines on </para>
<para>Each new VM is allocated one public IP address. When the VM is started, CloudPlatform automatically creates a static NAT between this public IP address and the private IP address of the VM.</para>
<para>If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs.</para>
<para>CloudPlatform cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, CloudPlatform will restart it. To shut down an HA-enabled VM, you must go through the CloudPlatform UI or API.</para>
</section>

17
docs/en-US/accept-membership-invite.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="accept-membership-invite">
<title>Accepting a Membership Invitation</title>
<para>If you have received an invitation to join a CloudPlatform project, and you want to accept the invitation, follow these steps:</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI.</para></listitem>
<listitem><para>In the left navigation, click Projects.</para></listitem>
<listitem><para>In Select View, choose Invitations.</para></listitem>
<listitem><para>If you see the invitation listed onscreen, click the Accept button.</para> <para>Invitations listed on screen were sent to you using your CloudPlatform account name.</para></listitem>
<listitem><para>If you received an email invitation, click the Enter Token button, and provide the project ID and unique ID code (token) from the email.</para></listitem>
</orderedlist>
</section>

17
docs/en-US/accessing-vms.xml Normal file
View File

@ -0,0 +1,17 @@
<section id="accessing-vms">
<title>Accessing VMs</title>
<para>Any user can access their own virtual machines. The administrator can access all VMs running in the cloud.</para>
<para>To access a VM through the CloudPlatform UI:</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
<listitem><para>Click Instances, then click the name of a running VM.</para></listitem>
<listitem><para>Click the View Console button <inlinegraphic format="PNG" fileref="images/icon.png"/>.</para></listitem>
</orderedlist>
<para>To access a VM directly over the network:</para>
<orderedlist>
<listitem><para>The VM must have some port open to incoming traffic. For example, in a basic zone, a new VM might be assigned to a security group which allows incoming traffic. This depends on what security group you picked when creating the VM. In other cases, you can open a port by setting up a port forwarding policy. See IP Forwarding and Firewalling.</para></listitem>
<listitem><para>If a port is open but you can not access the VM using ssh, it’s possible that ssh is not already enabled on the VM. This will depend on whether ssh is enabled in the template you picked when creating the VM. Access the VM through the CloudPlatform UI and enable ssh on the machine using the commands for the VM’s operating system.</para></listitem>
<listitem><para>If the network has an external firewall device, you will need to create a firewall rule to allow access. See IP Forwarding and Firewalling.</para></listitem>
</orderedlist>
</section>

35
docs/en-US/accounts-users-domains.xml Normal file
View File

@ -0,0 +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" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="accounts-users-domains">
<title>Accounts, Users, and Domains</title>
<formalpara>
<title>Accounts</title>
<para>An account typically represents a customer of the service provider or a department in a large organization. Multiple users can exist in an account.</para>
</formalpara>
<formalpara>
<title>Domains</title>
<para>Accounts are grouped by domains. Domains usually contain multiple accounts that have some logical relationship to each other and a set of delegated administrators with some authority over the domain and its subdomains. For example, a service provider with several resellers could create a domain for each reseller.</para>
</formalpara>
<para>For each account created, the Cloud installation creates three different types of user accounts: root administrator, domain administrator, and user.</para>
<formalpara>
<title>Users</title>
<para>Users are like aliases in the account. Users in the same account are not isolated from each other, but they are isolated from users in other accounts. Most installations need not surface the notion of users; they just have one user per account. The same user cannot belong to multiple accounts.</para>
</formalpara>
<para>Username is unique in a domain across accounts in that domain. The same username can exist in other domains, including sub-domains. Domain name can repeat only if the full pathname from root is unique. For example, you can create root/d1, as well as root/foo/d1, and root/sales/d1.</para>
<para>Administrators are accounts with special privileges in the system. There may be multiple administrators in the system. Administrators can create or delete other administrators, and change the password for any user in the system.</para>
<formalpara>
<title>Domain Administrators</title>
<para>Domain administrators can perform administrative operations for users who belong to that domain. Domain administrators do not have visibility into physical servers or other domains.</para>
</formalpara>
<formalpara>
<title>Root Administrator</title>
<para>Root administrators have complete access to the system, including managing templates, service offerings, customer care administrators, and domains</para>
</formalpara>
<para>The resources belong to the account, not individual users in that account. For example,
billing, resource limits, and so on are maintained by the account, not the users. A user can
operate on any resource in the account provided the user has privileges for that operation.
The privileges are determined by the role.</para>
</section>

9
docs/en-US/accounts.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="accounts">
<xi:include href="accounts-users-domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="LDAPserver-for-user-authentication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

17
docs/en-US/acquire-new-ip-address.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="acquire-new-ip-address">
<title>Acquiring a New IP Address</title>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network where you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click Acquire New IP, and click Yes in the confirmation dialog.</para>
<para>You are prompted for confirmation because, typically, IP addresses are a limited resource. Within a few moments, the new IP address should appear with the state Allocated. You can now use the IP address in port forwarding or static NAT rules.</para>
</listitem>
</orderedlist>
</section>

25
docs/en-US/add-additional-guest-network.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-additional-guest-network">
<title>Adding an Additional Guest Network</title>
<itemizedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>Click Add guest network. Provide the following information: </para>
<itemizedlist>
<listitem><para>Name. The name of the network. This will be user-visible. </para></listitem>
<listitem><para>Description. The description of the network. This will be user-visible.</para></listitem>
<listitem><para>Network offering. If the administrator has configured multiple network offerings, select the one you want to use for this network.</para></listitem>
<listitem><para>Pod. The name of the pod this network applies to. Each pod in a basic zone is a broadcast domain, and therefore each pod has a different IP range for the guest network. The administrator must configure the IP range for each pod. </para></listitem>
<listitem><para>VLAN ID. The VLAN tag for this network.</para></listitem>
<listitem><para>Gateway. The gateway that the guests should use.</para></listitem>
<listitem><para>Netmask. The netmask in use on the subnet the guests will use.</para></listitem>
<listitem><para>Start IP/End IP. Enter the first and last IP addresses that define a range that CloudPlatform can assign to guests. We strongly recommend the use of multiple NICs. If multiple NICs are used, they may be in a different subnet. If one NIC is used, these IPs should be in the same CIDR as the pod CIDR.</para></listitem></itemizedlist></listitem>
<listitem><para>Click Create.</para></listitem>
</itemizedlist>
</section>

73
docs/en-US/add-ingress-egress-rules.xml Normal file
View File

@ -0,0 +1,73 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-ingress-egress-rules">
<title>Adding Ingress and Egress Rules to a Security Group</title>
<itemizedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>In Select view, choose Security Groups, then click the security group you want .</para></listitem>
<listitem><para>To add an ingress rule, click the Ingress Rules tab and fill out the following fields to specify what network traffic is allowed into VM instances in this security group. If no ingress rules are specified, then no traffic will be allowed in, except for responses to any traffic that has been allowed out through an egress rule.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the source of the
traffic will be defined by IP address (CIDR) or an existing security group
in a CloudPlatform account (Account). Choose Account if you want to allow
incoming traffic from all VMs in another security group</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The networking protocol that sources will use to
send traffic to the security group. TCP and UDP are typically used for data
exchange and end-user communications. ICMP is typically used to send error
messages or network monitoring data.</para></listitem>
<listitem><para><emphasis role="bold">Start Port, End Port</emphasis>. (TCP, UDP only) A range of listening
ports that are the destination for the incoming traffic. If you are opening
a single port, use the same number in both fields.</para></listitem>
<listitem><para><emphasis role="bold">ICMP Type, ICMP Code</emphasis>. (ICMP only) The type of message and
error code that will be accepted.</para></listitem>
<listitem><para><emphasis role="bold">CIDR</emphasis>. (Add by CIDR only) To accept only traffic from IP
addresses within a particular address block, enter a CIDR or a
comma-separated list of CIDRs. The CIDR is the base IP address of the
incoming traffic. For example, 192.168.0.0/22. To allow all CIDRs, set to
0.0.0.0/0.</para></listitem>
<listitem><para><emphasis role="bold">Account, Security Group</emphasis>. (Add by Account only) To accept only
traffic from another security group, enter the CloudPlatform account and
name of a security group that has already been defined in that account. To
allow traffic between VMs within the security group you are editing now,
enter the same name you used in step 7.</para></listitem>
</itemizedlist>
<para>The following example allows inbound HTTP access from anywhere:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/http-access.png" />
</imageobject>
<textobject><phrase>httpaccess.png: allows inbound HTTP access from anywhere</phrase></textobject>
</mediaobject>
</listitem>
<listitem><para>To add an egress rule, click the Egress Rules tab and fill out the following fields to specify what type of traffic is allowed to be sent out of VM instances in this security group. If no egress rules are specified, then all traffic will be allowed out. Once egress rules are specified, the following types of traffic are allowed out: traffic specified in egress rules; queries to DNS and DHCP servers; and responses to any traffic that has been allowed in through an ingress rule</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the destination of the
traffic will be defined by IP address (CIDR) or an existing security group
in a CloudPlatform account (Account). Choose Account if you want to allow
outgoing traffic to all VMs in another security group.</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The networking protocol that VMs will use to send
outgoing traffic. TCP and UDP are typically used for data exchange and
end-user communications. ICMP is typically used to send error messages or
network monitoring data.</para></listitem>
<listitem><para><emphasis role="bold">Start Port, End Port</emphasis>. (TCP, UDP only) A range of listening
ports that are the destination for the outgoing traffic. If you are opening
a single port, use the same number in both fields.</para></listitem>
<listitem><para><emphasis role="bold">ICMP Type, ICMP Code</emphasis>. (ICMP only) The type of message and
error code that will be sent</para></listitem>
<listitem><para><emphasis role="bold">CIDR</emphasis>. (Add by CIDR only) To send traffic only to IP addresses
within a particular address block, enter a CIDR or a comma-separated list of
CIDRs. The CIDR is the base IP address of the destination. For example,
192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0.</para></listitem>
<listitem><para><emphasis role="bold">Account, Security Group</emphasis>. (Add by Account only) To allow
traffic to be sent to another security group, enter the CloudPlatform
account and name of a security group that has already been defined in that
account. To allow traffic between VMs within the security group you are
editing now, enter its name.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</itemizedlist>
</section>

74
docs/en-US/add-iso.xml Normal file
View File

@ -0,0 +1,74 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-iso">
<title>Adding an ISO</title>
<para>To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template.</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>In Select View, choose ISOs.</para></listitem>
<listitem><para>Click Add ISO.</para></listitem>
<listitem><para>In the Add ISO screen, provide the following:</para>
<itemizedlist>
<listitem><para>Name. Short name for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>Description. Display test for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>URL. The URL that hosts the ISO image. The Management Server must be able to access this location via HTTP. If needed you can place the ISO image directly on the Management Server</para></listitem>
<listitem><para>Zone. Choose the zone where you want the ISO to be available, or All Zones to make it available throughout CloudPlatform.</para></listitem>
<listitem><para>Bootable. Whether or not a guest could boot off this ISO image. For example, a CentOS ISO is bootable, a Microsoft Office ISO is not bootable.</para></listitem>
<listitem><para>OS Type. This helps CloudPlatform and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following.</para>
<itemizedlist>
<listitem><para>If the operating system of your desired ISO image is listed, choose it.</para></listitem>
<listitem><para>If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other.</para></listitem>
<listitem><para>(XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit)</para></listitem>
<listitem><para>(KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are:</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Fedora 13</para></entry>
<entry><para>Fedora 12</para></entry>
<entry><para>Fedora 11</para></entry>
</row>
<row>
<entry><para>Fedora 10</para></entry>
<entry><para>Fedora 9</para></entry>
<entry><para>Other PV</para></entry>
</row>
<row>
<entry><para>Debian GNU/Linux</para></entry>
<entry><para>CentOS 5.3</para></entry>
<entry><para>CentOS 5.4</para></entry>
</row>
<row>
<entry><para>CentOS 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 5.3</para></entry>
<entry><para>Red Hat Enterprise Linux 5.4</para></entry>
</row>
<row>
<entry><para>Red Hat Enterprise Linux 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 6</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable></listitem>
</itemizedlist>
<note><para>Note: It is not recommended to choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually not work. In these cases, choose Other.</para></note>
</listitem>
<listitem><para>Extractable. Choose Yes if the ISO should be available for extraction.</para></listitem>
<listitem><para>Public. Choose Yes if this ISO should be available to other users.</para></listitem>
<listitem><para>Featured. Choose Yes if you would like this ISO to be more prominent for users to select. The ISO will appear in the Featured ISOs list. Only an administrator can make an ISO Featured.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click OK.</para>
<para>The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage.</para>
</listitem>
<listitem><para><emphasis role="bold">Important</emphasis>: Wait for the ISO to finish downloading. If you
move on to the next task and try to use the ISO right away, it will appear to fail.
The entire ISO must be available before CloudPlatform can work with it</para></listitem>
</orderedlist>
</section>

27
docs/en-US/add-load-balancer-rule.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-load-balancer-rule">
<title>Adding a Load Balancer Rule</title>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network where you want to load balance the traffic.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click the IP address for which you want to create the rule, then click the Configuration tab.</para></listitem>
<listitem><para>In the Load Balancing node of the diagram, click View All.</para></listitem>
<listitem><para>Fill in the following:</para>
<itemizedlist>
<listitem><para>Name. A name for the load balancer rule.</para></listitem>
<listitem><para>Public Port. The port receiving incoming traffic to be balanced.</para></listitem>
<listitem><para>Private Port. The port that the VMs will use to receive the traffic.</para></listitem>
<listitem><para>Algorithm. Choose the load balancing algorithm you want CloudPlatform to use. CloudPlatform supports a variety of well-known algorithms. If you are not familiar with these choices, you will find plenty of information about them on the Internet.</para></listitem>
<listitem><para>Stickiness. (Optional) Click Configure and choose the algorithm for the stickiness policy. See Sticky Session Policies for Load Balancer Rules.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add VMs, then select two or more VMs that will divide the load of incoming traffic, and click Apply.</para>
<para>The new load balancer rule appears in the list. You can repeat these steps to add more load balancer rules for this IP address.</para>
</listitem>
</orderedlist>
</section>

14
docs/en-US/add-members-to-projects.xml Normal file
View File

@ -0,0 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-members-to-projects">
<title>Adding Members to a Project</title>
<para>New members can be added to a project by the project’s administrator, the domain administrator of the domain where the project resides or any parent domain, or the CloudPlatform root administrator. There are two ways to add members in CloudPlatform, but only one way is enabled at a time:</para>
<itemizedlist>
<listitem><para>If invitations have been enabled, you can send invitations to new members.</para></listitem>
<listitem><para>If invitations are not enabled, you can add members directly through the UI.</para></listitem>
</itemizedlist>
</section>

14
docs/en-US/add-password-management-to-templates.xml Normal file
View File

@ -0,0 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-password-management-to-templates">
<title>Adding Password Management to Your Templates</title>
<para>CloudPlatform provides an optional password reset feature that allows users to set a temporary admin or root password as well as reset the existing admin or root password from the CloudPlatform UI.</para>
<para>To enable the Reset Password feature, you will need to download an additional script to patch your template. When you later upload the template into CloudPlatform, you can specify whether reset admin/root password feature should be enabled for this template.</para>
<para>The password management feature works always resets the account password on instance boot. The script does an HTTP call to the virtual router to retrieve the account password that should be set. As long as the virtual router is accessible the guest will have access to the account password that should be used. When the user requests a password reset the management server generates and sends a new password to the virtual router for the account. Thus an instance reboot is necessary to effect any password changes.</para>
<para>If the script is unable to contact the virtual router during instance boot it will not set the password but boot will continue normally.</para>
<xi:include href="linux-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="windows-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

18
docs/en-US/add-projects-members-from-ui.xml Normal file
View File

@ -0,0 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-projects-members-from-ui">
<title>Adding Project Members From the UI</title>
<para>The steps below tell how to add a new member to a project if the invitations feature is not enabled in the cloud. If the invitations feature is enabled cloud,as described in <xref linkend="set-up-invitations"/>, use the procedure in <xref linkend="send-projects-membership-invitation"/>.</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI.</para></listitem>
<listitem><para>In the left navigation, click Projects.</para></listitem>
<listitem><para>In Select View, choose Projects.</para></listitem>
<listitem><para>Click the name of the project you want to work with.</para></listitem>
<listitem><para>Click the Accounts tab. The current members of the project are listed.</para></listitem>
<listitem><para>Type the account name of the new member you want to add, and click Add Account. You can add only people who have an account in this cloud and within the same domain as the project.</para></listitem>
</orderedlist>
</section>

20
docs/en-US/add-security-group.xml Normal file
View File

@ -0,0 +1,20 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="add-security-group">
<title>Adding a Security Group</title>
<para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
<itemizedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>In Select view, choose Security Groups.</para></listitem>
<listitem><para>Click Add Security Group.</para></listitem>
<listitem><para>Provide a name and description.</para></listitem>
<listitem><para>Click OK.</para>
<para>The new security group appears in the Security Groups Details tab.</para></listitem>
<listitem><para>To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group.</para></listitem>
</itemizedlist>
</section>

143
docs/en-US/added-API-commands.xml Normal file
View File

@ -0,0 +1,143 @@
<section id="added-API-commands">
<title>Added API commands</title>
<para>Added in 3.0.3:</para>
<itemizedlist>
<listitem><para>enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in CloudPlatform.)</para></listitem>
<listitem><para>disableCiscoNexusVSM (Disables Nexus 1000v dvSwitch in CloudPlatform.)</para></listitem>
<listitem><para>deleteCiscoNexusVSM (Deletes Nexus 1000v dvSwitch in CloudPlatform.)</para></listitem>
<listitem><para>listCiscoNexusVSMs (Lists the control VLAN ID, packet VLAN ID, and data VLAN ID, as well as the IP address of the Nexus 1000v dvSwitch.)</para></listitem>
</itemizedlist>
<para>Added in 3.0.2:</para>
<itemizedlist>
<listitem><para>changeServiceForSystemVm</para>
<para>Changes the service offering for a system VM (console proxy or secondary storage). The system VM must be in a "Stopped" state for this command to take effect.</para>
</listitem>
</itemizedlist>
<para>Added in 3.0.1:</para>
<itemizedlist>
<listitem><para>changeServiceForSystemVm</para>
<para>Changes the service offering for a system VM (console proxy or secondary storage). The system VM must be in a "Stopped" state for this command to take effect.</para>
</listitem>
</itemizedlist>
<para>Added in 3.0.0:</para>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<colspec colname="c3" />
<tbody>
<row>
<entry><para>assignVirtualMachine (Move a user VM to another user under same domain.)</para></entry>
<entry><para>restoreVirtualMachine (Restore a VM to original template or specific snapshot)</para></entry>
<entry><para>createLBStickinessPolicy (Creates a Load Balancer stickiness policy )</para></entry>
</row>
<row>
<entry><para>deleteLBStickinessPolicy (Deletes a LB stickiness policy.)</para></entry>
<entry><para>listLBStickinessPolicies (Lists LBStickiness policies.)</para></entry>
<entry><para>ldapConfig (Configure the LDAP context for this site.)</para></entry>
</row>
<row>
<entry><para>addSwift (Adds Swift.)</para></entry>
<entry><para>listSwifts (List Swift.)</para></entry>
<entry><para>migrateVolume (Migrate volume)</para></entry>
</row>
<row>
<entry><para>updateStoragePool (Updates a storage pool.)</para></entry>
<entry><para>authorizeSecurityGroupEgress (Authorizes a particular egress rule for this security group)</para></entry>
<entry><para>revokeSecurityGroupEgress (Deletes a particular egress rule from this security group)</para></entry>
</row>
<row>
<entry><para>createNetworkOffering (Creates a network offering.)</para></entry>
<entry><para>deleteNetworkOffering (Deletes a network offering.)</para></entry>
<entry><para>createProject (Creates a project)</para></entry>
</row>
<row>
<entry><para>deleteProject (Deletes a project)</para></entry>
<entry><para>updateProject (Updates a project)</para></entry>
<entry><para>activateProject (Activates a project)</para></entry>
</row>
<row>
<entry><para>suspendProject (Suspends a project)</para></entry>
<entry><para>listProjects (Lists projects and provides detailed information for listed projects)</para></entry>
<entry><para>addAccountToProject (Adds acoount to a project)</para></entry>
</row>
<row>
<entry><para>deleteAccountFromProject (Deletes account from the project)</para></entry>
<entry><para>listProjectAccounts (Lists project's accounts)</para></entry>
<entry><para>listProjectInvitations (Lists an account's invitations to join projects)</para></entry>
</row>
<row>
<entry><para>updateProjectInvitation (Accepts or declines project invitation)</para></entry>
<entry><para>deleteProjectInvitation (Deletes a project invitation)</para></entry>
<entry><para>updateHypervisorCapabilities (Updates a hypervisor capabilities.)</para></entry>
</row>
<row>
<entry><para>listHypervisorCapabilities (Lists all hypervisor capabilities.)</para></entry>
<entry><para>createPhysicalNetwork (Creates a physical network)</para></entry>
<entry><para>deletePhysicalNetwork (Deletes a Physical Network.)</para></entry>
</row>
<row>
<entry><para>listPhysicalNetworks (Lists physical networks)</para></entry>
<entry><para>updatePhysicalNetwork (Updates a physical network)</para></entry>
<entry><para>listSupportedNetworkServices (Lists all network services provided by CloudPlatform or for the given Provider.)</para></entry>
</row>
<row>
<entry><para>addNetworkServiceProvider (Adds a network serviceProvider to a physical network)</para></entry>
<entry><para>deleteNetworkServiceProvider (Deletes a Network Service Provider.)</para></entry>
<entry><para>listNetworkServiceProviders (Lists network serviceproviders for a given physical network.)</para></entry>
</row>
<row>
<entry><para>updateNetworkServiceProvider (Updates a network serviceProvider of a physical network)</para></entry>
<entry><para>addTrafficType (Adds traffic type to a physical network)</para></entry>
<entry><para>deleteTrafficType (Deletes traffic type of a physical network)</para></entry>
</row>
<row>
<entry><para>listTrafficTypes (Lists traffic types of a given physical network.)</para></entry>
<entry><para>updateTrafficType (Updates traffic type of a physical network)</para></entry>
<entry><para>listTrafficTypeImplementors (Lists implementors of implementor of a network traffic type or implementors of all network traffic types)</para></entry>
</row>
<row>
<entry><para>createStorageNetworkIpRange (Creates a Storage network IP range.)</para></entry>
<entry><para>deleteStorageNetworkIpRange (Deletes a storage network IP Range.)</para></entry>
<entry><para>listStorageNetworkIpRange (List a storage network IP range.)</para></entry>
</row>
<row>
<entry><para>updateStorageNetworkIpRange (Update a Storage network IP range, only allowed when no IPs in this range have been allocated.)</para></entry>
<entry><para>listUsageTypes (List Usage Types)</para></entry>
<entry><para>addF5LoadBalancer (Adds a F5 BigIP load balancer device)</para></entry>
</row>
<row>
<entry><para>configureF5LoadBalancer (configures a F5 load balancer device)</para></entry>
<entry><para>deleteF5LoadBalancer ( delete a F5 load balancer device)</para></entry>
<entry><para>listF5LoadBalancers (lists F5 load balancer devices)</para></entry>
</row>
<row>
<entry><para>listF5LoadBalancerNetworks (lists network that are using a F5 load balancer device)</para></entry>
<entry><para>addSrxFirewall (Adds a SRX firewall device)</para></entry>
<entry><para>deleteSrxFirewall ( delete a SRX firewall device)</para></entry>
</row>
<row>
<entry><para>listSrxFirewalls (lists SRX firewall devices in a physical network)</para></entry>
<entry><para>listSrxFirewallNetworks (lists network that are using SRX firewall device)</para></entry>
<entry><para>addNetscalerLoadBalancer (Adds a netscaler load balancer device)</para></entry>
</row>
<row>
<entry><para>deleteNetscalerLoadBalancer ( delete a netscaler load balancer device)</para></entry>
<entry><para>configureNetscalerLoadBalancer (configures a netscaler load balancer device)</para></entry>
<entry><para>listNetscalerLoadBalancers (lists netscaler load balancer devices)</para></entry>
</row>
<row>
<entry><para>listNetscalerLoadBalancerNetworks (lists network that are using a netscaler load balancer device)</para></entry>
<entry><para>createVirtualRouterElement (Create a virtual router element.)</para></entry>
<entry><para>configureVirtualRouterElement (Configures a virtual router element.)</para></entry>
</row>
<row>
<entry><para>listVirtualRouterElements (Lists all available virtual router elements.)</para></entry>
<entry><para></para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

114
docs/en-US/added-cloudPlatform-error-codes.xml Normal file
View File

@ -0,0 +1,114 @@
<section id="added-cloudPlatform-error-codes">
<title>Added CloudPlatform Error Codes</title>
<para>You can now find the CloudPlatform-specific error code in the exception response for each type of exception. The following list of error codes is added to the new class named CSExceptionErrorCode. These codes are applicable in CloudPlatform 3.0.3 and later versions.</para>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<colspec colname="c3" />
<tbody>
<row>
<entry><para>4250 : "com.cloud.utils.exception.CloudRuntimeException"</para></entry>
<entry><para>4255 : "com.cloud.utils.exception.ExceptionUtil"</para></entry>
<entry><para>4260 : "com.cloud.utils.exception.ExecutionException"</para></entry>
</row>
<row>
<entry><para>4265 : "com.cloud.utils.exception.HypervisorVersionChangedException"</para></entry>
<entry><para>4270 : "com.cloud.utils.exception.RuntimeCloudException"</para></entry>
<entry><para>4275 : "com.cloud.exception.CloudException"</para></entry>
</row>
<row>
<entry><para>4280 : "com.cloud.exception.AccountLimitException"</para></entry>
<entry><para>4285 : "com.cloud.exception.AgentUnavailableException"</para></entry>
<entry><para>4290 : "com.cloud.exception.CloudAuthenticationException"</para></entry>
</row>
<row>
<entry><para>4295 : "com.cloud.exception.CloudExecutionException"</para></entry>
<entry><para>4300 : "com.cloud.exception.ConcurrentOperationException"</para></entry>
<entry><para>4305 : "com.cloud.exception.ConflictingNetworkSettingsException"</para></entry>
</row>
<row>
<entry><para>4310 : "com.cloud.exception.DiscoveredWithErrorException"</para></entry>
<entry><para>4315 : "com.cloud.exception.HAStateException"</para></entry>
<entry><para>4320 : "com.cloud.exception.InsufficientAddressCapacityException"</para></entry>
</row>
<row>
<entry><para>4325 : "com.cloud.exception.InsufficientCapacityException"</para></entry>
<entry><para>4330 : "com.cloud.exception.InsufficientNetworkCapacityException"</para></entry>
<entry><para>4335 : "com.cloud.exception.InsufficientServerCapacityException"</para></entry>
</row>
<row>
<entry><para>4340 : "com.cloud.exception.InsufficientStorageCapacityException"</para></entry>
<entry><para>4345 : "com.cloud.exception.InternalErrorException"</para></entry>
<entry><para>4350 : "com.cloud.exception.InvalidParameterValueException"</para></entry>
</row>
<row>
<entry><para>4355 : "com.cloud.exception.ManagementServerException"</para></entry>
<entry><para>4360 : "com.cloud.exception.NetworkRuleConflictException"</para></entry>
<entry><para>4365 : "com.cloud.exception.PermissionDeniedException"</para></entry>
</row>
<row>
<entry><para>4370 : "com.cloud.exception.ResourceAllocationException"</para></entry>
<entry><para>4375 : "com.cloud.exception.ResourceInUseException"</para></entry>
<entry><para>4380 : "com.cloud.exception.ResourceUnavailableException"</para></entry>
</row>
<row>
<entry><para>4385 : "com.cloud.exception.StorageUnavailableException"</para></entry>
<entry><para>4390 : "com.cloud.exception.UnsupportedServiceException"</para></entry>
<entry><para>4395 : "com.cloud.exception.VirtualMachineMigrationException"</para></entry>
</row>
<row>
<entry><para>4400 : "com.cloud.exception.AccountLimitException"</para></entry>
<entry><para>4405 : "com.cloud.exception.AgentUnavailableException"</para></entry>
<entry><para>4410 : "com.cloud.exception.CloudAuthenticationException"</para></entry>
</row>
<row>
<entry><para>4415 : "com.cloud.exception.CloudException"</para></entry>
<entry><para>4420 : "com.cloud.exception.CloudExecutionException"</para></entry>
<entry><para>4425 : "com.cloud.exception.ConcurrentOperationException"</para></entry>
</row>
<row>
<entry><para>4430 : "com.cloud.exception.ConflictingNetworkSettingsException"</para></entry>
<entry><para>4435 : "com.cloud.exception.ConnectionException"</para></entry>
<entry><para>4440 : "com.cloud.exception.DiscoveredWithErrorException"</para></entry>
</row>
<row>
<entry><para>4445 : "com.cloud.exception.DiscoveryException"</para></entry>
<entry><para>4450 : "com.cloud.exception.HAStateException"</para></entry>
<entry><para>4455 : "com.cloud.exception.InsufficientAddressCapacityException"</para></entry>
</row>
<row>
<entry><para>4460 : "com.cloud.exception.InsufficientCapacityException"</para></entry>
<entry><para>4465 : "com.cloud.exception.InsufficientNetworkCapacityException"</para></entry>
<entry><para>4470 : "com.cloud.exception.InsufficientServerCapacityException"</para></entry>
</row>
<row>
<entry><para>4475 : "com.cloud.exception.InsufficientStorageCapacityException"</para></entry>
<entry><para>4480 : "com.cloud.exception.InsufficientVirtualNetworkCapcityException"</para></entry>
<entry><para>4485 : "com.cloud.exception.InternalErrorException"</para></entry>
</row>
<row>
<entry><para>4490 : "com.cloud.exception.InvalidParameterValueException"</para></entry>
<entry><para>4495 : "com.cloud.exception.ManagementServerException"</para></entry>
<entry><para>4500 : "com.cloud.exception.NetworkRuleConflictException"</para></entry>
</row>
<row>
<entry><para>4505 : "com.cloud.exception.PermissionDeniedException"</para></entry>
<entry><para>4510 : "com.cloud.exception.ResourceAllocationException"</para></entry>
<entry><para>4515 : "com.cloud.exception.ResourceInUseException"</para></entry>
</row>
<row>
<entry><para>4520 : "com.cloud.exception.ResourceUnavailableException"</para></entry>
<entry><para>4525 : "com.cloud.exception.StorageUnavailableException"</para></entry>
<entry><para>4530 : "com.cloud.exception.UnsupportedServiceException"</para></entry>
</row>
<row>
<entry><para>4535 : "com.cloud.exception.VirtualMachineMigrationException"</para></entry>
<entry><para>9999 : "com.cloud.api.ServerApiException"</para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

26
docs/en-US/adding-IP-addresses-for-the-public-network.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="adding-IP-addresses-for-the-public-network">
<title>Adding IP Addresses for the Public Network</title>
<para>These instructions assume you have already logged in to the CloudPlatform UI.</para>
<orderedlist>
<listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the desired zone .</para></listitem>
<listitem><para>Click the Network tab.</para></listitem>
<listitem><para>In the Public node of the diagram, click Configure.</para></listitem>
<listitem><para>Click the IP Ranges tab.</para></listitem>
<listitem><para>Provide the following information:</para>
<itemizedlist>
<listitem><para>Gateway. The gateway in use for these IP addresses</para></listitem>
<listitem><para>Netmask. The netmask associated with this IP range</para></listitem>
<listitem><para>VLAN. The VLAN that will be used for public traffic</para></listitem>
<listitem><para>Start IP/End IP. A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

17
docs/en-US/admin-alerts.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="admin-alerts">
<title>Administrator Alerts</title>
<para>The system provides alerts and events to help with the management of the cloud. Alerts are notices to an administrator, generally delivered by e-mail, notifying the administrator that an error has occurred in the cloud. Alert behavior is configurable.</para>
<para>Events track all of the user and administrator actions in the cloud. For example, every guest VM start creates an associated event. Events are stored in the Management Server’s database.</para>
<para>Emails will be sent to administrators under the following circumstances:</para>
<itemizedlist>
<listitem><para>The Management Server cluster runs low on CPU, memory, or storage resources</para></listitem>
<listitem><para>The Management Server loses heartbeat from a Host for more than 3 minutes</para></listitem>
<listitem><para>The Host cluster runs low on CPU, memory, or storage resources</para></listitem>
</itemizedlist>
</section>

73
docs/en-US/admin-guide.xml Normal file
View File

@ -0,0 +1,73 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<chapter id="admin-guide">
<title>Administrator Guide</title>
<xi:include href="whats-in-this-adminguide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-working-with-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="creating-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="vm-lifecycle.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accessing-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="stopping-and-starting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-vm-name-os-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-service-offering-for-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="manual-live-migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="deleting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="best-practices-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="runtime-behavior-of-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="hypervisor-support-for-primarystorage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="storage-tags.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="maintenance-mode-for-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="best-practices-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="secondary-storage-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-secondary-storage-ip.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-secondary-storage-servers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="using-swift-for-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="creating-new-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="upload-existing-volume-to-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="upload-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="private-public-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="attaching-volume.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="detach-move-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="resizing-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="volume-deletion-garbage-collection.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="incremental-snapshots-backup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="volume-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="snapshot-restore.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="guest-traffic.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="using-multiple-guest-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-additional-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="change-network-offering-on-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-virtual-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="isolated-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="shared-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-ingress-egress-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="runtime-allocation-virtual-network-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="creating-network-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="enable-security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-security-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-load-balancer-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sticky-session-policies-for-lb-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="guest-ip-ranges.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="acquire-new-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="release-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="static-nat.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="enable-disable-static-nat.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ip-forwarding-firewalling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="firewall-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="port-forwarding.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ip-load-balancing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="dns-dhcp.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-password-management-to-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="configure-vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloudplatform-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

9
docs/en-US/advanced-zone-configuration.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="advanced-zone-configuration">
<title>Advanced Zone Configuration</title>
<para>TODO</para>
</section>

10
docs/en-US/advanced-zone-physical-network-configuration.xml Normal file
View File

@ -0,0 +1,10 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="advanced-zone-physical-network-configuration">
<title>Advanced Zone Physical Network Configuration</title>
<para>Within a zone that uses advanced networking, you need to tell the Management Server how the physical network is set up to carry different kinds of traffic in isolation.</para>
</section>

31
docs/en-US/alerts.xml Normal file
View File

@ -0,0 +1,31 @@
<section id="alerts">
<title>Alerts</title>
<para>The following is the list of alert type numbers. The current alerts can be found by calling listAlerts.</para>
<programlisting>MEMORY = 0</programlisting>
<programlisting>CPU = 1</programlisting>
<programlisting>STORAGE =2</programlisting>
<programlisting>STORAGE_ALLOCATED = 3</programlisting>
<programlisting>PUBLIC_IP = 4</programlisting>
<programlisting>PRIVATE_IP = 5</programlisting>
<programlisting>HOST = 6</programlisting>
<programlisting>USERVM = 7</programlisting>
<programlisting>DOMAIN_ROUTER = 8</programlisting>
<programlisting>CONSOLE_PROXY = 9</programlisting>
<programlisting>ROUTING = 10// lost connection to default route (to the gateway)</programlisting>
<programlisting>STORAGE_MISC = 11 // lost connection to default route (to the gateway)</programlisting>
<programlisting>USAGE_SERVER = 12 // lost connection to default route (to the gateway)</programlisting>
<programlisting>MANAGMENT_NODE = 13 // lost connection to default route (to the gateway)</programlisting>
<programlisting>DOMAIN_ROUTER_MIGRATE = 14</programlisting>
<programlisting>CONSOLE_PROXY_MIGRATE = 15</programlisting>
<programlisting>USERVM_MIGRATE = 16</programlisting>
<programlisting>VLAN = 17</programlisting>
<programlisting>SSVM = 18</programlisting>
<programlisting>USAGE_SERVER_RESULT = 19</programlisting>
<programlisting>STORAGE_DELETE = 20;</programlisting>
<programlisting>UPDATE_RESOURCE_COUNT = 21; //Generated when we fail to update the resource count</programlisting>
<programlisting>USAGE_SANITY_RESULT = 22;</programlisting>
<programlisting>DIRECT_ATTACHED_PUBLIC_IP = 23;</programlisting>
<programlisting>LOCAL_STORAGE = 24;</programlisting>
<programlisting>RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only</programlisting>
</section>

9
docs/en-US/allocators.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="allocators">
<title>Allocators</title>
<para>CloudPlatform enables administrators to write custom allocators that will choose the Host to place a new guest and the storage host from which to allocate guest virtual disk images.</para>
</section>

8
docs/en-US/api-reference.xml Normal file
View File

@ -0,0 +1,8 @@
<section id="api-reference">
<title>API Reference Documentation</title>
<para>2.2 API Reference:</para>
<para><ulink url="http://download.cloud.com/support/downloads.html/">http://download.cloud.com/support/downloads.html/</ulink></para>
<para>3.0 API Reference:</para>
<para><ulink url="http://download.cloud.com/releases/3.0.0/api_3.0.0/TOC_Root_Admin.html/">http://download.cloud.com/releases/3.0.0/api_3.0.0/TOC_Root_Admin.html/</ulink></para>
</section>

124
docs/en-US/appendix-a-time-zones.xml Normal file
View File

@ -0,0 +1,124 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="appendix-a-time-zones">
<title>Appendix A—Time Zones</title>
<para>The following time zone identifiers are accepted by CloudPlatform. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table.</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Etc/GMT+12</para></entry>
<entry><para>America/La_Paz</para></entry>
<entry><para>Asia/Jerusalem</para></entry>
</row>
<row>
<entry><para>Etc/GMT+11</para></entry>
<entry><para>America/Santiago</para></entry>
<entry><para>Europe/Minsk</para></entry>
</row>
<row>
<entry><para>Pacific/Samoa</para></entry>
<entry><para>America/St_Johns</para></entry>
<entry><para>Europe/Moscow</para></entry>
</row>
<row>
<entry><para>Pacific/Honolulu</para></entry>
<entry><para>America/Araguaina</para></entry>
<entry><para>Africa/Nairobi</para></entry>
</row>
<row>
<entry><para>US/Alaska</para></entry>
<entry><para>America/Los_Angeles</para></entry>
<entry><para>Mexico/BajaNorte</para></entry>
</row>
<row>
<entry><para>US/Arizona</para></entry>
<entry><para>US/Mountain</para></entry>
<entry><para>America/Chihuahua</para></entry>
</row>
<row>
<entry><para>America/Chicago</para></entry>
<entry><para>America/Costa_Rica</para></entry>
<entry><para>America/Mexico_City</para></entry>
</row>
<row>
<entry><para>Canada/Saskatchewan</para></entry>
<entry><para>America/Bogota</para></entry>
<entry><para>America/New_York</para></entry>
</row>
<row>
<entry><para>America/Caracas</para></entry>
<entry><para>America/Asuncion</para></entry>
<entry><para>America/Cuiaba</para></entry>
</row>
<row>
<entry><para>America/Halifax</para></entry>
<entry><para>America/Argentina/Buenos_Aires</para></entry>
<entry><para>America/Cayenne</para></entry>
</row>
<row>
<entry><para>America/Godthab</para></entry>
<entry><para>America/Montevideo</para></entry>
<entry><para>Etc/GMT+2</para></entry>
</row>
<row>
<entry><para>Atlantic/Azores</para></entry>
<entry><para>Atlantic/Cape_Verde</para></entry>
<entry><para>Africa/Casablanca</para></entry>
</row>
<row>
<entry><para>Etc/UTC</para></entry>
<entry><para>Atlantic/Reykjavik</para></entry>
<entry><para>Europe/London</para></entry>
</row>
<row>
<entry><para>CET</para></entry>
<entry><para>Europe/Bucharest</para></entry>
<entry><para>Africa/Johannesburg</para></entry>
</row>
<row>
<entry><para>Asia/Beirut</para></entry>
<entry><para>Africa/Cairo</para></entry>
<entry><para>Asia/Karachi</para></entry>
</row>
<row>
<entry><para>Asia/Kolkata</para></entry>
<entry><para>Asia/Bangkok</para></entry>
<entry><para>Asia/Shanghai</para></entry>
</row>
<row>
<entry><para>Asia/Kuala_Lumpur</para></entry>
<entry><para>Australia/Perth</para></entry>
<entry><para>Asia/Taipei</para></entry>
</row>
<row>
<entry><para>Asia/Tokyo</para></entry>
<entry><para>Asia/Seoul</para></entry>
<entry><para>Australia/Adelaide</para></entry>
</row>
<row>
<entry><para>Australia/Darwin</para></entry>
<entry><para>Australia/Brisbane</para></entry>
<entry><para>Australia/Canberra</para></entry>
</row>
<row>
<entry><para>Pacific/Guam</para></entry>
<entry><para>Pacific/Auckland</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

88
docs/en-US/asynchronous-commands-example.xml Normal file
View File

@ -0,0 +1,88 @@
<section id="asynchronous-commands-example">
<title>Example</title>
<para>
The following shows an example of using an asynchronous command. Assume the API command:</para>
<programlisting>command=deployVirtualMachine&amp;zoneId=1&amp;serviceOfferingId=1&amp;diskOfferingId=1&amp;templateId=1
</programlisting>
<para>CloudStack will immediately return a job ID and any other additional data.</para>
<programlisting>
&lt;deployvirtualmachineresponse&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;id&gt;100&lt;/id&gt;
&lt;/deployvirtualmachineresponse&gt;
</programlisting>
<para>Using the job ID, you can periodically poll for the results by using the queryAsyncJobResult command.</para>
<programlisting>command=queryAsyncJobResult&amp;jobId=1</programlisting>
<para>Three possible results could come from this query.</para>
<para>Job is still pending:</para>
<programlisting>
&lt;queryasyncjobresult&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;jobstatus&gt;0&lt;/jobstatus&gt;
&lt;jobprocstatus&gt;1&lt;/jobprocstatus&gt;
&lt;/queryasyncjobresult&gt;
</programlisting>
<para>Job has succeeded:</para>
<programlisting>
&lt;queryasyncjobresultresponse cloud-stack-version="3.0.1.6"&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;jobstatus&gt;1&lt;/jobstatus&gt;
&lt;jobprocstatus&gt;0&lt;/jobprocstatus&gt;
&lt;jobresultcode&gt;0&lt;/jobresultcode&gt;
&lt;jobresulttype&gt;object&lt;/jobresulttype&gt;
&lt;jobresult&gt;
&lt;virtualmachine&gt;
&lt;id&gt;450&lt;/id&gt;
&lt;name&gt;i-2-450-VM&lt;/name&gt;
&lt;displayname&gt;i-2-450-VM&lt;/displayname&gt;
&lt;account&gt;admin&lt;/account&gt;
&lt;domainid&gt;1&lt;/domainid&gt;
&lt;domain&gt;ROOT&lt;/domain&gt;
&lt;created&gt;2011-03-10T18:20:25-0800&lt;/created&gt;
&lt;state&gt;Running&lt;/state&gt;
&lt;haenable&gt;false&lt;/haenable&gt;
&lt;zoneid&gt;1&lt;/zoneid&gt;
&lt;zonename&gt;San Jose 1&lt;/zonename&gt;
&lt;hostid&gt;2&lt;/hostid&gt;
&lt;hostname&gt;905-13.sjc.lab.vmops.com&lt;/hostname&gt;
&lt;templateid&gt;1&lt;/templateid&gt;
&lt;templatename&gt;CentOS 5.3 64bit LAMP&lt;/templatename&gt;
&lt;templatedisplaytext&gt;CentOS 5.3 64bit LAMP&lt;/templatedisplaytext&gt;
&lt;passwordenabled&gt;false&lt;/passwordenabled&gt;
&lt;serviceofferingid&gt;1&lt;/serviceofferingid&gt;
&lt;serviceofferingname&gt;Small Instance&lt;/serviceofferingname&gt;
&lt;cpunumber&gt;1&lt;/cpunumber&gt;
&lt;cpuspeed&gt;500&lt;/cpuspeed&gt;
&lt;memory&gt;512&lt;/memory&gt;
&lt;guestosid&gt;12&lt;/guestosid&gt;
&lt;rootdeviceid&gt;0&lt;/rootdeviceid&gt;
&lt;rootdevicetype&gt;NetworkFilesystem&lt;/rootdevicetype&gt;
&lt;nic&gt;
&lt;id&gt;561&lt;/id&gt;
&lt;networkid&gt;205&lt;/networkid&gt;
&lt;netmask&gt;255.255.255.0&lt;/netmask&gt;
&lt;gateway&gt;10.1.1.1&lt;/gateway&gt;
&lt;ipaddress&gt;10.1.1.225&lt;/ipaddress&gt;
&lt;isolationuri&gt;vlan://295&lt;/isolationuri&gt;
&lt;broadcasturi&gt;vlan://295&lt;/broadcasturi&gt;
&lt;traffictype&gt;Guest&lt;/traffictype&gt;
&lt;type&gt;Virtual&lt;/type&gt;
&lt;isdefault&gt;true&lt;/isdefault&gt;
&lt;/nic&gt;
&lt;hypervisor&gt;XenServer&lt;/hypervisor&gt;
&lt;/virtualmachine&gt;
&lt;/jobresult&gt;
&lt;/queryasyncjobresultresponse&gt;
</programlisting>
<para>Job has failed:</para>
<programlisting>
&lt;queryasyncjobresult&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;jobstatus&gt;2&lt;/jobstatus&gt;
&lt;jobprocstatus&gt;0&lt;/jobprocstatus&gt;
&lt;jobresultcode&gt;551&lt;/jobresultcode&gt;
&lt;jobresulttype&gt;text&lt;/jobresulttype&gt;
&lt;jobresult&gt;Unable to deploy virtual machine id = 100 due to not enough capacity&lt;/jobresult&gt;
&lt;/queryasyncjobresult&gt;
</programlisting>
</section>

15
docs/en-US/asynchronous-commands.xml Normal file
View File

@ -0,0 +1,15 @@
<section id="asynchronous-commands">
<title>Asynchronous Commands</title>
<para>Starting in CloudStack 2.x, the notion of asynchronous commands has been introduced. Commands are designated as asynchronous when they can potentially take a long period of time to complete such as creating a snapshot or disk volume. They differ from synchronous commands by the following:
</para>
<itemizedlist>
<listitem><para>They are identified in the API Reference by an (A).</para></listitem>
<listitem><para>They will immediately return a job ID to refer to the job that will be responsible in processing the command.</para></listitem>
<listitem><para>If executed as a "create" resource command, it will return the resource ID as well as the job ID.</para>
<para>You can periodically check the status of the job by making a simple API call to the command, queryAsyncJobResult and passing in the job ID.</para>
</listitem>
</itemizedlist>
<xi:include href="job-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="asynchronous-commands-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

20
docs/en-US/attach-iso-to-vm.xml Normal file
View File

@ -0,0 +1,20 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="attach-iso-to-vm">
<title>Attaching an ISO to a VM</title>
<orderedlist>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the virtual machine you want to work with.</para></listitem>
<listitem><para>Click the Attach ISO button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/iso-icon.png" />
</imageobject>
<textobject><phrase>iso.png: Depicts adding an iso image</phrase></textobject>
</inlinemediaobject></para></listitem>
<listitem><para>In the Attach ISO dialog box, select the desired ISO.</para></listitem>
<listitem><para>Click OK</para></listitem>
</orderedlist>
</section>

25
docs/en-US/attaching-volume.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="attaching-volume">
<title>Attaching a Volume</title>
<para>You can attach a volume to a guest VM to provide extra disk storage. Attach a volume when you first create a new volume, when you are moving an existing volume from one VM to another, or after you have migrated a volume from one storage pool to another.</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Storage.</para></listitem>
<listitem><para>In Select View, choose Volumes.</para></listitem>
<listitem><para>4. Click the volume name in the Volumes list, then click the Attach Disk button<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/attach-disk-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>In the Instance popup, choose the VM to which you want to attach the volume. You will only see instances to which you are allowed to attach volumes; for example, a user will see only instances created by that user, but the administrator will have more choices.</para>
<para>If the VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para></listitem>
<listitem><para>When the volume has been attached, you should be able to see it by clicking Instances, the instance name, and View Volumes.</para></listitem>
</orderedlist>
</section>

18
docs/en-US/automatic-snapshot-creation-retention.xml Normal file
View File

@ -0,0 +1,18 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="automatic-snapshot-creation-retention">
<title>Automatic Snapshot Creation and Retention</title>
<para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>,
<emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold"
>KVM</emphasis>)</para>
<para>Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30.</para>
<para>With each snapshot schedule, users can also specify the number of scheduled snapshots to be
retained. Older snapshots that exceed the retention limit are automatically deleted. This
user-defined limit must be equal to or lower than the global limit set by the CloudPlatform
administrator. See <xref linkend="globally-configured-limits"/>. The limit applies only to
those snapshots that are taken as part of an automatic recurring snapshot policy. Additional
manual snapshots can be created and retained.</para>
</section>

128
docs/en-US/basic-zone-configuration.xml Normal file
View File

@ -0,0 +1,128 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="basic-zone-configuration">
<title>Basic Zone Configuration</title>
<orderedlist>
<listitem><para>After you select Basic in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> A name for the zone.</para></listitem>
<listitem><para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest VMs in the zone. These DNS servers will be accessed via the public network you will add later. The public IP addresses for the zone must have a route to the DNS server named here.</para></listitem>
<listitem><para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS servers for use by system VMs in the zone (these are VMs used by &PRODUCT; itself, such as virtual routers, console proxies, and Secondary Storage VMs.) These DNS servers will be accessed via the management traffic network interface of the System VMs. The private IP address you provide for the pods must have a route to the internal DNS server named here.</para></listitem>
<listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose the hypervisor for the first cluster in the zone. You can add clusters with different hypervisors later, after you finish adding the zone.</para></listitem>
<listitem><para><emphasis role="bold">Network Offering.</emphasis> Your choice here determines what network services will be available on the network for guest VMs.</para>
<informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<thead>
<row>
<entry><para>Network Offering</para></entry>
<entry><para>Description</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>DefaultSharedNetworkOfferingWithSGService</para></entry>
<entry><para>If you want to enable security groups for guest traffic isolation, choose this. (See Using Security Groups to Control Traffic to VMs.)</para></entry>
</row>
<row>
<entry><para>DefaultSharedNetworkOffering</para></entry>
<entry><para>If you do not need security groups, choose this.</para></entry>
</row>
<row>
<entry><para>DefaultSharedNetscalerEIPandELBNetworkOffering</para></entry>
<entry><para>If you have installed a Citrix NetScaler appliance as part of your zone network, and you will be using its Elastic IP and Elastic Load Balancing features, choose this. With the EIP and ELB features, a basic zone with security groups enabled can offer 1:1 static NAT and load balancing.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
<listitem><para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix.</para></listitem>
<listitem><para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A zone that is not public will be assigned to a particular domain. Only users in that domain will be allowed to create guest VMs in this zone.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Choose which traffic types will be carried by the physical network.</para>
<para>The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see Basic Zone Network Traffic Types. This screen starts out with some traffic types already assigned. To add more, drag and drop traffic types onto the network. You can also change the network name if desired.</para>
</listitem>
<listitem><para>3. (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK.</para>
<para>These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created.</para>
<para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch.</para>
</listitem>
<listitem><para>Click Next.</para></listitem>
<listitem><para>(NetScaler only) If you chose the network offering for NetScaler, you have an additional screen to fill out. Provide the requested details to set up the NetScaler, then click Next.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">IP address.</emphasis> The NSIP (NetScaler IP) address of the NetScaler device.</para></listitem>
<listitem><para><emphasis role="bold">Username/Password.</emphasis> The authentication credentials to access the device. &PRODUCT; uses these credentials to access the device.</para></listitem>
<listitem><para><emphasis role="bold">Type.</emphasis> NetScaler device type that is being added. It could be NetScaler VPX, NetScaler MPX, or NetScaler SDX. For a comparison of the types, see About Using a NetScaler Load Balancer.</para></listitem>
<listitem><para><emphasis role="bold">Public interface.</emphasis> Interface of NetScaler that is configured to be part of the public network.</para></listitem>
<listitem><para><emphasis role="bold">Private interface.</emphasis> Interface of NetScaler that is configured to be part of the private network.</para></listitem>
<listitem><para><emphasis role="bold">Number of retries.</emphasis> Number of times to attempt a command on the device before considering the operation failed. Default is 2.</para></listitem>
<listitem><para><emphasis role="bold">Capacity.</emphasis> Number of guest networks/accounts that will share this NetScaler device.</para></listitem>
<listitem><para><emphasis role="bold">Dedicated.</emphasis> When marked as dedicated, this device will be dedicated to a single account. When Dedicated is checked, the value in the Capacity field has no significance – implicitly, its value is 1.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>(NetScaler only) Configure the IP range for public traffic. The IPs in this range will be used for the static NAT capability which you enabled by selecting the network offering for NetScaler with EIP and ELB. Enter the following details, then click Add. If desired, you can repeat this step to add more IP ranges. When done, click Next.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP addresses.</para></listitem>
<listitem><para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP range.</para></listitem>
<listitem><para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public traffic.</para></listitem>
<listitem><para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest VMs.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see <xref linkend="about-pods" />.</para>
<para>To configure the first pod, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para></listitem>
<listitem><para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts in that pod.</para></listitem>
<listitem><para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that defines the pod's subnet. Use CIDR notation.</para></listitem>
<listitem><para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see System Reserved IP Addresses.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Configure the network for guest traffic. Provide the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Guest gateway.</emphasis> The gateway that the guests should use.</para></listitem>
<listitem><para><emphasis role="bold">Guest netmask.</emphasis> The netmask in use on the subnet the guests will use.</para></listitem>
<listitem><para><emphasis role="bold">Guest start IP/End IP.</emphasis> Enter the first and last IP addresses that define a range that &PRODUCT; can assign to guests.</para>
<itemizedlist>
<listitem><para>We strongly recommend the use of multiple NICs. If multiple NICs are used, they may be in a different subnet.</para></listitem>
<listitem><para>If one NIC is used, these IPs should be in the same CIDR as the pod CIDR.</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, see About Clusters.</para>
<para>To configure the first cluster, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this field is read only) Choose the type of hypervisor software that all hosts in this cluster will run. If you choose VMware, additional fields appear so you can give information about a vSphere cluster. For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere.</para></listitem>
<listitem><para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This can be text of your choosing and is not used by &PRODUCT;.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts later. For an overview of what a host is, see About Hosts.</para>
<note><para>When you add a hypervisor host to &PRODUCT;, the host must not have any VMs already running.</para></note>
<para>Before you can configure the host, you need to install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by &PRODUCT; and what additional configuration is required to ensure the host will work with &PRODUCT;. To find these installation details, see:</para>
<itemizedlist>
<listitem><para>Citrix XenServer Installation and Configuration</para></listitem>
<listitem><para>VMware vSphere Installation and Configuration</para></listitem>
<listitem><para>KVM vSphere Installation and Configuration</para></listitem>
<listitem><para>Oracle VM (OVM) Installation and Configuration</para></listitem>
</itemizedlist>
<para>To configure the first host, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the host.</para></listitem>
<listitem><para><emphasis role="bold">Username.</emphasis> The username is root.</para></listitem>
<listitem><para><emphasis role="bold">Password.</emphasis> This is the password for the user named above (from your XenServer or KVM install).</para></listitem>
<listitem><para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set this to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, CloudPlatform adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage.</para>
<para>To configure the first primary storage server, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on what you choose here.</para></listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>

10
docs/en-US/basic-zone-physical-network-configuration.xml Normal file
View File

@ -0,0 +1,10 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="basic-zone-physical-network-configuration">
<title>Basic Zone Physical Network Configuration</title>
<para>In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to CloudPlatform, you set up the guest network through the Add Zone screens.</para>
</section>

6
docs/en-US/best-practices-for-vms.xml Normal file
View File

@ -0,0 +1,6 @@
<section id="vm-lifecycle">
<title>VM Lifecycle</title>
<para>The CloudPlatform administrator should monitor the total number of VM instances in each cluster, and disable allocation to the cluster if the total is approaching the maximum that the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of one or more hosts failing, which would increase the VM load on the other hosts as the VMs are automatically redeployed. Consult the documentation for your chosen hypervisor to find the maximum permitted number of VMs per host, then use CloudPlatform global configuration settings to set this as the default limit. Monitor the VM activity in each cluster at all times. Keep the total number of VMs below a safe level that allows for the occasional host failure. For example, if there are N hosts in the cluster, and you want to allow for one host in the cluster to be down at any given time, the total number of VM instances you can permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this number of VMs, use the CloudPlatform UI to disable allocation of more VMs to the cluster..</para>
</section>

13
docs/en-US/best-practices-primary-storage.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="best-practices-primary-storage">
<title>Best Practices for Primary Storage</title>
<itemizedlist>
<listitem><para>The speed of primary storage will impact guest performance. If possible, choose smaller, higher RPM drives for primary storage.</para></listitem>
<listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data</para></listitem>
</itemizedlist>
</section>

14
docs/en-US/best-practices-secondary-storage.xml Normal file
View File

@ -0,0 +1,14 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="best-practices-secondary-storage">
<title>Best Practices for Secondary Storage</title>
<itemizedlist>
<listitem><para>Each Zone can have one or more secondary storage servers. Multiple secondary storage servers provide increased scalability to the system.</para></listitem>
<listitem><para>Secondary storage has a high read:write ratio and is expected to consist of larger drives with lower IOPS than primary storage.</para></listitem>
<listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data.</para></listitem>
</itemizedlist>
</section>

9
docs/en-US/best-practices-templates.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="best-practices-templates">
<title>Best Practices for Templates</title>
<para>If you plan to use large templates (100 GB or larger), be sure you have a 10-gigabit network to support the large templates. A slower network can lead to timeouts and other errors when large templates are used.</para>
</section>

15
docs/en-US/best-practices-virtual-router.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="best-practices-virtual-router">
<title>Best Practices for Virtual Routers</title>
<itemizedlist>
<listitem><para>WARNING: Restarting a virtual router from a hypervisor console deletes all the iptables rules. To work around this issue, stop the virtual router and start it from the CloudPlatform UI.</para></listitem>
<listitem><para>WARNING: Do not use the destroyRouter API when only one router is available in the network, because restartNetwork API with the cleanup=false parameter can't recreate it later. If you want to destroy and recreate the single router available in the network, use the restartNetwork API with the cleanup=true parameter.</para></listitem>
</itemizedlist>
</section>

30
docs/en-US/change-console-proxy-ssl-certificate-domain.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="change-console-proxy-ssl-certificate-domain">
<title>Changing the Console Proxy SSL Certificate and Domain</title>
<para>If the administrator prefers, it is possible for the URL of the customer's console session to show a domain other than realhostip.com. The administrator can customize the displayed domain by selecting a different domain and uploading a new SSL certificate and private key. The domain must run a DNS service that is capable of resolving queries for addresses of the form aaa-bbb-ccc-ddd.your.domain to an IPv4 IP address in the form aaa.bbb.ccc.ddd, for example, 202.8.44.1. To change the console proxy domain, SSL certificate, and private key:</para>
<orderedlist>
<listitem><para>Set up dynamic name resolution or populate all possible DNS names in your public IP range into your existing DNS server with the format aaa-bbb-ccc-ddd.company.com -> aaa.bbb.ccc.ddd.</para></listitem>
<listitem><para>Generate the private key and certificate signing request (CSR). When you are using openssl to generate private/public key pairs and CSRs, for the private key that you are going to paste into the CloudPlatform UI, be sure to convert it into PKCS#8 format.</para>
<orderedlist numeration="loweralpha">
<listitem><para>Generate a new 2048-bit private key</para><programlisting>openssl genrsa -des3 -out yourprivate.key 2048</programlisting></listitem>
<listitem><para>Generate a new certificate CSR</para><programlisting>openssl req -new -key yourprivate.key -out yourcertificate.csr</programlisting></listitem>
<listitem><para>Head to the website of your favorite trusted Certificate Authority, purchase an SSL certificate, and submit the CSR. You should receive a valid certificate in return</para></listitem>
<listitem><para>Convert your private key format into PKCS#8 encrypted format.</para><programlisting>openssl pkcs8 -topk8 -in yourprivate.key -out yourprivate.pkcs8.encryped.key</programlisting></listitem>
<listitem><para>Convert your PKCS#8 encrypted private key into the PKCS#8 format that is compliant with CloudPlatform</para><programlisting>openssl pkcs8 -in yourprivate.pkcs8.encrypted.key -out yourprivate.pkcs8.key</programlisting></listitem>
</orderedlist>
</listitem>
<listitem><para>In the Update SSL Certificate screen of the CloudPlatform UI, paste the following</para>
<itemizedlist>
<listitem><para>Certificate from step 1(c).</para></listitem>
<listitem><para>Private key from step 1(e).</para></listitem>
<listitem><para>The desired new domain name; for example, company.com</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>The desired new domain name; for example, company.com</para><para>This stops all currently running console proxy VMs, then restarts them with the new certificate and key. Users might notice a brief interruption in console availability</para></listitem>
</orderedlist>
<para>The Management Server will generate URLs of the form "aaa-bbb-ccc-ddd.company.com" after this change is made. New console requests will be served with the new DNS domain name, certificate, and key</para>
</section>

20
docs/en-US/change-host-password.xml Normal file
View File

@ -0,0 +1,20 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="change-host-password">
<title>Changing Host Password</title>
<para>The password for a XenServer Node, KVM Node, or vSphere Node may be changed in the database. Note that all Nodes in a Cluster must have the same password.</para>
<para> To change a Node's password:</para>
<orderedlist>
<listitem><para>Identify all hosts in the cluster.</para></listitem>
<listitem><para>Change the password on all hosts in the cluster. Now the password for the host and the password known to CloudPlatform will not match. Operations on the cluster will fail until the two passwords match.</para>
</listitem>
<listitem><para>Get the list of host IDs for the host in the cluster where you are changing the password. You will need to access the database to determine these host IDs. For each hostname "h" (or vSphere cluster) that you are changing the password for, execute:</para>
<programlisting>mysql> select id from cloud.host where name like '%h%';</programlisting> </listitem>
<listitem><para>This should return a single ID. Record the set of such IDs for these hosts.</para></listitem>
<listitem><para>Update the passwords for the host in the database. In this example, we change the passwords for hosts with IDs 5, 10, and 12 to "password".</para>
<programlisting>mysql> update cloud.host set password='password' where id=5 or id=10 or id=12;</programlisting></listitem>
</orderedlist>
</section>

26
docs/en-US/change-network-offering-on-guest-network.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="change-network-offering-on-guest-network">
<title>Changing the Network Offering on a Guest Network</title>
<para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
<itemizedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
<listitem><para>2. If you are changing from a network offering that uses the CloudPlatform virtual router to one that uses external devices as network service providers, you must first stop all the VMs on the network. See Stopping and Starting VMs. Then return here and continue to the next step</para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>Click the name of the network you want to modify <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>In Network Offering, choose the new network offering, then click Apply.</para></listitem>
<listitem><para>A prompt appears asking whether you want to keep the existing CIDR. This is to let you know that if you change the network offering, the CIDR will be affected. Choose No to proceed with the change.</para></listitem>
<listitem><para>Wait for the update to complete. Don’t try to restart VMs until after the network change is complete.</para></listitem>
<listitem><para>If you stopped any VMs in step 2, restart them.</para></listitem>
</itemizedlist>
</section>

70
docs/en-US/change-to-behavior-of-list-commands.xml Normal file
View File

@ -0,0 +1,70 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="change-to-behavior-of-list-commands">
<title>Change to Behavior of List Commands</title>
<para>There was a major change in how our List* API commands work in CloudStack 3.0 compared to 2.2.x. The rules below apply only for managed resources – those that belong to an account, domain, or project. They are irrelevant for the List* commands displaying unmanaged (system) resources, such as hosts, clusters, and external network resources.</para>
<para>When no parameters are passed in to the call, the caller sees only resources owned by the caller (even when the caller is the administrator). Previously, the administrator saw everyone else's resources by default.</para>
<para>When accountName and domainId are passed in:</para>
<itemizedlist>
<listitem><para>The caller sees the resources dedicated to the account specified.</para></listitem>
<listitem><para>If the call is executed by a regular user, the user is authorized to specify only the user's own account and domainId.</para></listitem>
<listitem><para>If the caller is a domain administrator, CloudStack performs an authorization check to see whether the caller is permitted to view resources for the given account and domainId.</para></listitem>
</itemizedlist>
<para>When projectId is passed in, only resources belonging to that project are listed.</para>
<para>When domainId is passed in, the call returns only resources belonging to the domain specified. To see the resources of subdomains, use the parameter isRecursive=true. Again, the regular user can see only resources owned by that user, the root administrator can list anything, and a domain administrator is authorized to see only resources of the administrator's own domain and subdomains.</para>
<para>To see all resources the caller is authorized to see, except for Project resources, use the parameter listAll=true.</para>
<para>To see all Project resources the caller is authorized to see, use the parameter projectId=-1.</para>
<para>There is one API command that doesn't fall under the rules above completely: the listTemplates command. This command has its own flags defining the list rules:</para>
<informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<thead>
<row>
<entry><para>listTemplates Flag</para></entry>
<entry><para>Description</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>featured</para></entry>
<entry><para>Returns templates that have been marked as featured and public.</para></entry>
</row>
<row>
<entry><para>self</para></entry>
<entry><para>Returns templates that have been registered or created by the calling user.</para></entry>
</row>
<row>
<entry><para>selfexecutable</para></entry>
<entry><para>Same as self, but only returns templates that are ready to be deployed with.</para></entry>
</row>
<row>
<entry><para>sharedexecutable</para></entry>
<entry><para>Ready templates that have been granted to the calling user by another user.</para></entry>
</row>
<row>
<entry><para>executable</para></entry>
<entry><para>Templates that are owned by the calling user, or public templates, that can be used to deploy a new VM.</para></entry>
</row>
<row>
<entry><para>community</para></entry>
<entry><para>Returns templates that have been marked as public but not featured.</para></entry>
</row>
<row>
<entry><para>all</para></entry>
<entry><para>Returns all templates (only usable by admins).</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>The CloudPlatform UI on a general view will display all resources that the logged-in user is authorized to see, except for project resources. To see the project resources, select the project view.</para>
</section>

32
docs/en-US/changing-root-password.xml Normal file
View File

@ -0,0 +1,32 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="changing-root-password">
<title>Changing the Root Password</title>
<para>During installation and ongoing cloud administration, you will need to log in to the UI as the root administrator.
The root administrator account manages the &PRODUCT; deployment, including physical infrastructure.
The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person.
When first installing &PRODUCT;, be sure to change the default password to a new, unique value.</para>
<orderedlist>
<listitem><para>Open your favorite Web browser and go to this URL. Substitute the IP address of your own Management Server:</para>
<programlisting>http://&lt;management-server-ip-address&gt;:8080/client</programlisting>
</listitem>
<listitem><para>Log in to the UI using the current root user ID and password. The default is admin, password.</para></listitem>
<listitem><para>Click Accounts.</para></listitem>
<listitem><para>Click the admin account name.</para></listitem>
<listitem><para>Click View Users.</para></listitem>
<listitem><para>Click the admin user name.</para></listitem>
<listitem>
<para>Click the Change Password button.
<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/change-password.png" />
</imageobject>
<textobject><phrase>change-password.png: button to change a user's password</phrase></textobject>
</inlinemediaobject></para>
</listitem>
<listitem><para>Type the new password, and click OK.</para></listitem>
</orderedlist>
</section>

26
docs/en-US/changing-secondary-storage-ip.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="changing-secondary-storage-ip">
<title>Making API Requests</title>
<para>You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server:</para>
<programlisting>
# mysql -p
mysql> use cloud;
mysql> select id from host where type = 'SecondaryStorage';
mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1'
where host_id = HOSTID and name = 'orig.url';
mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
</programlisting>
<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>
<para>Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone.</para>
</section>

17
docs/en-US/changing-secondary-storage-servers.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="changing-secondary-storage-serversp">
<title>Changing Secondary Storage Servers</title>
<para>You can change the secondary storage NFS mount. Perform the following steps to do so:</para>
<orderedlist>
<listitem><para>Stop all running Management Servers.</para></listitem>
<listitem><para>Wait 30 minutes. This allows any writes to secondary storage to complete.</para></listitem>
<listitem><para>Copy all files from the old secondary storage mount to the new.</para></listitem>
<listitem><para>Use the procedure above to change the IP address for secondary storage if required.</para></listitem>
<listitem><para>Start the Management Server.</para></listitem>
</orderedlist>
</section>

17
docs/en-US/changing-secondary-storage-serversp.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="changing-secondary-storage-serversp">
<title>Changing Secondary Storage Servers</title>
<para>You can change the secondary storage NFS mount. Perform the following steps to do so:</para>
<orderedlist>
<listitem><para>Stop all running Management Servers.</para></listitem>
<listitem><para>Wait 30 minutes. This allows any writes to secondary storage to complete.</para></listitem>
<listitem><para>Copy all files from the old secondary storage mount to the new.</para></listitem>
<listitem><para>Use the procedure above to change the IP address for secondary storage if required.</para></listitem>
<listitem><para>5. Start the Management Server.</para></listitem>
</orderedlist>
</section>

30
docs/en-US/changing-service-offering-for-vm.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="changing-service-offering-for-vm">
<title>Changing the Service Offering for a VM</title>
<para>To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering.</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the VM that you want to work with.</para></listitem>
<listitem><para>Click the Stop button to stop the VM <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click the Change Service button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/change-service-icon.png" />
</imageobject>
<textobject><phrase>ChangeServiceButton.png: button to change the service of a VM</phrase></textobject>
</inlinemediaobject>. The Change service dialog box is displayed.</para></listitem>
<listitem><para>Select the offering you want.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

36
docs/en-US/changing-vm-name-os-group.xml Normal file
View File

@ -0,0 +1,36 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="changing-vm-name-os-group">
<title>Changing the VM Name, OS, or Group</title>
<para>After a VM is created, you can modify the display name, operating system, and the group it belongs to.</para>
<para>To access a VM through the CloudPlatform UI:</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Select the VM that you want to modify.</para></listitem>
<listitem><para>Click the Stop button to stop the VM <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click Edit <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to edit the properties of a VM</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>Make the desired changes to the following:</para></listitem>
<listitem><para>Display name: Enter a new display name if you want to change the name of the VM.</para></listitem>
<listitem><para>OS Type: Select the desired operating system.</para></listitem>
<listitem><para>Group: Enter the group name for the VM.</para></listitem>
<listitem><para>Click Apply.</para></listitem>
</orderedlist>
</section>

9
docs/en-US/cloud-infrastructure-concepts.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="cloud-infrastructure-concepts">
<title>Cloud Infrastructure Concepts</title>
<xi:include href="about-pods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

28
docs/en-US/cloud-infrastructure-overview.xml Normal file
View File

@ -0,0 +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" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="cloud-infrastructure-overview">
<title>Cloud Infrastructure Overview</title>
<para>
The Management Server manages one or more zones (typically, datacenters) containing host computers where guest virtual machines will run. The cloud infrastructure is organized as follows:
</para>
<itemizedlist>
<listitem><para>Zone: Typically, a zone is equivalent to a single datacenter. A zone consists of one or more pods and secondary storage.</para></listitem>
<listitem><para>Pod: A pod is usually one rack of hardware that includes a layer-2 switch and one or more clusters.</para></listitem>
<listitem><para>Cluster: A cluster consists of one or more hosts and primary storage.</para></listitem>
<listitem><para>Host: A single compute node within a cluster. The hosts are where the actual cloud services run in the form of guest virtual machines.</para></listitem>
<listitem><para>Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster.</para></listitem>
<listitem><para>Secondary storage is associated with a zone, and it stores templates, ISO images, and disk volume snapshots.</para></listitem>
</itemizedlist>
<mediaobject>
<imageobject>
<imagedata fileref="./images/infrastructure_overview.png" />
</imageobject>
<textobject><phrase>infrastructure_overview.png: Nested organization of a zone</phrase></textobject>
</mediaobject>
<para><emphasis role="bold">More Information</emphasis></para>
<para>For more information, see <xref linkend="cloud-infrastructure-concepts" />.</para>
</section>

21
docs/en-US/cloud_infrastructure_overview.xml Normal file
View File

@ -0,0 +1,21 @@
<section id="cloud_infrastructure_overview">
<title>Cloud Infrastructure Overview</title>
<para>
The Management Server manages one or more zones (typically, datacenters) containing host computers where guest virtual machines will run. The cloud infrastructure is organized as follows:
</para>
<itemizedlist>
<listitem><para>Zone: Typically, a zone is equivalent to a single datacenter. A zone consists of one or more pods and secondary storage. See About Zones.</para></listitem>
<listitem><para>Pod: A pod is usually one rack of hardware that includes a layer-2 switch and one or more clusters. See About Pods.</para></listitem>
<listitem><para>Cluster: A cluster consists of one or more hosts and primary storage. See About Clusters.</para></listitem>
<listitem><para>Host: A single compute node within a cluster. The hosts are where the actual cloud services run in the form of guest virtual machines. See About Hosts.</para></listitem>
<listitem><para>Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster. See About Primary Storage</para></listitem>
<listitem><para>Secondary storage is associated with a zone, and it stores templates, ISO images, and disk volume snapshots. See About Secondary Storage.</para></listitem>
</itemizedlist>
<mediaobject>
<imageobject>
<imagedata fileref="./images/infrastructure_overview.png" />
</imageobject>
<textobject><phrase>infrastructure_overview.png: Nested organization of a zone</phrase></textobject>
</mediaobject>
</section>

12
docs/en-US/cloudplatform-api.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="cloudplatform-api">
<title>CloudPlatform API</title>
<para>The CloudPlatform API is a low level API that has been used to implement the CloudPlatform web UIs. It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF standards.</para>
<para>Many CloudPlatform API calls are asynchronous. These will return a Job ID immediately when called. This Job ID can be used to query the status of the job later. Also, status calls on impacted resources will provide some indication of their state.</para>
<para>The API has a REST-like query basis and returns results in XML or JSON.</para>
<para>See <ulink url="http://support.citrix.com/product/cs">the Developer’s Guide</ulink> and <ulink url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack">the API Reference</ulink>.</para>
</section>

12
docs/en-US/cloudstack-admin.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

4
docs/en-US/cloudstack.ent Normal file
View File

@ -0,0 +1,4 @@
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2012">
<!ENTITY HOLDER "CC-BY-SA">

16
docs/en-US/cloudstack.xml Normal file
View File

@ -0,0 +1,16 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="release-notes-3.0.4.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

12
docs/en-US/cloudstack_admin.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

12
docs/en-US/cloudstack_developers.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

42
docs/en-US/cloudstack_features.xml Normal file
View File

@ -0,0 +1,42 @@
<section id="cloudstack_features">
<title>What Can CloudStack Do?</title>
<para>
<emphasis role="bold">Multiple Hypervisor Support</emphasis>
</para>
<para>
CloudStack works with a variety of hypervisors. A single cloud deployment can contain multiple hypervisor implementations. You have the complete freedom to choose the right hypervisor for your workload. CloudStack is designed to work with open source Xen and KVM hypervisors as well as enterprise-grade hypervisors such as Citrix XenServer, VMware vSphere, and Oracle VM (OVM). You can also provision “bare metal” hosts with no hypervisor (Beta feature. Untested in CloudStack 3.0.x0.)
</para>
<para>
<emphasis role="bold">Massively Scalable Infrastructure Management</emphasis>
</para>
<para>
CloudStack can manage tens of thousands of servers installed in multiple geographically distributed datacenters. The centralized management server scales linearly, eliminating the need for intermediate cluster-level management servers. No single component failure can cause cloud-wide outage. Periodic maintenance of the management server can be performed without affecting the functioning of virtual machines running in the cloud.
</para>
<para>
<emphasis role="bold">Automatic Configuration Management</emphasis>
</para>
<para>CloudStack automatically configures each guest virtual machine’s networking and storage settings.
</para>
<para>CloudStack internally manages a pool of virtual appliances to support the cloud itself. These appliances offer services such as firewalling, routing, DHCP, VPN access, console proxy, storage access, and storage replication. The extensive use of virtual appliances simplifies the installation, configuration, and ongoing management of a cloud deployment.
</para>
<para>
<emphasis role="bold">Graphical User Interface</emphasis>
</para>
<para>CloudStack offers an administrator's Web interface, used for provisioning and managing the cloud, as well as an end-user's Web interface, used for running VMs and managing VM templates. The UI can be customized to reflect the desired service provider or enterprise look and feel.
</para>
<para>
<emphasis role="bold">API and Extensibility</emphasis>
</para>
<para>
CloudStack provides an API that gives programmatic access to all the management features available in the UI. The API is maintained and documented. This API enables the creation of command line tools and new user interfaces to suit particular needs. See the Developer’s Guide and API Reference, both available at http://docs.cloud.com/CloudStack_Documentation.
</para>
<para>
The CloudStack platform pluggable allocation architecture allows the creation of new types of allocators for the selection of storage and Hosts. See the Allocator Implementation Guide (http://docs.cloud.com/CloudStack_Documentation/Allocator_Implementation_Guide).
</para>
<para>
<emphasis role="bold">High Availability</emphasis>
</para>
<para>The CloudStack platform has a number of features to increase the availability of the system. The Management Server itself may be deployed in a multi-node installation where the servers are load balanced. MySQL may be configured to use replication to provide for a manual failover in the event of database loss. For the Hosts, the CloudStack platform supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath.
</para>
</section>

12
docs/en-US/cloudstack_installation.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

45
docs/en-US/cloudstack_system_requirements.xml Normal file
View File

@ -0,0 +1,45 @@
<section id="cloudstack_system_requirements">
<title>Minimum 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>
<itemizedlist>
<listitem><para>Operating system:</para>
<itemizedlist>
<listitem><para>Commercial users: Preferred: RHEL 6.2+ 64-bit (https://access.redhat.com/downloads) or CentOS 6.2+ 64-bit (http://isoredirect.centos.org/centos/6/isos/x86_64/). Also supported (v3.0.3 and greater): RHEL and CentOS 5.4-5.x 64-bit</para></listitem>
<listitem><para>Open-source community users: RHEL 5.4-5.x 64-bit or 6.2+ 64-bit; CentOS 5.4-5.x 64-bit or 6.2+ 64-bit; Ubuntu 10.04 LTS</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem>
<listitem><para>4 GB of memory</para></listitem>
<listitem><para>250 GB of local disk (more results in better capability; 500 GB recommended)</para></listitem>
<listitem><para>At least 1 NIC</para></listitem>
<listitem><para>Statically allocated IP address</para></listitem>
<listitem><para>Fully qualified domain name as returned by the hostname command</para></listitem>
</itemizedlist>
<para>The host is where the cloud services run in the form of guest virtual machines. Each host is one machine that meets the following requirements:</para>
<itemizedlist>
<listitem><para>Must be 64-bit and must support HVM (Intel-VT or AMD-V enabled).</para></listitem>
<listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem>
<listitem><para>Hardware virtualization support required</para></listitem>
<listitem><para>4 GB of memory</para></listitem>
<listitem><para>36 GB of local disk</para></listitem>
<listitem><para>At least 1 NIC</para></listitem>
<listitem><para>Statically allocated IP Address</para></listitem>
<listitem><para>Latest hotfixes applied to hypervisor software</para></listitem>
<listitem><para>When you deploy CloudStack, the hypervisor host must not have any VMs already running</para></listitem>
</itemizedlist>
<para>Hosts have additional requirements depending on the hypervisor. See the requirements listed at the top of the Installation section for your chosen hypervisor:</para>
<itemizedlist>
<listitem><para>Citrix XenServer Installation for CloudStack</para></listitem>
<listitem><para>VMware vSphere Installation and Configuration</para></listitem>
<listitem><para>KVM Installation and Configuration</para></listitem>
<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 for CloudStack.
</para>
</warning>
</section>

12
docs/en-US/cloudstack_trial_installation.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="trial-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

25
docs/en-US/cloudstack_whatis.xml Normal file
View File

@ -0,0 +1,25 @@
<section id="cloudstack_whatis">
<title>What Is CloudStack?</title>
<para>
Who Should Read This
</para>
<para>
If you are new to CloudStack or you want to learn more about concepts before installing and running CloudStack, read this overview.
If you just want to get started, you can skip to Overview of Installation Steps.
</para>
<para>
CloudStack is an open source software platform that pools computing resources to build public, private, and hybrid Infrastructure as a Service (IaaS) clouds. CloudStack manages the network, storage, and compute nodes that make up a cloud infrastructure. Use CloudStack to deploy, manage, and configure cloud computing environments.
Typical users are service providers and enterprises. With CloudStack, you can:
<itemizedlist>
<listitem>
<para>Set up an on-demand, elastic cloud computing service. Service providers can sell self service virtual machine instances, storage volumes, and networking configurations over the Internet.
</para></listitem>
<listitem>
<para>Set up an on-premise private cloud for use by employees. Rather than managing virtual machines in the same way as physical machines, with CloudStack an enterprise can offer self-service virtual machines to users without involving IT departments.
</para></listitem>
</itemizedlist>
</para>
</section>

9
docs/en-US/cluster-add.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="cluster-add">
<title>Adding a Cluster</title>
<para>TODO</para>
</section>

97
docs/en-US/compatibility-matrix.xml Normal file
View File

@ -0,0 +1,97 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="compatibility-matrix">
<title>Compatibility Matrix</title>
<informaltable>
<tgroup cols="7" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>Hypervisor</para></entry>
<entry><para>CloudStack 2.1.x</para></entry>
<entry><para>CloudStack 2.2.x</para></entry>
<entry><para>CloudStack 3.0.0</para></entry>
<entry><para>CloudStack 3.0.1</para></entry>
<entry><para>CloudStack 3.0.2</para></entry>
<entry><para>CloudStack 3.0.3</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>XenServer 5.6</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>XenServer 5.6 FP1</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>XenServer 5.6 SP2</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.0.0</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.0.2</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.1</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>KVM (RHEL 6.0 or 6.1)</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>VMware (vSphere and vCenter, both version 4.1)</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

29
docs/en-US/compute-disk-service-offerings.xml Normal file
View File

@ -0,0 +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" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="compute-disk-service-offerings">
<title>Compute and Disk Service Offerings</title>
<para>A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The CloudPlatform administrator can set up various offerings, and then end users choose from the available offerings when they create a new VM. A service offering includes the following elements:</para>
<itemizedlist>
<listitem><para>CPU, memory, and network resource guarantees</para></listitem>
<listitem><para>How resources are metered</para></listitem>
<listitem><para>How the resource usage is charged</para></listitem>
<listitem><para>How often the charges are generated</para></listitem>
</itemizedlist>
<para>For example, one service offering might allow users to create a virtual machine instance that is equivalent to a 1 GHz Intel® Core™ 2 CPU, with 1 GB memory at $0.20/hour, with network traffic metered at $0.10/GB. Based on the user’s selected offering, CloudPlatform emits usage records that can be integrated with billing systems. CloudPlatform separates service offerings into compute offerings and disk offerings. The computing service offering specifies:</para>
<itemizedlist>
<listitem><para>Guest CPU</para></listitem>
<listitem><para>Guest RAM</para></listitem>
<listitem><para>Guest Networking type (virtual or direct)</para></listitem>
<listitem><para>Tags on the root disk</para></listitem>
</itemizedlist>
<para>The disk offering specifies:</para>
<itemizedlist>
<listitem><para>Disk size (optional). An offering without a disk size will allow users to pick their own</para></listitem>
<listitem><para>Tags on the data disk</para></listitem>
</itemizedlist>
</section>

11
docs/en-US/concepts.xml Normal file
View File

@ -0,0 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<chapter id="concepts">
<title>Concepts</title>
<xi:include href="whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="feature-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="deployment-architecture-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

31
docs/en-US/configure-guest-traffic-in-advanced-zone.xml Normal file
View File

@ -0,0 +1,31 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configure-guest-traffic-in-advanced-zone">
<title>Configure Guest Traffic in an Advanced Zone</title>
<para>These steps assume you have already logged in to the CloudPlatform UI. To configure the base guest network:</para>
<orderedlist>
<listitem><para>In the left navigation, choose Infrastructure. On Zones, click View More, then click the zone to which you want to add a network.</para></listitem>
<listitem><para>Click the Network tab.</para></listitem>
<listitem><para>Click Add network.</para></listitem>
<listitem><para>Provide the following information:</para>
<itemizedlist>
<listitem><para>Name. The name of the network. This will be user-visible</para></listitem>
<listitem><para>Description: The description of the network. This will be user-visible</para></listitem>
<listitem><para>VLAN ID: Enter an administrator-configured VLAN ID so you can create different networks for use by different VM users in the zone</para></listitem>
<listitem><para>Scope: Choose account-specific or domain-specific if you would like to make the network accessible to only a single account or domain. Choose zone-wide if all accounts with access to the zone should be able to access the network.</para></listitem>
<listitem><para>Domain/Account: If Scope is account-specific, enter the domain and account name for the account</para></listitem>
<listitem><para>Network offering: If the administrator has configured multiple network offerings, select the one you want to use for this network</para></listitem>
<listitem><para>Gateway: The gateway that the guests should use</para></listitem>
<listitem><para>Netmask: The netmask in use on the subnet the guests will use</para></listitem>
<listitem><para>Start IP/End IP: Enter the first and last IP addresses that define a range that CloudPlatform can assign to guests. If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. If multiple NICs are used, they may be in a different subnet.</para></listitem>
<listitem><para>Network Domain: (Optional) If you want to assign a special domain name to this network, specify the DNS suffix.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

10
docs/en-US/configure-public-traffic-in-an-advanced-zone.xml Normal file
View File

@ -0,0 +1,10 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configure-public-traffic-in-an-advanced-zone">
<title>Configure Public Traffic in an Advanced Zone</title>
<para>In a zone that uses advanced networking, you need to configure at least one range of IP addresses for Internet traffic.</para>
</section>

82
docs/en-US/configure-usage-server.xml Normal file
View File

@ -0,0 +1,82 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configure-usage-server">
<title>Configuring the Usage Server</title>
<para>To configure the usage server:</para>
<orderedlist>
<listitem><para>Be sure the Usage Server has been installed. This requires extra steps beyond just installing the CloudPlatform software. See Installing the Usage Server (Optional) in the Advanced Installation Guide.</para></listitem>
<listitem><para>Log in to the CloudPlatform UI as administrator.</para></listitem>
<listitem><para>Click Global Settings.</para></listitem>
<listitem><para>In Search, type usage. Find the configuration parameter that controls the behavior you want to set. See the table below for a description of the available parameters.</para></listitem>
<listitem><para>In Actions, click the Edit icon.</para></listitem>
<listitem><para>Type the desired value and click the Save icon.</para></listitem>
<listitem><para>Restart the Management Server (as usual with any global configuration change) and also the Usage Server:</para>
<programlisting># service cloud-management restart
# service cloud-usage restart
</programlisting></listitem>
</orderedlist>
<para>The following table shows the global configuration settings that control the behavior of the Usage Server.</para>
<informaltable>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>Parameter Name</para></entry>
<entry><para>Description</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>enable.usage.server</para></entry>
<entry><para>Whether the Usage Server is active.</para></entry>
</row>
<row>
<entry><para>usage.aggregation.timezone</para></entry>
<entry><para>Time zone of usage records. Set this if the usage records and daily job execution are in different time zones. For example, with the following settings, the usage job will run at PST 00:15 and generate usage records for the 24 hours from 00:00:00 GMT to 23:59:59 GMT:</para>
<programlisting>usage.stats.job.exec.time = 00:15
usage.execution.timezone = PST
usage.aggregation.timezone = GMT
</programlisting>
<para>Valid values for the time zone are specified in <xref linkend="appendix-a-time-zones"/></para>
<para>Default: GMT</para>
</entry>
</row>
<row>
<entry><para>usage.execution.timezone</para></entry>
<entry><para>The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in <xref linkend="appendix-a-time-zones"/></para>
<para>Default: The time zone of the management server.</para>
</entry>
</row>
<row>
<entry><para>usage.sanity.check.interval</para></entry>
<entry><para>The number of days between sanity checks. Set this in order to periodically search for records with erroneous data before issuing customer invoices. For example, this checks for VM usage records created after the VM was destroyed, and similar checks for templates, volumes, and so on. It also checks for usage times longer than the aggregation range. If any issue is found, the alert ALERT_TYPE_USAGE_SANITY_RESULT = 21 is sent.</para></entry>
</row>
<row>
<entry><para>usage.stats.job.aggregation.range</para></entry>
<entry><para>The time period in minutes between Usage Server processing jobs. For example, if you set it to 1440, the Usage Server will run once per day. If you set it to 600, it will run every ten hours. In general, when a Usage Server job runs, it processes all events generated since usage was last run.</para>
<para>There is special handling for the case of 1440 (once per day). In this case the Usage Server does not necessarily process all records since Usage was last run. CloudPlatform assumes that you require processing once per day for the previous, complete day’s records. For example, if the current day is October 7, then it is assumed you would like to process records for October 6, from midnight to midnight. CloudPlatform assumes this “midnight to midnight” is relative to the usage.execution.timezone.</para>
<para>Default: 1440</para>
</entry>
</row>
<row>
<entry><para>usage.stats.job.exec.time</para></entry>
<entry><para>The time when the Usage Server processing will start. It is specified in 24-hour format (HH:MM) in the time zone of the server, which should be GMT. For example, to start the Usage job at 10:30 GMT, enter “10:30”.</para>
<para>If usage.stats.job.aggregation.range is also set, and its value is not 1440, then its value will be added to usage.stats.job.exec.time to get the time to run the Usage Server job again. This is repeated until 24 hours have elapsed, and the next day's processing begins again at usage.stats.job.exec.time.</para>
<para>Default: 00:15.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>For example, suppose that your server is in GMT, your user population is predominantly in the East Coast of the United States, and you would like to process usage records every night at 2 AM local (EST) time. Choose these settings:</para>
<itemizedlist>
<listitem><para>enable.usage.server = true</para></listitem>
<listitem><para>usage.execution.timezone = America/New_York</para></listitem>
<listitem><para>usage.stats.job.exec.time = 07:00. This will run the Usage job at 2:00 AM EST. Note that this will shift by an hour as the East Coast of the U.S. enters and exits Daylight Savings Time.</para></listitem>
<listitem><para>usage.stats.job.aggregation.range = 1440</para></listitem>
</itemizedlist>
<para>With this configuration, the Usage job will run every night at 2 AM EST and will process records for the previous day’s midnight-midnight as defined by the EST (America/New_York) time zone.</para>
<note><para>Because the special value 1440 has been used for usage.stats.job.aggregation.range, the Usage Server will ignore the data between midnight and 2 AM. That data will be included in the next day's run</para></note>
</section>

17
docs/en-US/configure-virtual-router.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configure-virtual-router">
<title>Configuring the Virtual Router</title>
<para>You can set the following:</para>
<itemizedlist>
<listitem><para>IP range</para></listitem>
<listitem><para>Supported network services</para></listitem>
<listitem><para>Default domain name for the network serviced by the virtual router</para></listitem>
<listitem><para>Gateway IP address</para></listitem>
<listitem><para>How often CloudPlatform fetches network usage statistics from CloudPlatform virtual routers. If you want to collect traffic metering data from the virtual router, set the global configuration parameter router.stats.interval. If you are not using the virtual router to gather network usage statistics, set it to 0.</para></listitem>
</itemizedlist>
</section>

33
docs/en-US/configure-vpn.xml Normal file
View File

@ -0,0 +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" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configure-vpn">
<title>Configuring VPN</title>
<para>To set up VPN for the cloud:</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, click Global Settings.</para></listitem>
<listitem><para>Set the following global configuration parameters.</para>
<itemizedlist>
<listitem><para>remote.access.vpn.client.ip.range – The range of IP addressess to be allocated to remote access VPN clients. The first IP in the range is used by the VPN server.</para></listitem>
<listitem><para>remote.access.vpn.psk.length – Length of the IPSec key.</para></listitem>
<listitem><para>remote.access.vpn.user.limit – Maximum number of VPN users per account.</para></listitem>
</itemizedlist></listitem></orderedlist>
<para>To enable VPN for a particular network:</para>
<orderedlist>
<listitem><para>Log in as a user or administrator to the CloudPlatform UI.</para></listitem>
<listitem><para>In the left navigation, click Network.</para></listitem>
<listitem><para>Click the name of the network you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click one of the displayed IP address names.</para></listitem>
<listitem><para>Click the Enable VPN button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/vpn-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para>
<para>The IPsec key is displayed in a popup window.</para></listitem>
</orderedlist>
</section>

10
docs/en-US/configure-xenserver-dom-memory.xml Normal file
View File

@ -0,0 +1,10 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configure-xenserver-dom0-memory">
<title>Configure XenServer dom0 Memory</title>
<para>Configure the XenServer dom0 settings to allocate more memory to dom0. This can enable XenServer to handle larger numbers of virtual machines. We recommend 2940 MB of RAM for XenServer dom0. For instructions on how to do this, see <ulink url="http://support.citrix.com/article/CTX126531">Citrix Knowledgebase Article</ulink>.The article refers to XenServer 5.6, but the same information applies to XenServer 6</para>
</section>

10
docs/en-US/configure-xenserver-dom0-memory.xml Normal file
View File

@ -0,0 +1,10 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configure-xenserver-dom0-memory">
<title>Configure XenServer dom0 Memory</title>
<para>Configure the XenServer dom0 settings to allocate more memory to dom0. This can enable XenServer to handle larger numbers of virtual machines. We recommend 2940 MB of RAM for XenServer dom0. For instructions on how to do this, see <ulink url="http://support.citrix.com/article/CTX126531">Citrix Knowledgebase Article</ulink>.The article refers to XenServer 5.6, but the same information applies to XenServer 6</para>
</section>

10
docs/en-US/configuring-projects.xml Normal file
View File

@ -0,0 +1,10 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="configuring-projects">
<title>Configuring Projects</title>
<para>Before CloudPlatform users start using projects, the CloudPlatform administrator must set up various systems to support them, including membership invitations, limits on project resources, and controls on who can create projects</para>
</section>

16
docs/en-US/console-proxy.xml Normal file
View File

@ -0,0 +1,16 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="console-proxy">
<title>Console Proxy</title>
<para>The Console Proxy is a type of System Virtual Machine that has a role in presenting a console view via the web UI. It connects the user’s browser to the VNC port made available via the hypervisor for the console of the guest. Both the administrator and end user web UIs offer a console connection.</para>
<para>Clicking on a console icon brings up a new window. The AJAX code downloaded into that window refers to the public IP address of a console proxy VM. There is exactly one public IP address allocated per console proxy VM. The AJAX application connects to this IP. The console proxy then proxies the connection to the VNC port for the requested VM on the Host hosting the guest. .</para>
<note><para>The hypervisors will have many ports assigned to VNC usage so that multiple VNC sessions can occur simultaneously.</para></note>
<para>There is never any traffic to the guest virtual IP, and there is no need to enable VNC within the guest.</para>
<para>The console proxy VM will periodically report its active session count to the Management Server. The default reporting interval is five seconds. This can be changed through standard Management Server configuration with the parameter consoleproxy.loadscan.interval.</para>
<para>Assignment of guest VM to console proxy is determined by first determining if the guest VM has a previous session associated with a console proxy. If it does, the Management Server will assign the guest VM to the target Console Proxy VM regardless of the load on the proxy VM. Failing that, the first available running Console Proxy VM that has the capacity to handle new sessions is used.</para>
<para>Console proxies can be restarted by administrators but this will interrupt existing console sessions for users.</para>
<para>The console viewing functionality uses a dynamic DNS service under the domain name realhostip.com to assist in providing SSL security to console sessions. The console proxy is assigned a public IP address. In order to avoid browser warnings for mismatched SSL certificates, the URL for the new console window is set to the form of https://aaa-bbb-ccc-ddd.realhostip.com. Customers will see this URL during console session creation. CloudPlatform includes the realhostip.com SSL certificate in the console proxy VM. Of course, CloudPlatform cannot know about DNS A records for our customers' public IPs prior to shipping the software. CloudPlatform therefore runs a dynamic DNS server that is authoritative for the realhostip.com domain. It maps the aaa-bbb-ccc-ddd part of the DNS name to the IP address aaa.bbb.ccc.ddd on lookups. This allows the browser to correctly connect to the console proxy's public IP, where it then expects and receives a SSL certificate for realhostip.com, and SSL is set up without browser warnings.</para>
</section>

5
docs/en-US/contacting-support.xml Normal file
View File

@ -0,0 +1,5 @@
<section id="contacting-support">
<title>Contacting Support</title>
<para>The support team is available to help customers plan and execute their installations. To contact the support team, log in to the support portal at <ulink url="support.citrix.com/cloudsupport">support.citrix.com/cloudsupport</ulink> by using the account credentials you received when you purchased your support contract.</para>
</section>

50
docs/en-US/convert-hyperv-vm-to-template.xml Normal file
View File

@ -0,0 +1,50 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="convert-hyperv-vm-to-template">
<title>Converting a Hyper-V VM to a Template</title>
<para>To convert a Hyper-V VM to a XenServer-compatible CloudPlatform template, you will need a standalone XenServer host with an attached NFS VHD SR. Use whatever XenServer version you are using with CloudPlatform, but use XenCenter 5.6 FP1 or SP2 (it is backwards compatible to 5.6). Additionally, it may help to have an attached NFS ISO SR.</para>
<para>For Linux VMs, you may need to do some preparation in Hyper-V before trying to get the VM to work in XenServer. Clone the VM and work on the clone if you still want to use the VM in Hyper-V. Uninstall Hyper-V Integration Components and check for any references to device names in /etc/fstab:</para>
<orderedlist>
<listitem><para>From the linux_ic/drivers/dist directory, run make uninstall (where "linux_ic" is the path to the copied Hyper-V Integration Components files).</para></listitem>
<listitem><para>Restore the original initrd from backup in /boot/ (the backup is named *.backup0).</para></listitem>
<listitem><para>Remove the "hdX=noprobe" entries from /boot/grub/menu.lst.</para></listitem>
<listitem><para>Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to mount by LABEL or UUID (get that information with the "blkid" command)..</para></listitem>
</orderedlist>
<para>The next step is make sure the VM is not running in Hyper-V, then get the VHD into XenServer. There are two options for doing this.</para>
<para>Option one:</para>
<orderedlist>
<listitem><para>Import the VHD using XenCenter. In XenCenter, go to Tools&gt;Virtual Appliance Tools&gt;Disk Image Import.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Name the VM, choose the NFS VHD SR under Storage, enable "Run Operating System Fixups" and choose the NFS ISO SR.</para></listitem>
<listitem><para>Click Next, then Finish. A VM should be created.</para></listitem>
</orderedlist>
<para>Option two</para>
<orderedlist>
<listitem><para>Run XenConvert, under From choose VHD, under To choose XenServer. Click Next.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Input the XenServer host info, then click Next.</para></listitem>
<listitem><para>Name the VM, then click Next, then Convert. A VM should be created</para></listitem>
</orderedlist>
<para>Once you have a VM created from the Hyper-V VHD, prepare it using the following steps:</para>
<orderedlist>
<listitem><para>Boot the VM, uninstall Hyper-V Integration Services, and reboot.</para></listitem>
<listitem><para>Install XenServer Tools, then reboot.</para></listitem>
<listitem><para>Prepare the VM as desired. For example, run sysprep on Windows VMs. See <xref linkend="create-windows-template"/></para></listitem>
</orderedlist>
<para>Either option above will create a VM in HVM mode. This is fine for Windows VMs, but Linux VMs may not perform optimally. Converting a Linux VM to PV mode will require additional steps and will vary by distribution.</para>
<orderedlist>
<listitem><para>Shut down the VM and copy the VHD from the NFS storage to a web server; for example, mount the NFS share on the web server and copy it, or from the XenServer host use sftp or scp to upload it to the web server.</para></listitem>
<listitem><para>In CloudPlatform, create a new template using the following values:</para>
<itemizedlist>
<listitem><para>URL. Give the URL for the VHD</para></listitem>
<listitem><para>OS Type. Use the appropriate OS. For PV mode on CentOS, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServer.</para></listitem>
<listitem><para>Hypervisor. XenServer</para></listitem>
<listitem><para>Format. VHD</para></listitem>
</itemizedlist></listitem>
</orderedlist>
<para>The template will be created, and you can create instances from it.</para>
</section>

31
docs/en-US/create-bare-metal-template.xml Normal file
View File

@ -0,0 +1,31 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="create-bare-metal-template">
<title>Creating a Bare Metal Template</title>
<note><para><emphasis role="bold">Beta feature. Untested in CloudPlatform 3.0.3. Provided without guarantee of performance</emphasis>.</para></note>
<para>Before you can create a bare metal template, you must have performed several other installation and setup steps to create a bare metal cluster and environment. See Bare Metal Installation in the Installation Guide. It is assumed you already have a directory named "win7_64bit" on your CIFS server, containing the image for the bare metal instance. This directory and image are set up as part of the Bare Metal Installation procedure.</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>Click Create Template.</para></listitem>
<listitem><para>In the dialog box, enter the following values.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name</emphasis>. Short name for the template.</para></listitem>
<listitem><para><emphasis role="bold">Display Text</emphasis>. Description of the template.</para></listitem>
<listitem><para><emphasis role="bold">URL</emphasis>. The directory name which contains image file on your
CIFS server. For example, win7_64bit.</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>. All Zones.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. Select the OS type of the ISO image. Choose other if
the OS Type of the ISO is not listed or if the ISO is not bootable.</para></listitem>
<listitem><para><emphasis role="bold">Hypervisor</emphasis>. BareMetal.</para></listitem>
<listitem><para><emphasis role="bold">Format</emphasis>. BareMetal.</para></listitem>
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. No.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. No.</para></listitem>
<listitem><para><emphasis role="bold">Featured</emphasis>. Choose Yes if you would like this template to be
more prominent for users to select. Only administrators may make templates
featured.</para></listitem>
</itemizedlist></listitem></orderedlist>
</section>

19
docs/en-US/create-new-projects.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="create-new-projects">
<title>Creating a New Project</title>
<para>CloudPlatform administrators and domain administrators can create projects. If the global configuration parameter allow.user.create.projects is set to true, end users can also create projects.</para>
<orderedlist>
<listitem><para>Log in as administrator to the CloudPlatform UI.</para></listitem>
<listitem><para>In the left navigation, click Projects.</para></listitem>
<listitem><para>In Select view, click Projects.</para></listitem>
<listitem><para>Click New Project.</para></listitem>
<listitem><para>Give the project a name and description for display to users, then click Create Project.</para></listitem>
<listitem><para>A screen appears where you can immediately add more members to the project. This is optional. Click Next when you are ready to move on.</para></listitem>
<listitem><para>Click Save.</para></listitem>
</orderedlist>
</section>

38
docs/en-US/create-template-from-existing-vm.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="create-template-from-existing-vm">
<title>Creating a Template from an Existing Virtual Machine</title>
<para>Once you have at least one VM set up in the way you want, you can use it as the prototype for other VMs.</para>
<orderedlist>
<listitem><para>Create and start a virtual machine using any of the techniques given in <xref linkend="creating-vms"/>.</para></listitem>
<listitem><para>Make any desired configuration changes on the running VM, then click Stop.</para></listitem>
<listitem><para>Wait for the VM to stop. When the status shows Stopped, go to the next step.</para></listitem>
<listitem><para>Click Create Template and provide the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so
choose something descriptive.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. This helps CloudPlatform and the hypervisor perform
certain operations and make assumptions that improve the performance of the
guest. Select one of the following.</para>
<itemizedlist>
<listitem><para>If the operating system of the stopped VM is listed, choose it.</para></listitem>
<listitem><para>If the OS type of the stopped VM is not listed, choose Other.</para></listitem>
<listitem><para>If you want to boot from this template in PV mode, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere:</para>
<note><para>Note: Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all
users of this CloudPlatform installation. The template will appear in the
Community Templates list. See <xref linkend="private-public-template"
/>.</para></listitem>
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. Choose Yes if your template has the
CloudPlatform password change script installed. See Adding Password
Management to Your Templates .</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
<para>The new template will be visible in the Templates section when the template creation process has been completed. The template is then available when creating a new VM</para>
</section>

11
docs/en-US/create-template-from-snapshot.xml Normal file
View File

@ -0,0 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="create-template-from-snapshot">
<title>Creating a Template from a Snapshot</title>
<note><para>Not supported by Oracle VM</para></note>
<para>If you do not want to stop the VM in order to use the Create Template menu item (as described in <xref linkend="create-template-from-existing-vm"/>), you can create a template directly from any snapshot through the CloudPlatform UI.</para>
</section>

17
docs/en-US/create-templates-overview.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<section id="create-templates-overview">
<title>Creating Templates: Overview</title>
<para>CloudPlatform ships with a default template for the CentOS operating system. There are a variety of ways to add more templates. Administrators and end users can add templates. The typical sequence of events is:</para>
<orderedlist>
<listitem><para>Launch a VM instance that has the operating system you want. Make any other desired configuration changes to the VM.</para></listitem>
<listitem><para>Stop the VM.</para></listitem>
<listitem><para>Convert the volume into a template.</para></listitem>
</orderedlist>
<para>There are other ways to add templates to CloudPlatform. For example, you can take a snapshot of the VM's volume and create a template from the snapshot, or import a VHD from another system into CloudPlatform</para>
<para>The various techniques for creating templates are described in the next few sections.</para>
</section>

Some files were not shown because too many files have changed in this diff Show More