apache/cloudstack
1
0
Fork 0
mirror of https://github.com/apache/cloudstack.git synced 2025-10-26 08:42:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Feature Documentation for s2svpn interVlan and Autoscale

Browse Source
This commit is contained in:
Radhika Puthiyetath 2012-09-11 14:23:59 +05:30 committed by Pranav Saxena
parent 87ecde648f
commit 4a8bb9dfc7
149 changed files with 5092 additions and 4360 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en-US/LDAPserver-for-user-authentication.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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 &PRODUCT; end-users. Just map &PRODUCT; 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 &PRODUCT; for matching common values such as the user’s email address and name. &PRODUCT; 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>
@ -37,4 +36,4 @@
<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>
</section>

2
docs/en-US/about-clusters.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

4
docs/en-US/about-hosts.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -28,7 +28,7 @@
<para>The host is the smallest organizational unit within a &PRODUCT; deployment. Hosts are contained within clusters, clusters are contained within pods, and pods are contained within zones.</para>
<para>Hosts in a &PRODUCT; deployment:</para>
<itemizedlist>
<listitem><para>Provde the CPU, memory, storage, and networking resources needed to host the virtual machines</para></listitem>
<listitem><para>Provide the CPU, memory, storage, and networking resources needed to host the virtual machines</para></listitem>
<listitem><para>Interconnect using a high bandwidth TCP/IP network and connect to the Internet</para></listitem>
<listitem><para>May reside in multiple data centers across different geographic locations</para></listitem>
<listitem><para>May have different capacities (different CPU speeds, different amounts of RAM, etc.), although the hosts within a cluster must all be homogeneous</para></listitem>

4
docs/en-US/about-physical-networks.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="about-physical-networks">
<title>About Physical Networks</title>
<para>Part of adding a zone is setting up the physical network. One or (in an advanced zone) more physical networks can be associated with each zone. The network corresponds to a NIC on the hypervisor host. Each physical network can carry one or more types of network traffic. The choices of traffic type for each network vary depending on whether you are creating a zone with basic networking or advanced networking.</para>
@ -34,7 +33,6 @@
<listitem><para>Configure the IP addresses trunked to a physical network</para></listitem>
<listitem><para>Specify what type of traffic is carried on the physical network, as well as other properties like network speed</para></listitem>
</itemizedlist>
<xi:include href="physical-network-configuration-settings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="basic-zone-network-traffic-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="basic-zone-guest-ip-addresses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="advanced-zone-network-traffic-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

11
docs/en-US/about-pods.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -24,10 +24,11 @@
<section id="about-pods">
<title>About Pods</title>
<para>A pod often represents a single rack. Hosts in the same pod are in the same subnet.</para>
<para>A pod is the second-largest organizational unit within a &PRODUCT; deployment. Pods are contained within zones. Each zone can contain one or more pods.</para>
<para>Pods are not visible to the end user.</para>
<para>A pod consists of one or more clusters of hosts and one or more primary storage servers.</para>
<para>A pod often represents a single rack. Hosts in the same pod are in the same subnet.
A pod is the second-largest organizational unit within a &PRODUCT; deployment. Pods are contained within zones. Each zone can contain one or more pods.
A pod consists of one or more clusters of hosts and one or more primary storage servers.
Pods are not visible to the end user.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/pod-overview.png" />

2
docs/en-US/about-primary-storage.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

2
docs/en-US/about-secondary-storage.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

9
docs/en-US/about-virtual-networks.xml
View File

@ -21,11 +21,10 @@
specific language governing permissions and limitations
under the License.
-->
<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 &PRODUCT;, 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>
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT; a virtual network can be shared or isolated.</para>
<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="runtime-allocation-virtual-network-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

6
docs/en-US/about-working-with-vms.xml
View File

@ -27,9 +27,9 @@
<para>&PRODUCT; provides administrators with complete control over the lifecycle of all guest VMs executing in the cloud. &PRODUCT; 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 &PRODUCT; 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 &ndash; a unique, immutable ID that is generated by &PRODUCT; and can not be modified by the user. This name conforms to the requirements in IETF RFC 1123.</para></listitem>
<listitem><para>Display name &ndash; the name displayed in the &PRODUCT; web UI. Can be set by the user. Defaults to instance name.</para></listitem>
<listitem><para>Name &ndash; host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name</para></listitem>
<listitem><para>Instance name – a unique, immutable ID that is generated by &PRODUCT;, 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 &PRODUCT; 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, &PRODUCT; automatically creates a static NAT between this public IP address and the private IP address of the VM.</para>

5
docs/en-US/about-zones.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="about-zones">
<title>About Zones</title>
<para>A zone is the largest organizational unit within a &PRODUCT; deployment. A zone typically corresponds to a single datacenter, although it is permissible to have multiple zones in a datacenter. The benefit of organizing infrastructure into zones is to provide physical isolation and redundancy. For example, each zone can have its own power supply and network uplink, and the zones can be widely separated geographically (though this is not required).</para>
@ -34,7 +33,7 @@
<imageobject>
<imagedata fileref="./images/zone-overview.png" />
</imageobject>
<textobject><phrase>zone-overview.png: Nested structure of a simple zone</phrase></textobject>
<textobject><phrase>zone-overview.png: Nested structure of a simple zone.</phrase></textobject>
</mediaobject>
<para>Zones are visible to the end user. When a user starts a guest VM, the user must select a zone for their guest. Users might also be required to copy their private templates to additional zones to enable creation of guest VMs using their templates in those zones.</para>
<para>Zones can be public or private. Public zones are visible to all users. This means that any user may create a guest in that zone. Private zones are reserved for a specific domain. Only users in that domain or its subdomains may create guests in that zone.</para>

10
docs/en-US/accessing-vms.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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>
@ -29,7 +28,14 @@
<orderedlist>
<listitem><para>Log in to the &PRODUCT; 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>
<listitem><para>Click the View Console <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/console-icon.png"/>
</imageobject>
<textobject>
<phrase>consoleicon.png: button to view the console.</phrase>
</textobject>
</inlinemediaobject></para></listitem>
</orderedlist>
<para>To access a VM directly over the network:</para>
<orderedlist>

1
docs/en-US/accounts-users-domains.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="accounts-users-domains">
<title>Accounts, Users, and Domains</title>
<formalpara>

5
docs/en-US/accounts.xml
View File

@ -22,7 +22,8 @@
under the License.
-->
<section id="accounts">
<chapter id="accounts">
<title>Accounts</title>
<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>
</chapter>

28
docs/en-US/add-additional-guest-network.xml
View File

@ -21,23 +21,27 @@
specific language governing permissions and limitations
under the License.
-->
<section id="add-additional-guest-network">
<title>Adding an Additional Guest Network</title>
<itemizedlist>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</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 &PRODUCT; 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><emphasis role="bold">Name</emphasis>: The name of the network. This will be user-visible. </para></listitem>
<listitem><para><emphasis role="bold">Display Text</emphasis>: The description of the network. This will be
user-visible.</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>. The name of the zone this network applies to. Each zone is a broadcast domain, and therefore each zone has a different
IP range for the guest network. The administrator must configure the IP
range for each zone.</para></listitem>
<listitem><para><emphasis role="bold">Network offering</emphasis>: If the administrator has configured
multiple network offerings, select the one you want to use for this
network.</para></listitem>
<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>
</itemizedlist></listitem>
<listitem><para>Click Create.</para></listitem>
</itemizedlist>
</orderedlist>
</section>

61
docs/en-US/add-ingress-egress-rules.xml
View File

@ -24,18 +24,35 @@
<section id="add-ingress-egress-rules">
<title>Adding Ingress and Egress Rules to a Security Group</title>
<itemizedlist>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; 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 &PRODUCT; 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 &PRODUCT; 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>
<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 &PRODUCT; 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 &PRODUCT; 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>
@ -47,13 +64,29 @@
</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 &PRODUCT; 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 &PRODUCT; 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>
<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 &PRODUCT; 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 &PRODUCT;
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>
</orderedlist>
</section>

40
docs/en-US/add-iso.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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>
@ -32,12 +31,21 @@
<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 &PRODUCT;.</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 &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following.</para>
<listitem><para><emphasis role="bold">Name</emphasis>: Short name for the ISO image. For example, CentOS 6.2
64-bit.</para></listitem>
<listitem><para><emphasis role="bold">Description</emphasis>: Display test for the ISO image. For example,
CentOS 6.2 64-bit.</para></listitem>
<listitem><para><emphasis role="bold">URL</emphasis>: 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><emphasis role="bold">Zone</emphasis>: Choose the zone where you want the ISO to be available,
or All Zones to make it available throughout &PRODUCT;.</para></listitem>
<listitem><para><emphasis role="bold">Bootable</emphasis>: 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><emphasis role="bold">OS Type</emphasis>: This helps &PRODUCT; 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>
@ -77,15 +85,23 @@
</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>
<note><para>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>
<listitem><para><emphasis role="bold">Extractable</emphasis>: Choose Yes if the ISO should be available for
extraction.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>: Choose Yes if this ISO should be available to other
users.</para></listitem>
<listitem><para><emphasis role="bold">Featured</emphasis>: 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 &PRODUCT; can work with it</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 &PRODUCT; can work with it.</para></listitem>
</orderedlist>
</section>

28
docs/en-US/add-load-balancer-rule.xml
View File

@ -30,14 +30,28 @@
<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>
<listitem><para>In the Load Balancing node of the diagram, click View All.</para>
<para>In a Basic zone, you can also create a load balancing rule without acquiring or selecting an
IP address. &PRODUCT; internally assign an IP when you create the load balancing
rule, which is listed in the IP Addresses page when the rule is created. </para>
<para>To do that, select the name of the network, then click Add Load Balancer tab. Continue with
<xref linkend="config-lb"/>.</para></listitem>
<listitem id="config-lb"><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 &PRODUCT; to use. &PRODUCT; 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>
<listitem><para><emphasis role="bold">Name</emphasis>: A name for the load balancer rule.</para></listitem>
<listitem><para><emphasis role="bold">Public Port</emphasis>: The port receiving incoming traffic to be
balanced.</para></listitem>
<listitem><para><emphasis role="bold">Private Port</emphasis>: The port that the VMs will use to receive the
traffic.</para></listitem>
<listitem><para><emphasis role="bold">Algorithm</emphasis>: Choose the load balancing algorithm you want
&PRODUCT; to use. &PRODUCT; 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><emphasis role="bold">Stickiness</emphasis>: (Optional) Click Configure and choose the
algorithm for the stickiness policy. See Sticky Session Policies for Load
Balancer Rules.</para></listitem>
<listitem><para><emphasis role="bold">AutoScale</emphasis>: Click Configure and complete the AutoScale
configuration as explained in <xref linkend="autoscale"/>.</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>

6
docs/en-US/add-security-group.xml
View File

@ -24,8 +24,8 @@
<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>
<para>A user or administrator can define a new security group.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; 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>
@ -34,6 +34,6 @@
<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>
</orderedlist>
</section>

139
docs/en-US/advanced-zone-configuration.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,162 +21,257 @@
specific language governing permissions and limitations
under the License.
-->
<section id="advanced-zone-configuration">
<title>Advanced Zone Configuration</title>
<orderedlist>
<listitem><para>After you select Advanced 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">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">Guest CIDR.</emphasis> This is the CIDR that describes the IP addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. As a matter of good practice you should set different CIDRs for different zones. This will make it easier to set up VPNs between networks in different zones.</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">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 <xref linkend="advanced-zone-network-traffic-types" />. This screen starts out with one network already configured. If you have multiple physical networks, you need to add more. Drag and drop traffic types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual setup, you can move them down. You can also change the network names if desired.</para>
</listitem>
<listitem><para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on each 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 within each physical network. 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>Configure the IP range for public Internet traffic. Enter the following details, then click Add. If desired, you can repeat this step to add more public Internet 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 networks.</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 <xref linkend="system-reserved-ip-addresses" />.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN Allocation Example ), then click Next.</para>
</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 <xref linkend="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 <xref linkend="about-hosts" />.</para>
<note><para>When you deploy &PRODUCT;, the hypervisor 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 for &PRODUCT;</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>
<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> Usually 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 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, both in the Administration Guide.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see <xref linkend="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>
<informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<tbody>
<row>
<entry><para>NFS</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>iSCSI</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Target IQN.</emphasis> The IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para></listitem>
<listitem><para><emphasis role="bold">Lun.</emphasis> The LUN number. For example, 3.</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>preSetup</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">SR Name-Label.</emphasis> Enter the name-label of the SR that has been set up outside &PRODUCT;.</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>SharedMountPoint</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Path.</emphasis> The path on each host that is where this primary storage is mounted. For example, "/mnt/primary".</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>VMFS</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the vCenter server.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> A combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new zone, &PRODUCT; adds the first secondary storage server for you. For an overview of what secondary storage is, see <xref linkend="about-secondary-storage" />.</para>
<para>Before you can fill out this screen, you need to prepare the secondary storage by setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding Secondary Storage :</para>
<itemizedlist>
<listitem><para><emphasis role="bold">NFS Server.</emphasis> The IP address of the server.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click Launch.</para>
</listitem>
</orderedlist>
</section>

3
docs/en-US/advanced-zone-guest-ip-addresses.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="advanced-zone-guest-ip-addresses">
<title>Advanced Zone Guest IP Addresses</title>
<para>When advanced networking is used, the administrator can create additional networks for use by the guests. These networks can span the zone and be available to all accounts, or they can be scoped to a single account, in which case only the named account may create guests that attach to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The administrator may provision thousands of these networks if desired.</para>

3
docs/en-US/advanced-zone-network-traffic-types.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="advanced-zone-network-traffic-types">
<title>Advanced Zone Network Traffic Types</title>
<para>When advanced networking is used, there can be multiple physical networks in the zone. Each physical network can carry one or more traffic types, and you need to let &PRODUCT; know which type of network traffic you want each network to carry. The traffic types in an advanced zone are:</para>

5
docs/en-US/advanced-zone-physical-network-configuration.xml
View File

@ -21,8 +21,9 @@
specific language governing permissions and limitations
under the License.
-->
<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>
<xi:include href="configure-guest-traffic-in-advanced-zone.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="configure-public-traffic-in-an-advanced-zone.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

3
docs/en-US/advanced-zone-public-ip-addresses.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="advanced-zone-public-ip-addresses">
<title>Advanced Zone Public IP Addresses</title>
<para>When advanced networking is used, the administrator can create additional networks for use by the guests. These networks can span the zone and be available to all accounts, or they can be scoped to a single account, in which case only the named account may create guests that attach to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The administrator may provision thousands of these networks if desired.</para>

10
docs/en-US/alerts.xml
View File

@ -1,3 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@ -16,7 +22,7 @@
under the License.
-->
<section id="alerts">
<appendix 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>
@ -45,5 +51,5 @@
<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>
</appendix>

11
docs/en-US/attach-iso-to-vm.xml
View File

@ -21,19 +21,20 @@
specific language governing permissions and limitations
under the License.
-->
<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>
<listitem><para>Click the Attach ISO button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/iso-icon.png" />
<imagedata fileref="./images/iso-icon.png"/>
</imageobject>
<textobject><phrase>iso.png: Depicts adding an iso image</phrase></textobject>
<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>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

11
docs/en-US/automatic-snapshot-creation-retention.xml
View File

@ -24,7 +24,14 @@
<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>(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 &PRODUCT; 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>
<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 &PRODUCT;
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>

7
docs/en-US/basic-zone-configuration.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="basic-zone-configuration">
<title>Basic Zone Configuration</title>
<orderedlist>
@ -66,7 +65,7 @@
<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>(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>
<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>
@ -136,7 +135,7 @@
<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>
<listitem><para>In a new cluster, &PRODUCT; 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>

5
docs/en-US/basic-zone-guest-ip-addresses.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,8 +21,7 @@
specific language governing permissions and limitations
under the License.
-->
<section id="basic-zone-guest-ip-addresses">
<title>Basic Zone Guest IP Addresses</title>
<para>When basic networking is used, CloudPlatform will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para>
<para>When basic networking is used, &PRODUCT; will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para>
</section>

3
docs/en-US/basic-zone-network-traffic-types.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="basic-zone-network-traffic-types">
<title>Basic Zone Network Traffic Types</title>
<para>When basic networking is used, there can be only one physical network in the zone. That physical network carries the following traffic types:</para>

6
docs/en-US/basic-zone-physical-network-configuration.xml
View File

@ -21,9 +21,7 @@
specific language governing permissions and limitations
under the License.
-->
<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>
<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 &PRODUCT;, you set up the guest network through the Add Zone screens.</para>
</section>

25
docs/en-US/best-practices-for-vms.xml
View File

@ -1,3 +1,9 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@ -16,8 +22,19 @@
under the License.
-->
<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 id="best-practices-vm">
<title>Best Practices for Virtual Machines</title>
<para>The &PRODUCT; 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 &PRODUCT; 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 &PRODUCT; UI to disable allocation of more VMs to the
cluster.</para>
</section>

29
docs/en-US/change-network-offering-on-guest-network.xml
View File

@ -21,24 +21,31 @@
specific language governing permissions and limitations
under the License.
-->
<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 &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>If you are changing from a network offering that uses the &PRODUCT; 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>
<listitem><para>If you are changing from a network offering that uses the &PRODUCT; virtual router to one
that uses external devices as network service providers, you must first stop all the
VMs on the network. See <xref linkend="stopping-and-starting-vms"/>.</para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network you want to modify.</para></listitem>
<listitem><para>In the Details tab, click Edit.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
<imagedata fileref="./images/edit-icon.png"/>
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<textobject>
<phrase>EditButton.png: button to edit a network</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>
<listitem><para>A prompt is displayed 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 the network change is
complete.</para></listitem>
<listitem><para>If you stopped any VMs, restart them.</para></listitem>
</itemizedlist>
</section>

3
docs/en-US/changing-root-password.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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.

4
docs/en-US/changing-secondary-storage-ip.xml
View File

@ -21,9 +21,8 @@
specific language governing permissions and limitations
under the License.
-->
<section id="changing-secondary-storage-ip">
<title>Making API Requests</title>
<title>Changing the Secondary Storage IP Address</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
@ -42,3 +41,4 @@
<para>Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone.</para>
</section>

23
docs/en-US/changing-service-offering-for-vm.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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>
@ -29,20 +28,26 @@
<listitem><para>Log in to the &PRODUCT; 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>
<listitem><para>Click the Stop button to stop the VM.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
<imagedata fileref="./images/stop-instance-icon.png"/>
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
<textobject>
<phrase>StopButton.png: button to stop a VM</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click the Change Service button <inlinemediaobject>
<listitem><para>Click the Change Service button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/change-service-icon.png" />
<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>
<textobject>
<phrase>ChangeServiceButton.png: button to change the service of a
VM</phrase>
</textobject>
</inlinemediaobject></para>
<para>The Change service dialog box is displayed.</para></listitem>
<listitem><para>Select the offering you want to apply to the selected VM.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

27
docs/en-US/changing-vm-name-os-group.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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>
@ -30,25 +29,31 @@
<listitem><para>Log in to the &PRODUCT; 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>
<listitem><para>Click the Stop button to stop the VM. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
<imagedata fileref="./images/stop-instance-icon.png"/>
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
<textobject>
<phrase>StopButton.png: button to stop a VM</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click Edit <inlinemediaobject>
<listitem><para>Click Edit. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
<imagedata fileref="./images/edit-icon.png"/>
</imageobject>
<textobject><phrase>StopButton.png: button to edit the properties of a VM</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<textobject>
<phrase>EditButton.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><emphasis role="bold">Display name</emphasis>: Enter a new display name if you want to change
the name of the VM.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>: Select the desired operating system.</para></listitem>
<listitem><para><emphasis role="bold">Group</emphasis>: Enter the group name for the VM.</para></listitem>
<listitem><para>Click Apply.</para></listitem>
</orderedlist>
</section>

6
docs/en-US/cloud-infrastructure-concepts.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -22,7 +22,7 @@
under the License.
-->
<section id="cloud-infrastructure-concepts">
<chapter id="cloud-infrastructure-concepts">
<title>Cloud Infrastructure Concepts</title>
<xi:include href="about-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-pods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@ -31,4 +31,4 @@
<xi:include href="about-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-physical-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>

5
docs/en-US/cloud-infrastructure-overview.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -39,8 +39,9 @@
<imageobject>
<imagedata fileref="./images/infrastructure-overview.png" />
</imageobject>
<textobject><phrase>infrastructure_overview.png: Nested organization of a zone</phrase></textobject>
<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>

29
docs/en-US/cloudstack_admin.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -23,9 +23,30 @@
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info_Admin.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" />
<xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accounts.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="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="virtual-machines.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="work-with-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-system-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sys-reliability-and-ha.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="manage-cloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="api-overview.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="troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

7
docs/en-US/cluster-add.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -24,5 +24,8 @@
<section id="cluster-add">
<title>Adding a Cluster</title>
<para>TODO</para>
<para>You need to tell &PRODUCT; about the hosts that it will manage. Hosts exist inside clusters, so before you begin adding hosts to the cloud, you must add at least one cluster.</para>
<xi:include href="add-clusters-kvm-xenserver.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-clusters-ovm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-clusters-vsphere.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

10
docs/en-US/compute-disk-service-offerings.xml
View File

@ -21,17 +21,16 @@
specific language governing permissions and limitations
under the License.
-->
<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>
<para>A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The &PRODUCT; 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>
<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, &PRODUCT; emits usage records that can be integrated with billing systems. &PRODUCT; 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>
@ -43,4 +42,9 @@
<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>
<xi:include href="creating-compute-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="creating-disk-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="modify-delete-service-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

3
docs/en-US/concepts.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<chapter id="concepts">
<title>Concepts</title>
<xi:include href="whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

34
docs/en-US/configure-guest-traffic-in-advanced-zone.xml
View File

@ -21,30 +21,36 @@
specific language governing permissions and limitations
under the License.
-->
<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 &PRODUCT; 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>Click Add guest network.</para>
<para>The Add guest network window is displayed:</para><mediaobject>
<imageobject>
<imagedata fileref="./images/add-guest-network.png" />
</imageobject>
<textobject>
<phrase>networksetupzone.png: Depicts network setup in a single zone</phrase>
</textobject>
</mediaobject></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 &PRODUCT; 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>
<listitem><para><emphasis role="bold">Name</emphasis>. The name of the network. This will be
user-visible</para></listitem>
<listitem><para><emphasis role="bold">Display Text</emphasis>: The description of the network. This will be
user-visible</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>: The zone in which you are configuring the guest network.</para></listitem>
<listitem><para><emphasis role="bold">Network offering</emphasis>: If the administrator has configured
multiple network offerings, select the one you want to use for this
network</para></listitem>
<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>
</itemizedlist>
</listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

15
docs/en-US/configure-usage-server.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="configure-usage-server">
<title>Configuring the Usage Server</title>
<para>To configure the usage server:</para>
@ -58,13 +57,13 @@
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>Valid values for the time zone are specified in <xref linkend="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>
<entry><para>The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in <xref linkend="time-zones"/></para>
<para>Default: The time zone of the management server.</para>
</entry>
</row>
@ -75,13 +74,13 @@ usage.aggregation.timezone = GMT
<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. &PRODUCT; 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. &PRODUCT; assumes this "midnight to midnight" is relative to the usage.execution.timezone.</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. &PRODUCT; 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. &PRODUCT; 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>
<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>
@ -97,5 +96,9 @@ usage.aggregation.timezone = GMT
<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>
<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>
<para></para>
</section>

11
docs/en-US/configure-vpn.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="configure-vpn">
<title>Configuring VPN</title>
<para>To set up VPN for the cloud:</para>
@ -41,12 +40,14 @@
<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>
<listitem><para>Click the Enable VPN button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/vpn-icon.png" />
<imagedata fileref="./images/vpn-icon.png"/>
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para>
<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>

3
docs/en-US/console-proxy.xml
View File

@ -32,4 +32,5 @@
<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. &PRODUCT; includes the realhostip.com SSL certificate in the console proxy VM. Of course, &PRODUCT; cannot know about DNS A records for our customers' public IPs prior to shipping the software. &PRODUCT; 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>
<xi:include href="change-console-proxy-ssl-certificate-domain.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

11
docs/en-US/convert-hyperv-vm-to-template.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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 &PRODUCT; template, you will need a standalone XenServer host with an attached NFS VHD SR. Use whatever XenServer version you are using with &PRODUCT;, 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>
@ -30,7 +29,8 @@
<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>
<listitem><para>Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to
mount by LABEL or UUID. You can 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>
@ -40,18 +40,18 @@
<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>
<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>
<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>
<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>
@ -63,6 +63,7 @@
<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>

19
docs/en-US/create-template-from-existing-vm.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<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>
@ -31,8 +30,11 @@
<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 &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following.</para>
<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 &PRODUCT; 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>
@ -40,10 +42,15 @@
<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 &PRODUCT; 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 &PRODUCT; password change script installed. See Adding Password Management to Your Templates.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all
users of this &PRODUCT; 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
&PRODUCT; password change script installed. See <xref linkend="add-password-management-to-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>
<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>

8
docs/en-US/create-template-from-snapshot.xml
View File

@ -21,9 +21,11 @@
specific language governing permissions and limitations
under the License.
-->
<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 &PRODUCT; UI.</para>
<note><para>Not supported by Oracle VM.</para></note>
<para></para>
<para>If you do not want to stop the VM 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 &PRODUCT; UI.</para>
</section>

6
docs/en-US/create-templates-overview.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="create-templates-overview">
<title>Creating Templates: Overview</title>
<para>&PRODUCT; 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>
@ -30,6 +29,9 @@
<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 &PRODUCT;. 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 &PRODUCT;</para>
<para>There are other ways to add templates to &PRODUCT;. 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 &PRODUCT;.</para>
<para>The various techniques for creating templates are described in the next few sections.</para>
</section>

10
docs/en-US/create-windows-template.xml
View File

@ -25,14 +25,16 @@
<section id="create-windows-template">
<title>Creating a Windows Template</title>
<para>Windows templates must be prepared with Sysprep before they can be provisioned on multiple machines. Sysprep allows you to create a generic Windows template and avoid any possible SID conflicts.</para>
<note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para></note>
<note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para>
</note>
<para></para>
<para>An overview of the procedure is as follows:</para>
<orderedlist>
<listitem><para>Upload your Windows ISO.</para> <para>For more information, see <xref linkend="add-iso"/></para></listitem>
<listitem><para>Create a VM Instance with this ISO.</para><para> For more information, see <xref linkend="creating-vms"/></para></listitem>
<listitem><para>Upload your Windows ISO.</para> <para>For more information, see <xref linkend="add-iso"/>.</para></listitem>
<listitem><para>Create a VM Instance with this ISO.</para><para> For more information, see <xref linkend="creating-vms"/>.</para></listitem>
<listitem><para>Follow the steps in Sysprep for Windows Server 2008 R2 (below) or Sysprep for Windows Server 2003 R2, depending on your version of Windows Server</para></listitem>
<listitem><para>The preparation steps are complete. Now you can actually create the template as described in Creating the Windows Template.</para></listitem>
</orderedlist>
<xi:include href="sysprep-windows-server-2008R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sysprep-for-windows-server-2003R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</section>

42
docs/en-US/creating-compute-offerings.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="creating-compute-offerings">
<title>Creating a New Compute Offering</title>
<para>To create a new compute offering:</para>
@ -32,19 +31,36 @@
<listitem><para>Click Add Compute Offering.</para></listitem>
<listitem><para>In the dialog, make the following choices:</para>
<itemizedlist>
<listitem><para>Name. Any desired name for the service offering.</para></listitem>
<listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem>
<listitem><para>Storage type. The type of disk that should be allocated. Local allocates from storage attached directly to the host where the system VM is running. Shared allocates from storage accessible via NFS.</para></listitem>
<listitem><para># of CPU cores. The number of cores which should be allocated to a system VM with this offering</para></listitem>
<listitem><para>CPU (in MHz). The CPU speed of the cores that the system VM is allocated. For example, "2000" would provide for a 2 GHz clock.</para></listitem>
<listitem><para>Memory (in MB). The amount of memory in megabytes that the system VM should be allocated. For example, "2048" would provide for a 2 GB RAM allocation.</para></listitem>
<listitem><para>Network Rate. Allowed data transfer rate in MB per second.</para></listitem>
<listitem><para>Offer HA. If yes, the administrator can choose to have the system VM be monitored and as highly available as possible.</para></listitem>
<listitem><para>Storage Tags. The tags that should be associated with the primary storage used by the system VM.</para></listitem>
<listitem><para>Host Tags. (Optional) Any tags that you use to organize your hosts</para></listitem>
<listitem><para>CPU cap. Whether to limit the level of CPU usage even if spare capacity is available.</para></listitem>
<listitem><para>Public. Indicate whether the service offering should be available all domains or only some domains. Choose Yes to make it available to all domains. Choose No to limit the scope to a subdomain; &PRODUCT; will then prompt for the subdomain's name.</para></listitem>
<listitem><para><emphasis role="bold">Name</emphasis>: Any desired name for the service offering.</para></listitem>
<listitem><para><emphasis role="bold">Description</emphasis>: A short description of the offering that can be
displayed to users</para></listitem>
<listitem><para><emphasis role="bold">Storage type</emphasis>: The type of disk that should be allocated.
Local allocates from storage attached directly to the host where the system
VM is running. Shared allocates from storage accessible via NFS.</para></listitem>
<listitem><para><emphasis role="bold"># of CPU cores</emphasis>: The number of cores which should be allocated
to a system VM with this offering</para></listitem>
<listitem><para><emphasis role="bold">CPU (in MHz)</emphasis>: The CPU speed of the cores that the system VM
is allocated. For example, “2000” would provide for a 2 GHz clock.</para></listitem>
<listitem><para><emphasis role="bold">Memory (in MB)</emphasis>: The amount of memory in megabytes that the
system VM should be allocated. For example, “2048” would provide for a 2 GB
RAM allocation.</para></listitem>
<listitem><para><emphasis role="bold">Network Rate</emphasis>: Allowed data transfer rate in MB per
second.</para></listitem>
<listitem><para><emphasis role="bold">Offer HA</emphasis>: If yes, the administrator can choose to have the
system VM be monitored and as highly available as possible.</para></listitem>
<listitem><para><emphasis role="bold">Storage Tags</emphasis>: The tags that should be associated with the
primary storage used by the system VM.</para></listitem>
<listitem><para><emphasis role="bold">Host Tags</emphasis>: (Optional) Any tags that you use to organize your
hosts</para></listitem>
<listitem><para><emphasis role="bold">CPU cap</emphasis>: Whether to limit the level of CPU usage even if
spare capacity is available.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>: Indicate whether the service offering should be
available all domains or only some domains. Choose Yes to make it available
to all domains. Choose No to limit the scope to a subdomain; &PRODUCT;
will then prompt for the subdomain's name.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

92
docs/en-US/creating-network-offerings.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="creating-network-offerings">
<title>Creating a New Network Offering</title>
<para>To create a network offering:</para>
@ -32,13 +31,23 @@
<listitem><para>Click Add Network Offering.</para></listitem>
<listitem><para>In the dialog, make the following choices:</para>
<itemizedlist>
<listitem><para>Name. Any desired name for the network offering</para></listitem>
<listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem>
<listitem><para>Network Rate. Allowed data transfer rate in MB per second</para></listitem>
<listitem><para>Traffic Type. The type of network traffic that will be carried on the network</para></listitem>
<listitem><para>Guest Type. Choose whether the guest network is isolated or shared. For a description of these terms, see <xref linkend="about-virtual-networks"/> </para></listitem>
<listitem><para>Specify VLAN. (Isolated guest networks only) Indicate whether a VLAN should be specified when this offering is used</para></listitem>
<listitem><para>Supported Services. Select one or more of the possible network services. For some services, you must also choose the service provider; for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load balancers that have been configured in the cloud. Depending on which services you choose, additional fields may appear in the rest of the dialog box.</para><para>Based on the guest network type selected, you can see the following supported services:</para><informaltable>
<listitem><para><emphasis role="bold">Name</emphasis>. Any desired name for the network offering</para></listitem>
<listitem><para><emphasis role="bold">Description</emphasis>. A short description of the offering that can be
displayed to users</para></listitem>
<listitem><para><emphasis role="bold">Network Rate</emphasis>. Allowed data transfer rate in MB per
second</para></listitem>
<listitem><para><emphasis role="bold">Guest Type</emphasis>. Choose whether the guest network is isolated or
shared. For a description of these terms, see <xref
linkend="about-virtual-networks"/>
</para></listitem>
<listitem><para><emphasis role="bold">Specify VLAN</emphasis>. (Isolated guest networks only) Indicate whether
a VLAN should be specified when this offering is used</para></listitem>
<listitem><para><emphasis role="bold">Supported Services</emphasis>. Select one or more of the possible
network services. For some services, you must also choose the service
provider; for example, if you select Load Balancer, you can choose the
&PRODUCT; virtual router or any other load balancers that have been
configured in the cloud. Depending on which services you choose, additional
fields may appear in the rest of the dialog box.</para><para>Based on the guest network type selected, you can see the following supported services:</para><informaltable>
<tgroup cols="4" align="left" colsep="1" rowsep="1">
<thead>
<row>
@ -51,55 +60,68 @@
<tbody>
<row>
<entry><para>DHCP</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>DNS</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Load Balancer</para></entry>
<entry><para>If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load balancers that have been configured in the cloud.</para></entry>
<entry><para>If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load
balancers that have been configured in the cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Source NAT</para></entry>
<entry><para>If you select Source NAT, you can choose the &PRODUCT; virtual router or any other Source NAT providers that have been configured in the cloud.</para></entry>
<entry><para>If you select Source NAT, you can choose the &PRODUCT; virtual router or any other Source
NAT providers that have been configured in the
cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Static NAT</para></entry>
<entry><para>If you select Static NAT, you can choose the &PRODUCT; virtual router or any other Static NAT providers that have been configured in the cloud.</para></entry>
<entry><para>If you select Static NAT, you can choose the &PRODUCT; virtual router or any other Static
NAT providers that have been configured in the
cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Port Forwarding</para></entry>
<entry><para>If you select Port Forwarding, you can choose the &PRODUCT; virtual router or any other Port Forwarding providers that have been configured in the cloud.</para></entry>
<entry><para>If you select Port Forwarding, you can choose the &PRODUCT; virtual router or any other
Port Forwarding providers that have been configured in
the cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Not Supported</para></entry>
</row>
<row>
<entry><para>VPN</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="vpn"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Not Supported</para></entry>
</row>
<row>
<entry><para>User Data</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="user-data-and-meta-data"/>.</para></entry>
<entry><para>Not Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Network ACL</para></entry>
<entry><para>For more information, see <xref linkend="configure-acl"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Not Supported</para></entry>
</row>
<row>
<entry><para>Security Groups</para></entry>
<entry><para>See <xref linkend="add-security-group"/>.</para></entry>
<entry><para>For more information, see <xref linkend="add-security-group"/>.</para></entry>
<entry><para>Not Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
@ -107,11 +129,39 @@
</tgroup>
</informaltable>
</listitem>
<listitem><para>System Offering. If the service provider for any of the services selected in Supported Services is a virtual router, the System Offering field appears. Choose the system service offering that you want virtual routers to use in this network. For example, if you selected Load Balancer in Supported Services and selected a virtual router to provide load balancing, the System Offering field appears so you can choose between the &PRODUCT; default system service offering and any custom system service offerings that have been defined by the &PRODUCT; root administrator. For more information, see System Service Offerings.</para></listitem>
<listitem><para>Redundant router capability. (v3.0.3 and greater) Available only when Virtual Router is selected as the Source NAT provider. Select this option if you want to use two virtual routers in the network for uninterrupted connection: one operating as the master virtual router and the other as the backup. The master virtual router receives requests from and sends responses to the user’s VM. The backup virtual router is activated only when the master is down. After the failover, the backup becomes the master virtual router. &PRODUCT; deploys the routers on different hosts to ensure reliability if one host is down.</para></listitem>
<listitem><para>Conserve mode. Indicate whether to use conserve mode. In this mode, network resources are allocated only when the first virtual machine starts in the network</para></listitem>
<listitem><para>Tags. Network tag to specify which physical network to use</para></listitem>
<listitem><para><emphasis role="bold">System Offering</emphasis>. If the service provider for any of the
services selected in Supported Services is a virtual router, the System
Offering field appears. Choose the system service offering that you want
virtual routers to use in this network. For example, if you selected Load
Balancer in Supported Services and selected a virtual router to provide load
balancing, the System Offering field appears so you can choose between the
&PRODUCT; default system service offering and any custom system service
offerings that have been defined by the &PRODUCT; root administrator.
For more information, see System Service Offerings.</para></listitem>
<listitem><para><emphasis role="bold">Redundant router capability</emphasis>. (v3.0.3 and greater) Available
only when Virtual Router is selected as the Source NAT provider. Select this
option if you want to use two virtual routers in the network for
uninterrupted connection: one operating as the master virtual router and the
other as the backup. The master virtual router receives requests from and
sends responses to the user’s VM. The backup virtual router is activated
only when the master is down. After the failover, the backup becomes the
master virtual router. &PRODUCT; deploys the routers on different hosts
to ensure reliability if one host is down.</para></listitem>
<listitem><para><emphasis role="bold">Conserve mode</emphasis>. Indicate whether to use conserve mode. In this
mode, network resources are allocated only when the first virtual machine
starts in the network. When the conservative mode is off, the public IP can
only be used for a single service. For example, a public IP used for a port
forwarding rule cannot be used for defining other services, such as SaticNAT
or load balancing. When the conserve mode is on, you can define more than
one service on the same public IP.</para>
<note><para>If StaticNAT is enabled, irrespective of the status of the conserve mode, no port forwarding
or load balancing rule can be created for the IP. However, you can add
the firewall rules by using the createFirewallRule command.</para></note></listitem>
<listitem><para><emphasis role="bold">Tags</emphasis>. Network tag to specify which physical network to
use.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

24
docs/en-US/creating-new-volumes.xml
View File

@ -21,10 +21,31 @@
specific language governing permissions and limitations
under the License.
-->
<section id="creating-new-volumes">
<title>Creating a New Volume</title>
<para>You can add more data disk volumes to a guest VM at any time, up to the limits of your storage capacity. Both &PRODUCT; administrators and users can add volumes to VM instances. When you create a new volume, it is stored as an entity in &PRODUCT;, but the actual storage resources are not allocated on the physical storage device until you attach the volume. This optimization allows the &PRODUCT; to provision the volume nearest to the guest that will use it when the first attachment is made.</para>
<section id="local-storage-data-volumes">
<title>Using Local Storage for Data Volumes</title>
<para>You can create data volumes on local storage (supported with XenServer, KVM, and VMware).
The data volume is placed on the same
host as the VM instance that is attached to the data volume. These
local data volumes can be attached to virtual machines, detached, re-attached,
and deleted just as with the other types of data volume.</para>
<para>Local storage is ideal for scenarios where persistence of data volumes and HA
is not required. Some of the benefits include reduced disk I/O latency and cost
reduction from using inexpensive local disks.</para>
<para>In order for local volumes to be used, the feature must be enabled for the
zone.</para>
<para>You can create a data disk offering for local storage. When a user creates a
new VM, they can select this disk offering in order to cause the data disk
volume to be placed in local storage.</para>
<para>You can not migrate a VM that has a volume in local storage to a different
host, nor migrate the volume itself away to a different host. If you want to put
a host into maintenance mode, you must first stop any VMs with local data
volumes on that host.</para>
</section>
<section id="creating-new-volume-steps">
<title>To Create a New Volume</title>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation bar, click Storage.</para></listitem>
@ -39,3 +60,4 @@
<listitem><para>To start using the volume, continue to Attaching a Volume </para></listitem>
</orderedlist>
</section>
</section>

18
docs/en-US/creating-vms.xml
View File

@ -3,7 +3,6 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@ -21,29 +20,36 @@
specific language governing permissions and limitations
under the License.
-->
<section id="creating-vms">
<title>Creating VMs</title>
<para>Virtual machines are usually created from a template. Users can also create blank virtual machines. A blank virtual machine is a virtual machine without an OS template. Users can attach an ISO file and install the OS from the CD/DVD-ROM.</para>
<note><para>Starting with v3.0.3, you can create a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A new request parameter, startVM, is introduced in the deployVm API to support this feature. For more information, see the Developer's Guide</para></note>
<para>To create a VM from a template:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem>
<listitem><para>In the left navigation bar, click Instances.</para></listitem>
<listitem><para>Click Add Instance.</para></listitem>
<listitem><para>Select a template, then follow the steps in the wizard. (For more information about how the templates came to be in this list, see Working with Templates.</para></listitem>
<listitem>
<para>Click Add Instance.</para>
</listitem>
<listitem>
<para>Select a zone.</para>
</listitem>
<listitem><para>Select a template, then follow the steps in the wizard. For more information about how the templates came to be in this list, see <xref linkend="working-with-templates"/>.</para></listitem>
<listitem><para>Be sure that the hardware you have allows starting the selected service offering.</para></listitem>
<listitem><para>Click Submit and your VM will be created and started.</para>
<note><para>For security reason, the internal name of the VM is visible only to the root admin.</para></note></listitem>
<note><para>For security reason, the internal name of the VM is visible only to the root admin.</para></note>
</listitem>
</orderedlist>
<note><para>Starting with v3.0.3, you can create a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A new request parameter, startVM, is introduced in the deployVm API to support this feature. For more information, see the Developer's Guide</para></note>
<para>To create a VM from an ISO:</para>
<note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para></note>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem>
<listitem><para>In the left navigation bar, click Instances.</para></listitem>
<listitem><para>Click Add Instance.</para></listitem>
<listitem><para>Select a zone.</para></listitem>
<listitem><para>Select ISO Boot, and follow the steps in the wizard.</para></listitem>
<listitem><para>Click Submit and your VM will be created and started.</para></listitem>
<listitem><para>(Oracle VM only) After ISO installation, the installer reboots into the operating system. Due to a known issue in OVM, the reboot will place the VM in the Stopped state. In the &PRODUCT; UI, detach the ISO from the VM (so that the VM will not boot from the ISO again), then click the Start button to restart the VM.</para></listitem>
</orderedlist>
</section>

17
docs/en-US/default-account-resource-limit.xml
View File

@ -21,20 +21,25 @@
specific language governing permissions and limitations
under the License.
-->
<section id="default-account-resource-limit">
<title>Default Account Resource Limits</title>
<para>You can limit resource use by accounts. The default limits are set using global configuration parameters, and they affect all accounts within a cloud. The relevant parameters are those beginning with max.account (max.account.snapshots, etc.)..</para>
<para>You can limit resource use by accounts. The default limits are set by using global
configuration parameters, and they affect all accounts within a cloud. The relevant
parameters are those beginning with max.account, for example: max.account.snapshots.</para>
<para>To override a default limit for a particular account, set a per-account resource limit.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI.</para></listitem>
<listitem><para>In the left navigation tree, click Accounts.</para></listitem>
<listitem><para>Select the account you want to modify. The current limits are displayed. A value of -1 shows that there is no limit in place</para></listitem>
<listitem><para>Click the Edit button<inlinemediaobject>
<listitem><para>Select the account you want to modify. The current limits are displayed. A value of -1 shows
that there is no limit in place.</para></listitem>
<listitem><para>Click the Edit button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
<imagedata fileref="./images/edit-icon.png"/>
</imageobject>
<textobject><phrase>editbutton.png: edits the settings.</phrase></textobject>
<textobject>
<phrase>editbutton.png: edits the settings</phrase>
</textobject>
</inlinemediaobject></para></listitem>
</orderedlist>
</section>

10
docs/en-US/deleting-vms.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="deleting-vms">
<title>Deleting VMs</title>
<para>Users can delete their own virtual machines. A running virtual machine will be abruptly stopped before it is deleted. Administrators can delete any virtual machines.</para>
@ -30,12 +29,15 @@
<listitem><para>Log in to the &PRODUCT; 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 delete.</para></listitem>
<listitem><para>Click the Destroy Instance button <inlinemediaobject>
<listitem><para>Click the Destroy Instance button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/destroy-instance.png" />
<imagedata fileref="./images/destroy-instance.png"/>
</imageobject>
<textobject><phrase>Destroyinstance.png: button to destroy an instance</phrase></textobject>
<textobject>
<phrase>Destroyinstance.png: button to destroy an instance</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
</orderedlist>
</section>

3
docs/en-US/deployment-architecture-overview.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="deployment-architecture-overview">
<title>Deployment Architecture Overview</title>
<para>

15
docs/en-US/detach-move-volumes.xml
View File

@ -21,9 +21,8 @@
specific language governing permissions and limitations
under the License.
-->
<section id="detach-move-volumes">
<title>Attaching a Volume</title>
<title>Detaching and Moving Volumes</title>
<note><para>This procedure is different from moving disk volumes from one storage pool to another. See VM Storage Migration </para></note>
<para>A volume can be detached from a guest VM and attached to another guest. Both &PRODUCT; administrators and users can detach volumes from VMs and move them to other VMs.</para>
<para>If the two VMs are in different clusters, and the volume is large, it may take several minutes for the volume to be moved to the new VM.</para>
@ -31,13 +30,17 @@
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation bar, click Storage, and choose Volumes in Select View. Alternatively, if you know which VM the volume is attached to, you can click Instances, click the VM name, and click View Volumes.</para></listitem>
<listitem><para>Click the name of the volume you want to detach, then click the Detach Disk button <inlinemediaobject>
<listitem><para>Click the name of the volume you want to detach, then click the Detach Disk button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/detach-disk-icon.png" />
<imagedata fileref="./images/detach-disk-icon.png"/>
</imageobject>
<textobject><phrase>DetachDiskButton.png: button to detach a volume</phrase></textobject>
<textobject>
<phrase>DetachDiskButton.png: button to detach a volume</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>To move the volume to another VM, follow the steps in Attaching a Volume <xref linkend="attaching-volume"/>.</para></listitem>
<listitem><para>To move the volume to another VM, follow the steps in <xref linkend="attaching-volume"
/>.</para></listitem>
</orderedlist>
</section>

5
docs/en-US/developer-guide.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<chapter id="developer-guide">
<title>Using the API</title>
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@ -32,7 +31,5 @@
<xi:include href="responses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="asynchronous-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="contacting-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

16
docs/en-US/enable-disable-static-nat.xml
View File

@ -21,24 +21,26 @@
specific language governing permissions and limitations
under the License.
-->
<section id="enable-disable-static-nat">
<title>Enabling or Disabling Static NAT</title>
<para>If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP.</para>
<para>If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>Log in to the &PRODUCT; 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 the IP address you want to work with.</para>
</listitem>
<listitem><para>Click the Static NAT button.<inlinemediaobject>
<listitem><para>Click the Static NAT <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/release-ip-icon.png" />
<imagedata fileref="./images/enable-disable.png"/>
</imageobject>
<textobject><phrase>ReleaseIPButton.png: button to release an IP</phrase></textobject>
</inlinemediaobject>The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address.</para></listitem>
<listitem><para>If you are enabling static NAT, a dialog appears where you can choose the destination VM and click Apply</para></listitem>
<textobject>
<phrase>ReleaseIPButton.png: button to release an IP</phrase>
</textobject>
</inlinemediaobject>button.</para><para>The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address.</para></listitem>
<listitem><para>If you are enabling static NAT, a dialog appears where you can choose the destination VM and
click Apply.</para></listitem>
</orderedlist>
</section>

7
docs/en-US/enable-security-groups.xml
View File

@ -21,9 +21,12 @@
specific language governing permissions and limitations
under the License.
-->
<section id="enable-security-groups">
<title>Enabling Security Groups</title>
<para>In order for security groups to function in a zone, the security groups feature must first be enabled for the zone. The administrator can do this when creating a new zone, by selecting a network offering that includes security groups. The procedure is described in Basic Zone Configuration in the Advanced Installation Guide.</para>
<para>In order for security groups to function in a zone, the security groups feature must first be
enabled for the zone. The administrator can do this when creating a new zone, by selecting a
network offering that includes security groups. The procedure is described in Basic Zone
Configuration in the Advanced Installation Guide. The administrator can not enable security
groups for an existing zone, only when creating a new zone.</para>
</section>

3
docs/en-US/end-user-ui-overview.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="end-user-ui-overview">
<title>End User's UI Overview</title>
<para>The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view.</para>

1
docs/en-US/event-log-queries.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="event-log-queries">
<title>Event Log Queries</title>
<para>Database logs can be queried from the user interface. The list of events captured by the system includes:</para>

5
docs/en-US/event-types.xml
View File

@ -21,8 +21,7 @@
specific language governing permissions and limitations
under the License.
-->
<section id="event-types">
<appendix id="event-types">
<title>Event Types</title>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
@ -217,4 +216,4 @@
</tbody>
</tgroup>
</informaltable>
</section>
</appendix>

13
docs/en-US/events-log.xml
View File

@ -21,8 +21,15 @@
specific language governing permissions and limitations
under the License.
-->
<section id="events-log">
<title>Event Logs</title>
<para>There are two types of events logged in the &PRODUCT; Event Log. Standard events log the success or failure of an event and can be used to identify jobs or processes that have failed. There are also long running job events. Events for asynchronous jobs log when a job is scheduled, when it starts, and when it completes. Other long running synchronous jobs log when a job starts, and when it completes. Long running synchronous and asynchronous event logs can be used to gain more information on the status of a pending job or can be used to identify a job that is hanging or has not started. The following sections provide more information on these events..</para>
</section>
<para>There are two types of events logged in the &PRODUCT; Event Log. Standard events log
the success or failure of an event and can be used to identify jobs or processes that have
failed. There are also long running job events. Events for asynchronous jobs log when a job
is scheduled, when it starts, and when it completes. Other long running synchronous jobs log
when a job starts, and when it completes. Long running synchronous and asynchronous event
logs can be used to gain more information on the status of a pending job or can be used to
identify a job that is hanging or has not started. The following sections provide more
information on these events..</para>
</section>

1
docs/en-US/events.xml
View File

@ -23,6 +23,7 @@
-->
<section id="events">
<title>Events</title>
<xi:include href="events-log.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="standard-events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="long-running-job-events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

6
docs/en-US/external-firewalls-and-load-balancers.xml
View File

@ -21,8 +21,12 @@
specific language governing permissions and limitations
under the License.
-->
<section id="external-firewalls-and-load-balancers">
<title>External Firewalls and Load Balancers</title>
<para>&PRODUCT; is capable of replacing its Virtual Router with an external Juniper SRX device and an optional external NetScaler or F5 load balancer for gateway and load balancing services. In this case, the VMs use the SRX as their gateway.</para>
<xi:include href="using-netscaler-load-balancers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="configure-snmp-rhel.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="initial-setup-of-external-firewalls-loadbalancers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ongoing-configuration-of-external-firewalls-loadbalancer.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="autoscale.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

11
docs/en-US/feature-overview.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="feature-overview">
<title>What Can &PRODUCT; Do?</title>
<para>
@ -30,9 +29,9 @@
<para>
&PRODUCT; 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.
</para>
<para>
&PRODUCT; 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 &PRODUCT; 3.0.x.)
</para>
<para> &PRODUCT; 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).</para>
<para>
<emphasis role="bold">Massively Scalable Infrastructure Management</emphasis>
</para>
@ -55,7 +54,7 @@
<emphasis role="bold">API and Extensibility</emphasis>
</para>
<para>
&PRODUCT; 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 <ulink url="http://docs.cloudstack.org/Apache_CloudStack_Documentation">http://docs.cloudstack.org/Apache_CloudStack_Documentation</ulink>.
&PRODUCT; 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 &PRODUCT; pluggable allocation architecture allows the creation of new types of allocators for the selection of storage and Hosts. See the Allocator Implementation Guide (<ulink url="http://docs.cloudstack.org/CloudStack_Documentation/Allocator_Implementation_Guide">http://docs.cloudstack.org/CloudStack_Documentation/Allocator_Implementation_Guide</ulink>).

3
docs/en-US/firewall-rules.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="firewall-rules">
<title>Firewall Rules</title>
<para>By default, all incoming traffic to the public IP address is rejected by the firewall. To allow external traffic, you can open firewall ports by specifying firewall rules. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses.</para>
@ -51,6 +50,6 @@
the ICMP header. Refer to ICMP documentation for more details if you are not
sure what to enter</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add</para></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

5
docs/en-US/guest-traffic.xml
View File

@ -21,14 +21,13 @@
specific language governing permissions and limitations
under the License.
-->
<section id="guest-traffic">
<title>Guest Traffic</title>
<para>A network can carry guest traffic only between VMs within one zone. Virtual machines in different zones cannot communicate with each other using their IP addresses; they must communicate with each other by routing through a public IP address.</para>
<para>Figure 1 illustrates a typical guest traffic setup:</para>
<para>See a typical guest traffic setup given below:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/basic-deployment.png" />
<imagedata fileref="./images/guest-traffic-setup.png" />
</imageobject>
<textobject><phrase>guesttraffic.png: Depicts a guest traffic setup</phrase></textobject>
</mediaobject>

5
docs/en-US/ha-for-hosts.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -26,4 +26,5 @@
<title>HA for Hosts</title>
<para>The user can specify a virtual machine as HA-enabled. By default, all virtual router VMs and Elastic Load Balancing VMs are automatically configured as HA-enabled. When an HA-enabled VM crashes, &PRODUCT; detects the crash and restarts the VM automatically within the same Availability Zone. HA is never performed across different Availability Zones. &PRODUCT; has a conservative policy towards restarting VMs and ensures that there will never be two instances of the same VM running at the same time. The Management Server attempts to start the VM on another Host in the same cluster.</para>
<para>HA features work with iSCSI or NFS primary storage. HA with local storage is not supported.</para>
</section>
<xi:include href="dedicated-ha-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

16
docs/en-US/host-add.xml
View File

@ -24,5 +24,19 @@
<section id="host-add">
<title>Adding a Host</title>
<para>TODO</para>
<orderedlist>
<listitem><para>Before adding a host to the &PRODUCT; configuration, you must first install your chosen hypervisor on the host. &PRODUCT; can manage hosts running VMs under a variety of hypervisors.</para>
<para>The &PRODUCT; Installation Guide provides instructions on how to install each supported hypervisor
and configure it for use with &PRODUCT;. See the Installation Guide for information about which version of your chosen hypervisor is supported, as well as crucial additional steps to configure the hosts for use with &PRODUCT;.</para>
<warning><para>Be sure you have performed the additional &PRODUCT;-specific configuration steps described in the hypervisor installation section for your particular hypervisor.</para></warning>
</listitem>
<listitem><para>Now add the hypervisor host to &PRODUCT;. The technique to use varies depending on the hypervisor.</para>
<itemizedlist>
<listitem><para><xref linkend="host-add-xenserver-kvm-ovm" /></para></listitem>
<listitem><para><xref linkend="host-add-vsphere" /></para></listitem>
</itemizedlist>
</listitem>
</orderedlist>
<xi:include href="host-add-xenserver-kvm-ovm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="host-add-vsphere.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

3
docs/en-US/host-allocation.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -28,4 +28,5 @@
<para>&PRODUCT; administrators can specify that certain hosts should have a preference for particular types of guest instances. For example, an administrator could state that a host should have a preference to run Windows guests. The default host allocator will attempt to place guests of that OS type on such hosts first. If no such host is available, the allocator will place the instance wherever there is sufficient physical capacity.</para>
<para>Both vertical and horizontal allocation is allowed. Vertical allocation consumes all the resources of a given host before allocating any guests on a second host. This reduces power consumption in the cloud. Horizontal allocation places a guest on each host in a round-robin fashion. This may yield better performance to the guests in some cases. &PRODUCT; also allows an element of CPU over-provisioning as configured by the administrator. Over-provisioning allows the administrator to commit more CPU cycles to the allocated guests than are actually available from the hardware.</para>
<para>&PRODUCT; also provides a pluggable interface for adding new allocators. These custom allocators can provide any policy the administrator desires.</para>
<xi:include href="over-provisioning-service-offering-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

13
docs/en-US/hypervisor-support-for-primarystorage.xml
View File

@ -21,19 +21,16 @@
specific language governing permissions and limitations
under the License.
-->
<section id="hypervisor-support-for-primarystorage">
<title>Hypervisor Support for Primary Storage</title>
<para>The following table shows storage options and parameters for different hypervisors.</para>
<informaltable>
<tgroup cols="5">
<colspec colname="c1" colnum="1" colwidth="4.0cm"/>
<colspec colname="c2" colnum="2" colwidth="4cm" />
<colspec colname="c3" colnum="3" colwidth="5cm" />
<colspec colname="c4" colnum="2" colwidth="5.9cm"/>
<colspec colname="c5" colnum="3" colwidth="5.0cm"/>
<colspec colnum="4" colname="c4" colwidth="120.75pt"/>
<colspec colnum="5" colname="c5" colwidth="80.25pt"/>
<colspec colname="c1" colnum="1" colwidth="34%" />
<colspec colname="c2" colnum="2" colwidth="16%" />
<colspec colname="c3" colnum="3" colwidth="16%"/>
<colspec colname="c4" colnum="4" colwidth="17%"/>
<colspec colname="c5" colnum="5" colwidth="17%"/>
<thead>
<row>
<entry></entry>

BIN
docs/en-US/images/cluster-overview.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 6.8 KiB

After

Width:  |  Height:  |  Size: 5.9 KiB

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

@ -21,13 +21,15 @@
specific language governing permissions and limitations
under the License.
-->
<section id="import-ami">
<title>Importing Amazon Machine Images</title>
<para>The following procedures describe how to import an Amazon Machine Image (AMI) into &PRODUCT; when using the XenServer hypervisor.</para>
<para>Assume you have an AMI file and this file is called CentOS_6.2_x64. Assume further that you are working on a CentOS host. If the AMI is a Fedora image, you need to be working on a Fedora host initially.</para>
<para>You need to have a XenServer host with a file-based storage repository (either a local ext3 SR or an NFS SR) to convert to a VHD once the image file has been customized on the Centos/Fedora host.</para>
<note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
<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></para>
<para>To import an AMI:</para>
<orderedlist>
<listitem><para>Set up loopback on image file:</para><programlisting># mkdir -p /mnt/loop/centos62
# mount -o loop CentOS_6.2_x64 /mnt/loop/centos54
@ -35,7 +37,7 @@
<listitem><para>Install the kernel-xen package into the image. This downloads the PV kernel and ramdisk to the image.</para><programlisting># yum -c /mnt/loop/centos54/etc/yum.conf --installroot=/mnt/loop/centos62/ -y install kernel-xen</programlisting></listitem>
<listitem><para>Create a grub entry in /boot/grub/grub.conf.</para><programlisting># mkdir -p /mnt/loop/centos62/boot/grub
# touch /mnt/loop/centos62/boot/grub/grub.conf
# echo "" &gt; /mnt/loop/centos62/boot/grub/grub.conf
# echo "" > /mnt/loop/centos62/boot/grub/grub.conf
</programlisting></listitem>
<listitem><para>Determine the name of the PV kernel that has been installed into the image.</para>
<programlisting># cd /mnt/loop/centos62

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

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,33 +21,57 @@
specific language governing permissions and limitations
under the License.
-->
<section id="initialize-and-test">
<title>Initialize and Test</title>
<para>After everything is configured, &PRODUCT; will perform its initialization. This can take 30 minutes or more, depending on the speed of your network. When the initialization has completed successfully, the administrator's Dashboard should be displayed in the &PRODUCT; UI.</para>
<orderedlist>
<listitem><para>Verify that the system is ready. In the left navigation bar, select Templates. Click on the CentOS 5.5 (64bit) no Gui (KVM) template. Check to be sure that the status is "Download Complete." Do not proceed to the next step until this status is displayed.</para></listitem>
<listitem><para>Go to the Instances tab, and filter by My Instances.</para></listitem>
<listitem><para>Click Add Instance and follow the steps in the wizard.</para>
<orderedlist numeration="loweralpha">
<listitem><para>Choose the zone you just added.</para></listitem>
<listitem><para>In the template selection, choose the template to use in the VM. If this is a fresh installation, likely only the provided CentOS template is available.</para></listitem>
<listitem><para>Select a service offering. Be sure that the hardware you have allows starting the selected service offering.</para></listitem>
<listitem><para>In data disk offering, if desired, add another data disk. This is a second volume that will be available to but not mounted in the guest. For example, in Linux on XenServer you will see /dev/xvdb in the guest after rebooting the VM. A reboot is not required if you have a PV-enabled OS kernel in use.</para></listitem>
<listitem><para>In default network, choose the primary network for the guest. In a trial installation, you would have only one option here.</para></listitem>
<listitem><para>Optionally give your VM a name and a group. Use any descriptive text you would like.</para></listitem>
<listitem><para>Click Launch VM. Your VM will be created and started. It might take some time to download the template and complete the VM startup. You can watch the VM’s progress in the Instances screen.</para></listitem>
<listitem><para>Click Launch VM. Your VM will be created and started. It might take some time to download the template and complete the VM startup. You can watch the VM’s progress in the Instances screen.</para></listitem>
</orderedlist>
</listitem>
<listitem>
<para>To use the VM, click the View Console button.
<inlinemediaobject>
<imageobject><imagedata fileref="./images/console-icon.png" /></imageobject>
<textobject><phrase>ConsoleButton.png: button to launch a console</phrase></textobject>
</inlinemediaobject>
</para>
<para>For more information about using VMs, including instructions for how to allow incoming network traffic to the VM, start, stop, and delete VMs, and move a VM from one host to another, see Working With Virtual Machines in the Administrator’s Guide.</para>
</listitem>
</orderedlist>
<para>Congratulations! You have successfully completed a &PRODUCT; Installation.</para>
<para>If you decide to grow your deployment, you can add more hosts, primary storage, zones, pods, and clusters.</para>
</section>

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

@ -21,10 +21,10 @@
specific language governing permissions and limitations
under the License.
-->
<section id="ip-forwarding-firewalling">
<title>IP Forwarding and Firewalling</title>
<para>By default, all incoming traffic to the public IP address is rejected. All outgoing traffic from the guests is translated via NAT to the public IP address and is allowed.</para>
<para>To allow incoming traffic, users may set up firewall rules and/or port forwarding rules. For example, you can use a firewall rule to open a range of ports on the public IP address, such as 33 through 44. Then use port forwarding rules to direct traffic from individual ports within that range to specific ports on user VMs. For example, one port forwarding rule could route incoming traffic on the public IP's port 33 to port 100 on one user VM's private IP.</para>
<para>For the steps to implement these rules, see Firewall Rules and Port Forwarding.</para>
<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" />
</section>

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

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="isolated-networks">
<title>Isolated Networks</title>
<para>An isolated network can be accessed only by virtual machines of a single account. Isolated networks have the following properties.</para>
@ -30,4 +29,6 @@
<listitem><para>There is one network offering for the entire network</para></listitem>
<listitem><para>The network offering can be upgraded or downgraded but it is for the entire network</para></listitem>
</itemizedlist>
</section>

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

@ -21,27 +21,33 @@
specific language governing permissions and limitations
under the License.
-->
<section id="linux-installation">
<title>Linux OS Installation</title>
<para>Use the following steps to begin the Linux OS installation:</para>
<orderedlist>
<listitem><para>Download the script file cloud-set-guest-password:</para>
<itemizedlist>
<listitem><para>Linux: <ulink url="http://cloudstack.org/dl/cloud-set-guest-password"></ulink></para></listitem>
<listitem><para>Windows: <ulink url="http://sourceforge.net/projects/cloudstack/files/Password%20Management%20Scripts/CloudInstanceManager.msi/download"></ulink></para></listitem>
<listitem><para>Linux: <ulink url="
http://cloudstack.org/dl/cloud-set-guest-password
"></ulink>
</para></listitem>
<listitem><para>Windows: <ulink url="
http://sourceforge.net/projects/cloudstack/files/Password%20Management%20Scripts/CloudInstanceManager.msi/download
"></ulink>
</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Copy this file to /etc/init.d.</para>
<para>On some Linux distributions, copy the file to /etc/rc.d/init.d.</para>
<listitem><para>Copy this file to /etc/init.d.</para><para>On some Linux distributions, copy the file to /etc/rc.d/init.d.</para>
</listitem>
<listitem><para>Run the following command to make the script executable:</para><programlisting>chmod +x /etc/init.d/cloud-set-guest-password</programlisting>
</listitem>
<listitem><para>Depending on the Linux distribution, continue with the appropriate step.</para><para>On Fedora, CentOS/RHEL, and Debian, run:</para><programlisting>chkconfig --add cloud-set-guest-password</programlisting>
<para condition="community">On Ubuntu with VMware tools, link the script file to the /etc/network/if-up and /etc/network/if-down folders, and run the script:</para>
<para condition="community">On Ubuntu with VMware tools, link the script file to the /etc/network/if-up and
/etc/network/if-down folders, and run the script:</para>
<programlisting condition="community">#ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-up/cloud-set-guest-password
#ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-down/cloud-set-guest-password</programlisting>
#ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-down/cloud-set-guest-password</programlisting>
<para condition="community">If you are using Ubuntu 11.04, start by creating a directory called /var/lib/dhcp3 on your Ubuntu machine (works around a known issue with this version of Ubuntu). On all Ubuntu versions: Run “sudo update-rc.d cloud-set-guest-password defaults 98”. To test, run "mkpasswd" and check that it is generating a new password. If the “mkpasswd” command does not exist, run "sudo apt-get install whois" (or sudo apt-get install mkpasswd, depending on your Ubuntu version) and repeat.</para>
</listitem>
</orderedlist>
</section>

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

@ -21,9 +21,12 @@
specific language governing permissions and limitations
under the License.
-->
<section id="load-balancer-rules">
<title>Load Balancer Rules</title>
<para>A &PRODUCT; user or administrator may create load balancing rules that balance traffic received at a public IP to one or more VMs. A user creates a rule, specifies an algorithm, and assigns the rule to a set of VMs.</para>
<note><para>If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para></note>
<note><para>If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para>
</note>
<para></para>
<xi:include href="add-load-balancer-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sticky-session-policies-for-lb-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="log-in-root-admin">
<title>Logging In as the Root Administrator</title>
<para>After the Management Server software is installed and running, you can run the &PRODUCT; user interface. This UI is there to help you provision, view, and manage your cloud infrastructure.</para>
@ -35,7 +34,7 @@
<listitem><para><emphasis role="bold">Continue with basic setup.</emphasis> Choose this if you're just trying &PRODUCT;, and you want a guided walkthrough of the simplest possible configuration so that you can get started right away. We'll help you set up a cloud with the following features: a single machine that runs &PRODUCT; software and uses NFS to provide storage; a single machine running VMs under the XenServer or KVM hypervisor; and a shared public network.</para>
<para>The prompts in this guided tour should give you all the information you need, but if you want just a bit more detail, you can follow along in the Trial Installation Guide.</para>
</listitem>
<listitem><para><emphasis role="bold">I have used &PRODUCT; before.</emphasis> Choose this if you have already gone through a design phase and planned a more sophisticated deployment, or you are ready to start scaling up a trial cloud that you set up earlier with the basic setup screens. In the Administrator UI, you can start using the more powerful features of CloudPlatform, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere.</para>
<listitem><para><emphasis role="bold">I have used &PRODUCT; before.</emphasis> Choose this if you have already gone through a design phase and planned a more sophisticated deployment, or you are ready to start scaling up a trial cloud that you set up earlier with the basic setup screens. In the Administrator UI, you can start using the more powerful features of &PRODUCT;, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere.</para>
<para>The root administrator Dashboard appears.</para>
</listitem>
</itemizedlist>
@ -43,4 +42,5 @@
<listitem><para>You should set a new root administrator password. If you chose basic setup, you’ll be prompted to create a new password right away. If you chose experienced user, use the steps in <xref linkend="changing-root-password" />.</para></listitem>
</orderedlist>
<warning><para>You are logging in as the root administrator. This account manages the &PRODUCT; deployment, including physical infrastructure. The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person. Please change the default password to a new, unique password.</para></warning>
<para></para>
</section>

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

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="log-in">
<title>Log In to the UI</title>
<para>&PRODUCT; provides a web-based UI that can be used by both administrators and end users. The appropriate version of the UI is displayed depending on the credentials used to log in. The UI is available in popular browsers including IE7, IE8, IE9, Firefox 3.5+, Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own management server IP address)</para>
@ -45,4 +44,5 @@
<xi:include href="end-user-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="root-admin-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="log-in-root-admin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-root-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -21,10 +21,9 @@
specific language governing permissions and limitations
under the License.
-->
<section id="maintain-hypervisors-on-hosts">
<title>Maintaining Hypervisors on Hosts</title>
<para>When running hypervisor software on hosts, be sure all the hotfixes provided by the hypervisor vendor are applied. Track the release of hypervisor patches through your hypervisor vendor’s support channel, and apply patches as soon as possible after they are released. &PRODUCT; will not track or notify you of required hypervisor patches. It is essential that your hosts are completely up to date with the provided hypervisor patches. The hypervisor vendor is likely to refuse to support any system that is not up to date with patches.</para>
<note><para>The lack of up-do-date hotfixes can lead to data corruption and lost VMs.</para></note>
<para>(XenServer) For more information, see <ulink url="http://docs.cloudstack.org/Knowledge_Base/Possible_VM_corruption_if_XenServer_Hotfix_is_not_Applied/Highly_Recommended_Hotfixes_for_XenServer_5.6_SP2">Highly Recommended Hotfixes for XenServer in the &PRODUCT; Knowledge Base</ulink></para>
<para>(XenServer) For more information, see <ulink url="http://docs.cloudstack.org/Knowledge_Base/Possible_VM_corruption_if_XenServer_Hotfix_is_not_Applied/Highly_Recommended_Hotfixes_for_XenServer_5.6_SP2">Highly Recommended Hotfixes for XenServer in the &PRODUCT; Knowledge Base</ulink>.</para>
</section>

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

@ -21,11 +21,12 @@
specific language governing permissions and limitations
under the License.
-->
<section id="manage-cloud">
<chapter id="manage-cloud">
<title>Managing the Cloud</title>
<para><xref linkend="change-database-config" />vCenter Maintenance Mode</para>
<para><xref linkend="admin-alerts" />XenServer and Maintenance Mode</para>
<para><xref linkend="customizing-dns" />vCenter Maintenance Mode</para>
<para><xref linkend="stop-start-management-server" />XenServer and Maintenance Mode</para>
</section>
<xi:include href="tagging-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="change-database-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="admin-alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="customizing-dns.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="stop-restart-management-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

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

@ -21,10 +21,9 @@
specific language governing permissions and limitations
under the License.
-->
<section id="manual-live-migration">
<title>Moving VMs Between Hosts (Manual Live Migration)</title>
<para>The CloudPlatform administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions:</para>
<para>The &PRODUCT; administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions:</para>
<itemizedlist>
<listitem><para>The root administrator is logged in. Domain admins and users can not perform manual live migration of VMs.</para></listitem>
<listitem><para>The VM is running. Stopped VMs can not be live migrated.</para></listitem>
@ -35,10 +34,10 @@
</itemizedlist>
<para>To manually live migrate a virtual machine</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the VM that you want to migrate.</para></listitem>
<listitem><para>Click the Migrate Instance button <inlinemediaobject>
<listitem><para>Click the Migrate Instance button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/migrate-instance.png" />
</imageobject>

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

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="migrate-vm-rootvolume-volume-new-storage-pool">
<title>Migrating a VM Root Volume to a New Storage Pool</title>
<para>When migrating the root disk volume, the VM must first be stopped, and users can not access the VM. After migration is complete, the VM can be restarted.</para>
@ -29,7 +28,8 @@
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>Detach the data disk from the VM. See Detaching and Moving Volumes <xref linkend="detach-move-volumes"/> (but skip the “reattach” step at the end. You will do that after migrating to new storage).</para></listitem>
<listitem><para>Stop the VM.</para></listitem>
<listitem><para>Call the &PRODUCT; API command migrateVirtualMachine with the ID of the VM to migrate and the IDs of a destination host and destination storage pool in the same zone.</para></listitem>
<listitem><para>Use the &PRODUCT; API command, migrateVirtualMachine, with the ID of the VM to migrate and
the IDs of a destination host and destination storage pool in the same zone.</para></listitem>
<listitem><para>Watch for the VM status to change to Migrating, then back to Stopped.</para></listitem>
<listitem><para>Restart the VM.</para></listitem>
</orderedlist>

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

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
@ -21,22 +21,27 @@
specific language governing permissions and limitations
under the License.
-->
<section id="minimum-system-requirements">
<title>Minimum System Requirements</title>
<section id="management-server-system-requirements">
<title>Management Server, Database, and Storage System Requirements</title>
<para>The machines that will run the Management Server and MySQL database must meet the following requirements. The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS. The Management Server may be placed on a virtual machine.</para>
<para>
The machines that will run the Management Server and MySQL database must meet the following requirements.
The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS.
The Management Server may be placed on a virtual machine.
</para>
<itemizedlist>
<listitem><para>Operating system:</para>
<itemizedlist>
<listitem><para>Preferred: CentOS/RHEL 6.2+ or Ubuntu 12.04(.1)</para></listitem>
<listitem><para>Also supported: CentOS/RHEL 5.5 or Ubuntu 10.04</para></listitem>
<listitem><para>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/).</para></listitem>
<listitem><para>Also supported (v3.0.3 and greater): RHEL and CentOS 5.4-5.x 64-bit</para></listitem>
<listitem><para>It is highly recommended that you purchase a RHEL support license.
Citrix support can not be responsible for helping fix issues with the underlying OS.</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>50 GB of local disk (When running secondary storage on the management server 500GB is recommended)</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>
@ -57,34 +62,18 @@
<listitem><para>When you deploy &PRODUCT;, 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</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.</para>
<para>
Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with CloudStack. For example, the requirements for XenServer are listed under Citrix XenServer Installation.
</para>
</warning>
<section id="hypervisor-requirements-xenserver">
<title>Citrix XenServer requirements</title>
<para>To be determined</para>
</section>
<section id="hypervisor-requirements-vmware">
<title>VMware vSphere requirements</title>
<para>To be determined</para>
<xi:include href="compatibility-matrix.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="hypervisor-requirements-kvm">
<title>KVM requirements</title>
<para>For running a KVM hypervisor the main requirement is the Linux distribution it is running. Although you are not required to run these distributions, it is recommended.</para>
<para>Recommended distributions:</para>
<itemizedlist>
<listitem><para>CentOS / RHEL: 6.2 and 6.3</para></listitem>
<listitem><para>Ubuntu: 12.04(.1)</para></listitem>
</itemizedlist>
<para>The main requirement for KVM hypervisors is the libvirt and Qemu version. If you whish to run on a different distribution, make sure you meet the following requirements:</para>
<itemizedlist>
<listitem><para>libvirt: 0.9.4 or higher</para></listitem>
<listitem><para>Qemu/KVM: 1.0 or higher</para></listitem>
</itemizedlist>
</section>
<section id="hypervisor-requirements-ovm">
<title>Oracle VM (OVM) requirements</title>
<para>To be determined</para>
</section>
</section>
</section>

16
docs/en-US/network-offerings.xml
View File

@ -21,10 +21,10 @@
specific language governing permissions and limitations
under the License.
-->
<section id="network-offerings">
<title>Network Offerings</title>
<note><para>For the most up-to-date list of supported network services, see the CloudPlatform UI or call listNetworkServices.</para></note>
<note><para>For the most up-to-date list of supported network services, see the &PRODUCT; UI or call listNetworkServices.</para></note>
<para></para>
<para>A network offering is a named set of network services, such as:</para>
<itemizedlist>
<listitem><para>DHCP</para></listitem>
@ -39,9 +39,11 @@
<listitem><para>(Optional) Network tag to specify which physical network to use</para></listitem>
</itemizedlist>
<para>When creating a new VM, the user chooses one of the available network offerings, and that determines which network services the VM can use.</para>
<para>The CloudPlatform administrator can create any number of custom network offerings, in addition to the default network offerings provided by CloudPlatform. By creating multiple custom network offerings, you can set up your cloud to offer different classes of service on a single multi-tenant physical network. For example, while the underlying physical wiring may be the same for two tenants, tenant A may only need simple firewall protection for their website, while tenant B may be running a web server farm and require a scalable firewall solution, load balancing solution, and alternate networks for accessing the database backend.</para>
<note><para>If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the CloudPlatform virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para></note>
<para>When creating a new virtual network, the CloudPlatform administrator chooses which network offering to enable for that network. Each virtual network is associated with one network offering. A virtual network can be upgraded or downgraded by changing its associated network offering. If you do this, be sure to reprogram the physical network to match.</para>
<para>CloudPlatform also has internal network offerings for use by CloudPlatform system VMs. These network offerings are not visible to users but can be modified by administrators.</para>
<para>The &PRODUCT; administrator can create any number of custom network offerings, in addition to the default network offerings provided by &PRODUCT;. By creating multiple custom network offerings, you can set up your cloud to offer different classes of service on a single multi-tenant physical network. For example, while the underlying physical wiring may be the same for two tenants, tenant A may only need simple firewall protection for their website, while tenant B may be running a web server farm and require a scalable firewall solution, load balancing solution, and alternate networks for accessing the database backend.</para>
<note><para>If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para></note>
<para></para>
<para>When creating a new virtual network, the &PRODUCT; administrator chooses which network offering to enable for that network. Each virtual network is associated with one network offering. A virtual network can be upgraded or downgraded by changing its associated network offering. If you do this, be sure to reprogram the physical network to match.</para>
<para>&PRODUCT; also has internal network offerings for use by &PRODUCT; system VMs. These network offerings are not visible to users but can be modified by administrators.</para>
<xi:include href="creating-network-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="create-vr-network-offering.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

103
docs/en-US/network-service-providers.xml
View File

@ -24,12 +24,109 @@
<section id="network-service-providers">
<title>Network Service Providers</title>
<note><para>For the most up-to-date list of supported network service providers, see the CloudPlatform UI or call listNetworkServiceProviders.</para></note>
<note><para>For the most up-to-date list of supported network service providers, see the &PRODUCT; UI or call listNetworkServiceProviders.</para></note>
<para>A service provider (also called a network element) is hardware or virtual appliance that makes a network service possible; for example, a firewall appliance can be installed in the cloud to provide firewall service. On a single network, multiple providers can provide the same network service. For example, a firewall service may be provided by Cisco or Juniper devices in the same physical network.</para>
<para>You can have multiple instances of the same service provider in a network (say, more than one Juniper SRX device).</para>
<para>If different providers are set up to provide the same service on the network, the administrator can create network offerings so users can specify which network service provider they prefer (along with the other choices offered in network offerings). Otherwise, CloudPlatform will choose which provider to use whenever the service is called for. </para>
<para>If different providers are set up to provide the same service on the network, the administrator can create network offerings so users can specify which network service provider they prefer (along with the other choices offered in network offerings). Otherwise, &PRODUCT; will choose which provider to use whenever the service is called for. </para>
<formalpara>
<title>Supported Network Service Providers</title>
<para>CloudPlatform ships with an internal list of the supported service providers, and you can choose from this list when creating a network offering.</para>
<para>&PRODUCT; ships with an internal list of the supported service providers, and you can choose from this list when creating a network offering.</para>
</formalpara>
<informaltable>
<tgroup cols="6" align="left" colsep="1" rowsep="1">
<colspec colnum="1" colname="c1" colwidth="2.4*"/>
<colspec colnum="2" colname="c2" colwidth="1.14*"/>
<colspec colnum="3" colname="c3" colwidth="1.23*"/>
<colspec colnum="4" colname="c4" colwidth="1.0*"/>
<colspec colnum="5" colname="c5" colwidth="1.3*"/>
<colspec colnum="6" colname="c6" colwidth="1.3*"/>
<thead>
<row>
<entry></entry>
<entry><para>Virtual Router</para></entry>
<entry><para>Citrix NetScaler</para></entry>
<entry><para>Juniper SRX</para></entry>
<entry><para>F5 BigIP</para></entry>
<entry><para>Host based (KVM/Xen)</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>Remote Access VPN</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>DNS/DHCP/User Data</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>Firewall</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>Load Balancing</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>Elastic IP</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>Elastic LB</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>Source NAT</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>Static NAT</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>Port Forwarding</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

15
docs/en-US/networking-in-a-pod.xml
View File

@ -21,15 +21,19 @@
specific language governing permissions and limitations
under the License.
-->
<section id="networking-in-a-pod">
<title>Networking in a Pod</title>
<para>Figure 2 illustrates network setup within a single pod. The hosts are connected to a pod-level switch. At a minimum, the hosts should have one physical uplink to each switch. Bonded NICs are supported as well. The pod-level switch is a pair of redundant gigabit switches with 10 G uplinks.</para>
<para>The figure below illustrates network setup within a single pod. The hosts are connected to a
pod-level switch. At a minimum, the hosts should have one physical uplink to each switch.
Bonded NICs are supported as well. The pod-level switch is a pair of redundant gigabit
switches with 10 G uplinks.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/networking-in-a-pod.png" />
<imagedata fileref="./images/network-singlepod.png" />
</imageobject>
<textobject><phrase>networking-in-a-pod.png: Network setup in a pod</phrase></textobject>
<textobject>
<phrase>networksinglepod.png: diagram showing logical view of network in a pod</phrase>
</textobject>
</mediaobject>
<para>Servers are connected as follows:</para>
<itemizedlist>
@ -38,4 +42,5 @@
<listitem><para>Hosts are also connected to one or more networks carrying guest traffic.</para></listitem>
</itemizedlist>
<para>We recommend the use of multiple physical Ethernet cards to implement each network interface as well as redundant switch fabric in order to maximize throughput and improve reliability.</para>
</section>
</section>

12
docs/en-US/networking-in-a-zone.xml
View File

@ -21,16 +21,18 @@
specific language governing permissions and limitations
under the License.
-->
<section id="networking-in-a-zone">
<title>Networking in a Zone</title>
<para>Figure 3 illustrates the network setup within a single zone.</para>
<para>The following figure illustrates the network setup within a single zone.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/networking-in-a-zone.png" />
<imagedata fileref="./images/network-setup-zone.png" />
</imageobject>
<textobject><phrase>networking-in-a-zone.png: Network setup in a single zone</phrase></textobject>
<textobject>
<phrase>networksetupzone.png: Depicts network setup in a single zone</phrase>
</textobject>
</mediaobject>
<para>A firewall for management traffic operates in the NAT mode. The network typically is assigned IP addresses in the 192.168.0.0/16 Class B private address space. Each pod is assigned IP addresses in the 192.168.*.0/24 Class C private address space.</para>
<para>Each zone has its own set of public IP addresses. Public IP addresses from different zones do not overlap.</para>
</section>
</section>

7
docs/en-US/networking-overview.xml
View File

@ -21,15 +21,14 @@
specific language governing permissions and limitations
under the License.
-->
<section id="networking-overview">
<title>Networking Overview</title>
<para>
&PRODUCT; offers two types of networking scenario:
<para>&PRODUCT; offers two types of networking scenario:
</para>
<itemizedlist>
<listitem><para>Basic. For AWS-style networking. Provides a single network where guest isolation can be provided through layer-3 means such as security groups (IP address source filtering).</para></listitem>
<listitem><para>Advanced. For more sophisticated network topologies. This network model provides the most flexibility in defining guest networks.</para></listitem>
</itemizedlist>
<para>For more details, see Network Setup.</para>
</section>
</section>

19
docs/en-US/pod-add.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!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;
]>
@ -24,5 +24,20 @@
<section id="pod-add">
<title>Adding a Pod</title>
<para>TODO</para>
<para>When you created a new zone, &PRODUCT; adds the first pod for you. You can add more pods at any time using the procedure in this section.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI. See <xref linkend="log-in"/>.</para></listitem>
<listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone to which you want to add a pod.</para></listitem>
<listitem><para>Click the Compute and Storage tab. In the Pods node of the diagram, click View All.</para></listitem>
<listitem><para>Click Add Pod.</para></listitem>
<listitem><para>Enter the following details in the dialog.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> The name of the pod.</para></listitem>
<listitem><para><emphasis role="bold">Gateway.</emphasis> The gateway for the hosts in that pod.</para></listitem>
<listitem><para><emphasis role="bold">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>Click OK.</para></listitem>
</orderedlist>
</section>

18
docs/en-US/port-forwarding.xml
View File

@ -21,7 +21,6 @@
specific language governing permissions and limitations
under the License.
-->
<section id="port-forwarding">
<title>Port Forwarding</title>
<para>A port forward service is a set of port forwarding rules that define a policy. A port forward service is then applied to one or more guest VMs. The guest VM then has its inbound network access managed according to the policy defined by the port forwarding service. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses to be forwarded.</para>
@ -29,20 +28,23 @@
<para>You cannot use port forwarding to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See Security Groups.</para>
<para>To set up port forwarding:</para>
<orderedlist>
<listitem><para>Log in to the CloudPlatform UI as an administrator or end user.</para></listitem>
<listitem><para>If you have not already done so, add a public IP address range to a zone in CloudPlatform. See Adding a Zone and Pod in the Installation Guide.</para></listitem>
<listitem><para>Add one or more VM instances to CloudPlatform.</para></listitem>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>If you have not already done so, add a public IP address range to a zone in &PRODUCT;. See Adding a Zone and Pod in the Installation Guide.</para></listitem>
<listitem><para>Add one or more VM instances to &PRODUCT;.</para></listitem>
<listitem><para>In the left navigation bar, click Network.</para></listitem>
<listitem><para>Click the name of the guest network where the VMs are running.</para>
</listitem>
<listitem><para>Choose an existing IP address or acquire a new IP address. (See Acquiring a New IP Address on page 73.) Click the name of the IP address in the list.</para></listitem>
<listitem><para>Choose an existing IP address or acquire a new IP address. See <xref linkend="acquire-new-ip-address"/>. Click the name of the IP address in the list.</para></listitem>
<listitem><para>Click the Configuration tab.</para></listitem>
<listitem><para>In the Port Forwarding node of the diagram, click View All.</para></listitem>
<listitem><para>Fill in the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Public Port</emphasis>. The port to which public traffic will be addressed on the IP address you acquired in the previous step.</para></listitem>
<listitem><para><emphasis role="bold">Private Port</emphasis>. The port on which the instance is listening for forwarded public traffic.</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The communication protocol in use between the two ports.</para></listitem>
<listitem><para><emphasis role="bold">Public Port</emphasis>. The port to which public traffic will be
addressed on the IP address you acquired in the previous step.</para></listitem>
<listitem><para><emphasis role="bold">Private Port</emphasis>. The port on which the instance is listening for
forwarded public traffic.</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The communication protocol in use between the two
ports</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>

28
docs/en-US/primary-storage-add.xml
View File

@ -24,5 +24,31 @@
<section id="primary-storage-add">
<title>Adding Primary Storage</title>
<para>TODO</para>
<note><para>Ensure that nothing stored on the server. Adding the server to &PRODUCT; will destroy any existing data.</para></note>
<para>When you create a new zone, the first primary storage is added as part of that procedure. You can add primary storage servers at any time, such as when adding a new cluster or adding more servers to an existing cluster.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI.</para></listitem>
<listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the primary storage.</para></listitem>
<listitem><para>Click the Compute tab.</para></listitem>
<listitem><para>In the Primary Storage node of the diagram, click View All.</para></listitem>
<listitem><para>Click Add Primary Storage.</para></listitem>
<listitem><para>Provide the following information in the dialog. The information required varies depending on your choice in Protocol.</para>
<itemizedlist>
<listitem><para>Pod. The pod for the storage device.</para></listitem>
<listitem><para>Cluster. The cluster for the storage device.</para></listitem>
<listitem><para>Name. The name of the storage device</para></listitem>
<listitem><para>Protocol. For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS</para></listitem>
<listitem><para>Server (for NFS, iSCSI, or PreSetup). The IP address or DNS name of the storage device</para></listitem>
<listitem><para>Server (for VMFS). The IP address or DNS name of the vCenter server.</para></listitem>
<listitem><para>Path (for NFS). In NFS this is the exported path from the server.</para></listitem>
<listitem><para>Path (for VMFS). In vSphere this is a combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para></listitem>
<listitem><para>Path (for SharedMountPoint). With KVM this is the path on each host that is where this primary storage is mounted. For example, "/mnt/primary".</para></listitem>
<listitem><para>SR Name-Label (for PreSetup). Enter the name-label of the SR that has been set up outside &PRODUCT;.</para></listitem>
<listitem><para>Target IQN (for iSCSI). In iSCSI this is the IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984</para></listitem>
<listitem><para>Lun # (for iSCSI). In iSCSI this is the LUN number. For example, 3.</para></listitem>
<listitem><para>Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

10
docs/en-US/primary-storage.xml
View File

@ -24,5 +24,11 @@
<section id="primary-storage">
<title>Primary Storage</title>
<para>This section gives concepts and technical details about CloudPlatform primary storage. For information about how to install and configure primary storage through the CloudPlatform UI, see the Advanced Installation Guide.</para>
</section>
<para>This section gives concepts and technical details about &PRODUCT; primary storage. For information about how to install and configure primary storage through the &PRODUCT; UI, see the Advanced Installation Guide.</para>
<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" />
</section>

23
docs/en-US/projects.xml
View File

@ -22,10 +22,19 @@
under the License.
-->
<section id="projects">
<title>Projects</title>
<para>Projects are used to organize people and resources. &PRODUCT; users within a single domain can group themselves into project teams so they can collaborate and share virtual resources such as VMs, snapshots, templates, data disks, and IP addresses. &PRODUCT; tracks resource usage per project as well as per user, so the usage can be billed to either a user account or a project. For example, a private cloud within a software company might have all members of the QA department assigned to one project, so the company can track the resources used in testing while the project members can more easily isolate their efforts from other users of the same cloud</para>
<para>You can configure &PRODUCT; to allow any user to create a new project, or you can restrict that ability to just &PRODUCT; administrators. Once you have created a project, you become that project’s administrator, and you can add others within your domain to the project. &PRODUCT; can be set up either so that you can add people directly to a project, or so that you have to send an invitation which the recipient must accept. Project members can view and manage all virtual resources created by anyone in the project (for example, share VMs). A user can be a member of any number of projects and can switch views in the &PRODUCT; UI to show only project-related information, such as project VMs, fellow project members, project-related alerts, and so on.</para>
<para>The project administrator can pass on the role to another project member. The project administrator can also add more members, remove members from the project, set new resource limits (as long as they are below the global defaults set by the &PRODUCT; administrator), and delete the project. When the administrator removes a member from the project, resources created by that user, such as VM instances, remain with the project. This brings us to the subject of resource ownership and which resources can be used by a project.</para>
<para>Resources created within a project are owned by the project, not by any particular &PRODUCT; account, and they can be used only within the project. A user who belongs to one or more projects can still create resources outside of those projects, and those resources belong to the user’s account; they will not be counted against the project’s usage or resource limits. You can create project-level networks to isolate traffic within the project and provide network services such as port forwarding, load balancing, VPN, and static NAT. A project can also make use of certain types of resources from outside the project, if those resources are shared. For example, a shared network or public template is available to any project in the domain. A project can get access to a private template if the template’s owner will grant permission. A project can use any service offering or disk offering available in its domain; however, you can not create private service and disk offerings at the project level..</para>
</section>
<chapter id="projects">
<title>Using Projects to Organize Users and Resources</title>
<xi:include href="projects-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-up-invitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="configuring-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-resource-limits-for-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-projects-creator-permissions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="create-new-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-members-to-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="send-projects-membership-invitation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-projects-members-from-ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accept-membership-invite.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="suspend-project.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="use-project-view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

2
docs/en-US/provisioning-steps-overview.xml
View File

@ -21,13 +21,11 @@
specific language governing permissions and limitations
under the License.
-->
<section id="provisioning-steps-overview">
<title>Overview of Provisioning Steps</title>
<para>After the Management Server is installed and running, you can add the compute resources for it to manage. For an overview of how a &PRODUCT; cloud infrastructure is organized, see <xref linkend="cloud-infrastructure-overview" />.</para>
<para>To provision the cloud infrastructure, or to scale it up at any time, follow these procedures:</para>
<orderedlist>
<listitem><para>Change the root password. See <xref linkend="changing-root-password" />.</para></listitem>
<listitem><para>Add a zone. See <xref linkend="zone-add" />.</para></listitem>
<listitem><para>Add more pods (optional). See <xref linkend="pod-add" />.</para></listitem>
<listitem><para>Add more clusters (optional). See <xref linkend="cluster-add" />.</para></listitem>

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