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

Merge branch 'master' into vpc 

Conflicts:
	plugins/hypervisors/kvm/src/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java
This commit is contained in:
Alena Prokharchyk 2012-08-11 18:27:18 -07:00
parent d93c5d0531 6e33102df7
commit b61468d65c
296 changed files with 6737 additions and 4674 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api/src/com/cloud/storage/Storage.java
View File

@ -96,6 +96,7 @@ public class Storage {
Iscsi(true), // for e.g., ZFS Comstar
ISO(false), // for iso image
LVM(false), // XenServer local LVM SR
CLVM(true),
RBD(true),
SharedMountPoint(true),
VMFS(true), // VMware VMFS storage

49
core/src/com/cloud/agent/resource/virtualnetwork/VirtualRoutingResource.java
View File

@ -706,49 +706,6 @@ public class VirtualRoutingResource implements Manager {
return routerProxy("ipassoc.sh", privateIpAddress, args);
}
private void deletExitingLinkLocalRoutTable(String linkLocalBr) {
Script command = new Script("/bin/bash", _timeout);
command.add("-c");
command.add("ip route | grep " + NetUtils.getLinkLocalCIDR());
OutputInterpreter.AllLinesParser parser = new OutputInterpreter.AllLinesParser();
String result = command.execute(parser);
boolean foundLinkLocalBr = false;
if (result == null && parser.getLines() != null) {
String[] lines = parser.getLines().split("\\n");
for (String line : lines) {
String[] tokens = line.split(" ");
if (!tokens[2].equalsIgnoreCase(linkLocalBr)) {
Script.runSimpleBashScript("ip route del " + NetUtils.getLinkLocalCIDR());
} else {
foundLinkLocalBr = true;
}
}
}
if (!foundLinkLocalBr) {
Script.runSimpleBashScript("ifconfig " + linkLocalBr + " 169.254.0.1;" + "ip route add " + NetUtils.getLinkLocalCIDR() + " dev " + linkLocalBr + " src " + NetUtils.getLinkLocalGateway());
}
}
public void createControlNetwork(String privBrName) {
deletExitingLinkLocalRoutTable(privBrName);
if (!isBridgeExists(privBrName)) {
Script.runSimpleBashScript("brctl addbr " + privBrName + "; ifconfig " + privBrName + " up; ifconfig " + privBrName + " 169.254.0.1", _timeout);
}
}
private boolean isBridgeExists(String bridgeName) {
Script command = new Script("/bin/sh", _timeout);
command.add("-c");
command.add("brctl show|grep " + bridgeName);
final OutputInterpreter.OneLineParser parser = new OutputInterpreter.OneLineParser();
String result = command.execute(parser);
if (result != null || parser.getLine() == null) {
return false;
} else {
return true;
}
}
private void deleteBridge(String brName) {
Script cmd = new Script("/bin/sh", _timeout);
cmd.add("-c");
@ -775,12 +732,6 @@ public class VirtualRoutingResource implements Manager {
cmd.execute();
}
public void cleanupPrivateNetwork(String privNwName, String privBrName){
if (isBridgeExists(privBrName)) {
deleteBridge(privBrName);
}
}
// protected Answer execute(final SetFirewallRuleCommand cmd) {
// String args;
// if(cmd.getProtocol().toLowerCase().equals(NetUtils.NAT_PROTO)){

2
core/src/com/cloud/storage/template/DownloadManagerImpl.java
View File

@ -297,7 +297,7 @@ public class DownloadManagerImpl implements DownloadManager {
}
byte[] md5sum = digest.digest();
BigInteger bigInt = new BigInteger(1, md5sum);
checksum = String.format("%032x",bigInt.toString(16));
checksum = String.format("%032x",bigInt);
return checksum;
}catch(IOException e) {
return null;

25
docs/en-US/Author_Group.xml
View File

@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE authorgroup 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">
<!ENTITY % BOOK_ENTITIES SYSTEM "Runbook.ent">
%BOOK_ENTITIES;
]>
@ -22,24 +22,11 @@
under the License.
-->
<authorgroup>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<affiliation>
<orgname>Citrix</orgname>
<orgdiv>Cloud Platform Group</orgdiv>
</affiliation>
<email>jessica.tomechak@citrix.com</email>
</author>
<author>
<firstname>Radhika</firstname>
<surname>PC</surname>
<affiliation>
<orgname>Citrix</orgname>
<orgdiv>Cloud Platform Group</orgdiv>
</affiliation>
<email>radhika.puthiyetath@citrix.com</email>
</author>
<author>
<firstname>Apache</firstname>
<surname>CloudStack</surname>
</author>
</authorgroup>

40
docs/en-US/Book_Info.xml
View File

@ -24,24 +24,24 @@
-->
<bookinfo id="book-release-notes-3.0.4">
<title>&PRODUCT; Guide</title>
<subtitle>Revised August 9, 2012 10:48 pm Pacific</subtitle>
<productname>Apache CloudStack</productname>
<productnumber>4.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Complete technical documentation of &PRODUCT;.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>&PRODUCT; Guide</title>
<subtitle>Revised August 9, 2012 10:48 pm Pacific</subtitle>
<productname>Apache CloudStack</productname>
<productnumber>4.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Complete technical documentation of &PRODUCT;.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>

30
docs/en-US/Common_Content/Legal_Notice.xml
View File

@ -2,20 +2,20 @@
<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
]>
<legalnotice>
<para>
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
</para>
<para>
http://www.apache.org/licenses/LICENSE-2.0
</para>
<para>
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
</para>
<para>
Apache CloudStack is an effort undergoing incubation at The Apache Software Foundation (ASF).
</para>
<para>
Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</para>
<para>
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
</para>
<para>
http://www.apache.org/licenses/LICENSE-2.0
</para>
<para>
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
</para>
<para>
Apache CloudStack is an effort undergoing incubation at The Apache Software Foundation (ASF).
</para>
<para>
Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</para>
</legalnotice>

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

@ -1,16 +1,35 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="LDAPserver-for-user-authentication">
<title>Using an LDAP Server for User Authentication</title>
<para>You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate CloudPlatform end-users. Just map CloudPlatform accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by CloudPlatform for matching common values such as the user’s email address and name. CloudPlatform will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user..</para>
<para>To set up LDAP authentication in CloudPlatform, call the CloudPlatform API command ldapConfig and provide the following:</para>
<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>
<para>To set up LDAP authentication in &PRODUCT;, call the &PRODUCT; API command ldapConfig and provide the following:</para>
<itemizedlist>
<listitem><para>Hostname or IP address and listening port of the LDAP server</para></listitem>
<listitem> <para>Base directory and query filter</para></listitem>
<listitem><para>Search user DN credentials, which give CloudPlatform permission to search on the LDAP server</para></listitem>
<listitem><para>Search user DN credentials, which give &PRODUCT; permission to search on the LDAP server</para></listitem>
<listitem><para>SSL keystore and password, if SSL is used</para></listitem>
</itemizedlist>
<xi:include href="example-LDAP-configuration-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@ -18,4 +37,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>

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

@ -4,10 +4,10 @@
%BOOK_ENTITIES;
]>
<preface id="pref-cloudstack-Preface">
<title>Preface</title>
<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</xi:fallback>
</xi:include>
<title>Preface</title>
<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</xi:fallback>
</xi:include>
</preface>

62
docs/en-US/Revision_History.xml
View File

@ -1,27 +1,45 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE appendix 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;
]>
<appendix id="appe-cloudstack-Revision_History">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
<revnumber>0-0</revnumber>
<date>Tue May 29 2012</date>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<email/>
</author>
<revdescription>
<simplelist>
<member>Initial creation of book by publican</member>
</simplelist>
</revdescription>
</revision>
</revhistory>
</simpara>
</appendix>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<appendix id="appe-cloudstack-Revision_History">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
<revnumber>0-0</revnumber>
<date>Tue May 29 2012</date>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<email/>
</author>
<revdescription>
<simplelist>
<member>Initial creation of book by publican</member>
</simplelist>
</revdescription>
</revision>
</revhistory>
</simpara>
</appendix>

8
docs/en-US/SSL-keystore-path-and-password.xml
View File

@ -4,7 +4,7 @@
%BOOK_ENTITIES;
]>
<section id="SSL-keystore-path-and-password">
<title>SSL Keystore Path and Password</title>
<para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
</section>
<title>SSL Keystore Path and Password</title>
<para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
</section>

28
docs/en-US/VPN-user-usage-record-format.xml
View File

@ -1,17 +1,17 @@
<section id="VPN-user-usage-record-format">
<title>VPN User Usage Record Format</title>
<itemizedlist>
<listitem><para>account – name of the account</para></listitem>
<listitem><para>accountid – ID of the account</para></listitem>
<listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
<listitem><para>zoneid – Zone where the usage occurred</para></listitem>
<listitem><para>description – A string describing what the usage record is tracking</para></listitem>
<listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
<listitem><para>usageid – VPN user ID</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
</itemizedlist>
<title>VPN User Usage Record Format</title>
<itemizedlist>
<listitem><para>account – name of the account</para></listitem>
<listitem><para>accountid – ID of the account</para></listitem>
<listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
<listitem><para>zoneid – Zone where the usage occurred</para></listitem>
<listitem><para>description – A string describing what the usage record is tracking</para></listitem>
<listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
<listitem><para>usageid – VPN user ID</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
</itemizedlist>
</section>

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

@ -23,7 +23,7 @@
-->
<section id="about-clusters">
<title>About Clusters</title>
<title>About Clusters</title>
<para>A cluster provides a way to group hosts. To be precise, a cluster is a XenServer server pool, a set of KVM servers, a set of OVM hosts, or a VMware cluster preconfigured in vCenter. The hosts in a cluster all have identical hardware, run the same hypervisor, are on the same subnet, and access the same shared primary storage. Virtual machine instances (VMs) can be live-migrated from one host to another within the same cluster, without interrupting service to the user.</para>
<para>A cluster is the third-largest organizational unit within a &PRODUCT; deployment. Clusters are contained within pods, and pods are contained within zones. Size of the cluster is limited by the underlying hypervisor, although the &PRODUCT; recommends less in most cases; see Best Practices.</para>
<para>A cluster consists of one or more hosts and one or more primary storage servers.</para>

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

@ -23,7 +23,7 @@
-->
<section id="about-hosts">
<title>About Hosts</title>
<title>About Hosts</title>
<para>A host is a single computer. Hosts provide the computing resources that run the guest virtual machines. Each host has hypervisor software installed on it to manage the guest VMs. For example, a Linux KVM-enabled server, a Citrix XenServer server, and an ESXi server are hosts.</para>
<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>

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

@ -1,10 +1,29 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="about-physical-networks">
<title>About Physical Networks</title>
<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>
<para>A physical network is the actual network hardware and wiring in a zone. A zone can have multiple physical networks. An administrator can:</para>
<itemizedlist>

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

@ -23,7 +23,7 @@
-->
<section id="about-pods">
<title>About Pods</title>
<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>

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

@ -23,7 +23,7 @@
-->
<section id="about-primary-storage">
<title>About Primary Storage</title>
<title>About Primary Storage</title>
<para>Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster. You can add multiple primary storage servers to a cluster. At least one is required. It is typically located close to the hosts for increased performance.</para>
<para>&PRODUCT; is designed to work with all standards-compliant iSCSI and NFS servers that are supported by the underlying hypervisor, including, for example:</para>
<itemizedlist>

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

@ -23,7 +23,7 @@
-->
<section id="about-secondary-storage">
<title>About Secondary Storage</title>
<title>About Secondary Storage</title>
<para>Secondary storage is associated with a zone, and it stores the following:</para>
<itemizedlist>
<listitem><para>Templates &mdash; OS images that can be used to boot VMs and can include additional configuration information, such as installed applications</para></listitem>

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

@ -23,17 +23,17 @@
-->
<section id="about-working-with-vms">
<title>About Working with Virtual Machines</title>
<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>
</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>
<para>If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs.</para>
<para>&PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go through the &PRODUCT; UI or API.</para>
<title>About Working with Virtual Machines</title>
<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>
</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>
<para>If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs.</para>
<para>&PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go through the &PRODUCT; UI or API.</para>
</section>

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

@ -23,7 +23,7 @@
-->
<section id="about-zones">
<title>About Zones</title>
<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>
<para>A zone consists of:</para>
<itemizedlist>

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

@ -23,19 +23,19 @@
-->
<section id="accessing-vms">
<title>Accessing VMs</title>
<para>Any user can access their own virtual machines. The administrator can access all VMs running in the cloud.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<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>
</orderedlist>
<para>To access a VM directly over the network:</para>
<orderedlist>
<listitem><para>The VM must have some port open to incoming traffic. For example, in a basic zone, a new VM might be assigned to a security group which allows incoming traffic. This depends on what security group you picked when creating the VM. In other cases, you can open a port by setting up a port forwarding policy. See IP Forwarding and Firewalling.</para></listitem>
<listitem><para>If a port is open but you can not access the VM using ssh, it’s possible that ssh is not already enabled on the VM. This will depend on whether ssh is enabled in the template you picked when creating the VM. Access the VM through the &PRODUCT; UI and enable ssh on the machine using the commands for the VM’s operating system.</para></listitem>
<listitem><para>If the network has an external firewall device, you will need to create a firewall rule to allow access. See IP Forwarding and Firewalling.</para></listitem>
</orderedlist>
<title>Accessing VMs</title>
<para>Any user can access their own virtual machines. The administrator can access all VMs running in the cloud.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<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>
</orderedlist>
<para>To access a VM directly over the network:</para>
<orderedlist>
<listitem><para>The VM must have some port open to incoming traffic. For example, in a basic zone, a new VM might be assigned to a security group which allows incoming traffic. This depends on what security group you picked when creating the VM. In other cases, you can open a port by setting up a port forwarding policy. See IP Forwarding and Firewalling.</para></listitem>
<listitem><para>If a port is open but you can not access the VM using ssh, it’s possible that ssh is not already enabled on the VM. This will depend on whether ssh is enabled in the template you picked when creating the VM. Access the VM through the &PRODUCT; UI and enable ssh on the machine using the commands for the VM’s operating system.</para></listitem>
<listitem><para>If the network has an external firewall device, you will need to create a firewall rule to allow access. See IP Forwarding and Firewalling.</para></listitem>
</orderedlist>
</section>

20
docs/en-US/acquire-new-ip-address.xml
View File

@ -23,14 +23,14 @@
-->
<section id="acquire-new-ip-address">
<title>Acquiring a New IP Address</title>
<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>Click the name of the network where you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click Acquire New IP, and click Yes in the confirmation dialog.</para>
<para>You are prompted for confirmation because, typically, IP addresses are a limited resource. Within a few moments, the new IP address should appear with the state Allocated. You can now use the IP address in port forwarding or static NAT rules.</para>
</listitem>
</orderedlist>
<title>Acquiring a New IP Address</title>
<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>Click the name of the network where you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click Acquire New IP, and click Yes in the confirmation dialog.</para>
<para>You are prompted for confirmation because, typically, IP addresses are a limited resource. Within a few moments, the new IP address should appear with the state Allocated. You can now use the IP address in port forwarding or static NAT rules.</para>
</listitem>
</orderedlist>
</section>

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

@ -23,21 +23,21 @@
-->
<section id="add-additional-guest-network">
<title>Adding an Additional Guest Network</title>
<itemizedlist>
<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 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>Click Create.</para></listitem>
</itemizedlist>
<title>Adding an Additional Guest Network</title>
<itemizedlist>
<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 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>Click Create.</para></listitem>
</itemizedlist>
</section>
</section>

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

@ -23,37 +23,37 @@
-->
<section id="add-ingress-egress-rules">
<title>Adding Ingress and Egress Rules to a Security Group</title>
<itemizedlist>
<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>
</itemizedlist>
<para>The following example allows inbound HTTP access from anywhere:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/http-access.png" />
</imageobject>
<textobject><phrase>httpaccess.png: allows inbound HTTP access from anywhere</phrase></textobject>
</mediaobject>
</listitem>
<listitem><para>To add an egress rule, click the Egress Rules tab and fill out the following fields to specify what type of traffic is allowed to be sent out of VM instances in this security group. If no egress rules are specified, then all traffic will be allowed out. Once egress rules are specified, the following types of traffic are allowed out: traffic specified in egress rules; queries to DNS and DHCP servers; and responses to any traffic that has been allowed in through an ingress rule</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the destination of the traffic will be defined by IP address (CIDR) or an existing security group in a &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>
<title>Adding Ingress and Egress Rules to a Security Group</title>
<itemizedlist>
<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>
</itemizedlist>
<para>The following example allows inbound HTTP access from anywhere:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/http-access.png" />
</imageobject>
<textobject><phrase>httpaccess.png: allows inbound HTTP access from anywhere</phrase></textobject>
</mediaobject>
</listitem>
<listitem><para>To add an egress rule, click the Egress Rules tab and fill out the following fields to specify what type of traffic is allowed to be sent out of VM instances in this security group. If no egress rules are specified, then all traffic will be allowed out. Once egress rules are specified, the following types of traffic are allowed out: traffic specified in egress rules; queries to DNS and DHCP servers; and responses to any traffic that has been allowed in through an ingress rule</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the destination of the traffic will be defined by IP address (CIDR) or an existing security group in a &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>
</section>

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

@ -23,69 +23,69 @@
-->
<section id="add-iso">
<title>Adding an ISO</title>
<para>To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>In Select View, choose ISOs.</para></listitem>
<listitem><para>Click Add ISO.</para></listitem>
<listitem><para>In the Add ISO screen, provide the following:</para>
<itemizedlist>
<listitem><para>Name. Short name for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>Description. Display test for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>URL. The URL that hosts the ISO image. The Management Server must be able to access this location via HTTP. If needed you can place the ISO image directly on the Management Server</para></listitem>
<listitem><para>Zone. Choose the zone where you want the ISO to be available, or All Zones to make it available throughout &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>
<itemizedlist>
<listitem><para>If the operating system of your desired ISO image is listed, choose it.</para></listitem>
<listitem><para>If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other.</para></listitem>
<listitem><para>(XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit)</para></listitem>
<listitem><para>(KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are:</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Fedora 13</para></entry>
<entry><para>Fedora 12</para></entry>
<entry><para>Fedora 11</para></entry>
</row>
<row>
<entry><para>Fedora 10</para></entry>
<entry><para>Fedora 9</para></entry>
<entry><para>Other PV</para></entry>
</row>
<row>
<entry><para>Debian GNU/Linux</para></entry>
<entry><para>CentOS 5.3</para></entry>
<entry><para>CentOS 5.4</para></entry>
</row>
<row>
<entry><para>CentOS 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 5.3</para></entry>
<entry><para>Red Hat Enterprise Linux 5.4</para></entry>
</row>
<row>
<entry><para>Red Hat Enterprise Linux 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 6</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable></listitem>
</itemizedlist>
<note><para>Note: It is not recommended to choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually not work. In these cases, choose Other.</para></note>
</listitem>
<listitem><para>Extractable. Choose Yes if the ISO should be available for extraction.</para></listitem>
<listitem><para>Public. Choose Yes if this ISO should be available to other users.</para></listitem>
<listitem><para>Featured. Choose Yes if you would like this ISO to be more prominent for users to select. The ISO will appear in the Featured ISOs list. Only an administrator can make an ISO Featured.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click OK.</para>
<para>The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage.</para>
</listitem>
<listitem><para><emphasis role="bold">Important</emphasis>: Wait for the ISO to finish downloading. If you move on to the next task and try to use the ISO right away, it will appear to fail. The entire ISO must be available before &PRODUCT; can work with it</para></listitem>
</orderedlist>
<title>Adding an ISO</title>
<para>To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>In Select View, choose ISOs.</para></listitem>
<listitem><para>Click Add ISO.</para></listitem>
<listitem><para>In the Add ISO screen, provide the following:</para>
<itemizedlist>
<listitem><para>Name. Short name for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>Description. Display test for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>URL. The URL that hosts the ISO image. The Management Server must be able to access this location via HTTP. If needed you can place the ISO image directly on the Management Server</para></listitem>
<listitem><para>Zone. Choose the zone where you want the ISO to be available, or All Zones to make it available throughout &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>
<itemizedlist>
<listitem><para>If the operating system of your desired ISO image is listed, choose it.</para></listitem>
<listitem><para>If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other.</para></listitem>
<listitem><para>(XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit)</para></listitem>
<listitem><para>(KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are:</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Fedora 13</para></entry>
<entry><para>Fedora 12</para></entry>
<entry><para>Fedora 11</para></entry>
</row>
<row>
<entry><para>Fedora 10</para></entry>
<entry><para>Fedora 9</para></entry>
<entry><para>Other PV</para></entry>
</row>
<row>
<entry><para>Debian GNU/Linux</para></entry>
<entry><para>CentOS 5.3</para></entry>
<entry><para>CentOS 5.4</para></entry>
</row>
<row>
<entry><para>CentOS 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 5.3</para></entry>
<entry><para>Red Hat Enterprise Linux 5.4</para></entry>
</row>
<row>
<entry><para>Red Hat Enterprise Linux 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 6</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable></listitem>
</itemizedlist>
<note><para>Note: It is not recommended to choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually not work. In these cases, choose Other.</para></note>
</listitem>
<listitem><para>Extractable. Choose Yes if the ISO should be available for extraction.</para></listitem>
<listitem><para>Public. Choose Yes if this ISO should be available to other users.</para></listitem>
<listitem><para>Featured. Choose Yes if you would like this ISO to be more prominent for users to select. The ISO will appear in the Featured ISOs list. Only an administrator can make an ISO Featured.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click OK.</para>
<para>The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage.</para>
</listitem>
<listitem><para><emphasis role="bold">Important</emphasis>: Wait for the ISO to finish downloading. If you move on to the next task and try to use the ISO right away, it will appear to fail. The entire ISO must be available before &PRODUCT; can work with it</para></listitem>
</orderedlist>
</section>

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

@ -23,24 +23,24 @@
-->
<section id="add-load-balancer-rule">
<title>Adding a Load Balancer Rule</title>
<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>Click the name of the network where you want to load balance the traffic.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click the IP address for which you want to create the rule, then click the Configuration tab.</para></listitem>
<listitem><para>In the Load Balancing node of the diagram, click View All.</para></listitem>
<listitem><para>Fill in the following:</para>
<itemizedlist>
<listitem><para>Name. A name for the load balancer rule.</para></listitem>
<listitem><para>Public Port. The port receiving incoming traffic to be balanced.</para></listitem>
<listitem><para>Private Port. The port that the VMs will use to receive the traffic.</para></listitem>
<listitem><para>Algorithm. Choose the load balancing algorithm you want &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>
</itemizedlist></listitem>
<listitem><para>Click Add VMs, then select two or more VMs that will divide the load of incoming traffic, and click Apply.</para>
<para>The new load balancer rule appears in the list. You can repeat these steps to add more load balancer rules for this IP address.</para>
</listitem>
</orderedlist>
<title>Adding a Load Balancer Rule</title>
<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>Click the name of the network where you want to load balance the traffic.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click the IP address for which you want to create the rule, then click the Configuration tab.</para></listitem>
<listitem><para>In the Load Balancing node of the diagram, click View All.</para></listitem>
<listitem><para>Fill in the following:</para>
<itemizedlist>
<listitem><para>Name. A name for the load balancer rule.</para></listitem>
<listitem><para>Public Port. The port receiving incoming traffic to be balanced.</para></listitem>
<listitem><para>Private Port. The port that the VMs will use to receive the traffic.</para></listitem>
<listitem><para>Algorithm. Choose the load balancing algorithm you want &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>
</itemizedlist></listitem>
<listitem><para>Click Add VMs, then select two or more VMs that will divide the load of incoming traffic, and click Apply.</para>
<para>The new load balancer rule appears in the list. You can repeat these steps to add more load balancer rules for this IP address.</para>
</listitem>
</orderedlist>
</section>

10
docs/en-US/add-password-management-to-templates.xml
View File

@ -23,11 +23,11 @@
-->
<section id="add-password-management-to-templates">
<title>Adding Password Management to Your Templates</title>
<para>&PRODUCT; provides an optional password reset feature that allows users to set a temporary admin or root password as well as reset the existing admin or root password from the &PRODUCT; UI.</para>
<para>To enable the Reset Password feature, you will need to download an additional script to patch your template. When you later upload the template into &PRODUCT;, you can specify whether reset admin/root password feature should be enabled for this template.</para>
<para>The password management feature works always resets the account password on instance boot. The script does an HTTP call to the virtual router to retrieve the account password that should be set. As long as the virtual router is accessible the guest will have access to the account password that should be used. When the user requests a password reset the management server generates and sends a new password to the virtual router for the account. Thus an instance reboot is necessary to effect any password changes.</para>
<para>If the script is unable to contact the virtual router during instance boot it will not set the password but boot will continue normally.</para>
<title>Adding Password Management to Your Templates</title>
<para>&PRODUCT; provides an optional password reset feature that allows users to set a temporary admin or root password as well as reset the existing admin or root password from the &PRODUCT; UI.</para>
<para>To enable the Reset Password feature, you will need to download an additional script to patch your template. When you later upload the template into &PRODUCT;, you can specify whether reset admin/root password feature should be enabled for this template.</para>
<para>The password management feature works always resets the account password on instance boot. The script does an HTTP call to the virtual router to retrieve the account password that should be set. As long as the virtual router is accessible the guest will have access to the account password that should be used. When the user requests a password reset the management server generates and sends a new password to the virtual router for the account. Thus an instance reboot is necessary to effect any password changes.</para>
<para>If the script is unable to contact the virtual router during instance boot it will not set the password but boot will continue normally.</para>
<xi:include href="linux-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="windows-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -23,17 +23,17 @@
-->
<section id="add-security-group">
<title>Adding a Security Group</title>
<para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
<itemizedlist>
<listitem><para>Log in to the &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>
<listitem><para>Click Add Security Group.</para></listitem>
<listitem><para>Provide a name and description.</para></listitem>
<listitem><para>Click OK.</para>
<para>The new security group appears in the Security Groups Details tab.</para></listitem>
<listitem><para>To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group.</para></listitem>
</itemizedlist>
<title>Adding a Security Group</title>
<para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
<itemizedlist>
<listitem><para>Log in to the &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>
<listitem><para>Click Add Security Group.</para></listitem>
<listitem><para>Provide a name and description.</para></listitem>
<listitem><para>Click OK.</para>
<para>The new security group appears in the Security Groups Details tab.</para></listitem>
<listitem><para>To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group.</para></listitem>
</itemizedlist>
</section>

284
docs/en-US/added-API-commands.xml
View File

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

224
docs/en-US/added-cloudPlatform-error-codes.xml
View File

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

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

@ -23,23 +23,23 @@
-->
<section id="adding-IP-addresses-for-the-public-network">
<title>Adding IP Addresses for the Public Network</title>
<para>These instructions assume you have already logged in to the &PRODUCT; UI.</para>
<orderedlist>
<listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the desired zone .</para></listitem>
<listitem><para>Click the Network tab.</para></listitem>
<listitem><para>In the Public node of the diagram, click Configure.</para></listitem>
<listitem><para>Click the IP Ranges tab.</para></listitem>
<listitem><para>Provide the following information:</para>
<itemizedlist>
<listitem><para>Gateway. The gateway in use for these IP addresses</para></listitem>
<listitem><para>Netmask. The netmask associated with this IP range</para></listitem>
<listitem><para>VLAN. The VLAN that will be used for public traffic</para></listitem>
<listitem><para>Start IP/End IP. A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>
<title>Adding IP Addresses for the Public Network</title>
<para>These instructions assume you have already logged in to the &PRODUCT; UI.</para>
<orderedlist>
<listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the desired zone .</para></listitem>
<listitem><para>Click the Network tab.</para></listitem>
<listitem><para>In the Public node of the diagram, click Configure.</para></listitem>
<listitem><para>Click the IP Ranges tab.</para></listitem>
<listitem><para>Provide the following information:</para>
<itemizedlist>
<listitem><para>Gateway. The gateway in use for these IP addresses</para></listitem>
<listitem><para>Netmask. The netmask associated with this IP range</para></listitem>
<listitem><para>VLAN. The VLAN that will be used for public traffic</para></listitem>
<listitem><para>Start IP/End IP. A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

2
docs/en-US/admin-guide.xml
View File

@ -23,7 +23,7 @@
-->
<chapter id="admin-guide">
<title>Administrator Guide</title>
<title>Administrator Guide</title>
<xi:include href="whats-in-this-adminguide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-working-with-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

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

@ -23,6 +23,6 @@
-->
<section id="advanced-zone-configuration">
<title>Advanced Zone Configuration</title>
<title>Advanced Zone Configuration</title>
<para>TODO</para>
</section>

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

@ -1,9 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="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>
</section>
</section>

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

@ -1,10 +1,29 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="advanced-zone-network-traffic-types">
<title>Advanced Zone Network Traffic Types</title>
<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>
<itemizedlist>
<listitem><para>Guest. When end users run VMs, they generate guest traffic. The guest VMs communicate with each other over a network that can be referred to as the guest network. This network can be isolated or shared. In an isolated guest network, the administrator needs to reserve VLAN ranges to provide isolation for each &PRODUCT; account’s network (potentially a large number of VLANs). In a shared guest network, all guest VMs share a single network.</para></listitem>
@ -13,4 +32,4 @@
<listitem><para>Storage. Traffic such as VM templates and snapshots, which is sent between the secondary storage VM and secondary storage servers. &PRODUCT; uses a separate Network Interface Controller (NIC) named storage NIC for storage network traffic. Use of a storage NIC that always operates on a high bandwidth network allows fast template and snapshot copying. You must configure the IP range to use for the storage network.</para></listitem>
</itemizedlist>
<para>These traffic types can each be on a separate physical network, or they can be combined with certain restrictions. When you use the Add Zone wizard in the UI to create a new zone, you are guided into making only valid choices.</para>
</section>
</section>

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

@ -23,6 +23,6 @@
-->
<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>
<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>

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

@ -1,9 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="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>
</section>
</section>

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

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

14
docs/en-US/api-reference.xml
View File

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

234
docs/en-US/appendix-a-time-zones.xml
View File

@ -23,121 +23,121 @@
-->
<section id="appendix-a-time-zones">
<title>Appendix A—Time Zones</title>
<para>The following time zone identifiers are accepted by &PRODUCT;. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table.</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Etc/GMT+12</para></entry>
<entry><para>America/La_Paz</para></entry>
<entry><para>Asia/Jerusalem</para></entry>
</row>
<row>
<entry><para>Etc/GMT+11</para></entry>
<entry><para>America/Santiago</para></entry>
<entry><para>Europe/Minsk</para></entry>
</row>
<row>
<entry><para>Pacific/Samoa</para></entry>
<entry><para>America/St_Johns</para></entry>
<entry><para>Europe/Moscow</para></entry>
</row>
<row>
<entry><para>Pacific/Honolulu</para></entry>
<entry><para>America/Araguaina</para></entry>
<entry><para>Africa/Nairobi</para></entry>
</row>
<row>
<entry><para>US/Alaska</para></entry>
<entry><para>America/Los_Angeles</para></entry>
<entry><para>Mexico/BajaNorte</para></entry>
</row>
<row>
<entry><para>US/Arizona</para></entry>
<entry><para>US/Mountain</para></entry>
<entry><para>America/Chihuahua</para></entry>
</row>
<row>
<entry><para>America/Chicago</para></entry>
<entry><para>America/Costa_Rica</para></entry>
<entry><para>America/Mexico_City</para></entry>
</row>
<row>
<entry><para>Canada/Saskatchewan</para></entry>
<entry><para>America/Bogota</para></entry>
<entry><para>America/New_York</para></entry>
</row>
<row>
<entry><para>America/Caracas</para></entry>
<entry><para>America/Asuncion</para></entry>
<entry><para>America/Cuiaba</para></entry>
</row>
<row>
<entry><para>America/Halifax</para></entry>
<entry><para>America/Argentina/Buenos_Aires</para></entry>
<entry><para>America/Cayenne</para></entry>
</row>
<row>
<entry><para>America/Godthab</para></entry>
<entry><para>America/Montevideo</para></entry>
<entry><para>Etc/GMT+2</para></entry>
</row>
<row>
<entry><para>Atlantic/Azores</para></entry>
<entry><para>Atlantic/Cape_Verde</para></entry>
<entry><para>Africa/Casablanca</para></entry>
</row>
<row>
<entry><para>Etc/UTC</para></entry>
<entry><para>Atlantic/Reykjavik</para></entry>
<entry><para>Europe/London</para></entry>
</row>
<row>
<entry><para>CET</para></entry>
<entry><para>Europe/Bucharest</para></entry>
<entry><para>Africa/Johannesburg</para></entry>
</row>
<row>
<entry><para>Asia/Beirut</para></entry>
<entry><para>Africa/Cairo</para></entry>
<entry><para>Asia/Karachi</para></entry>
</row>
<row>
<entry><para>Asia/Kolkata</para></entry>
<entry><para>Asia/Bangkok</para></entry>
<entry><para>Asia/Shanghai</para></entry>
</row>
<row>
<entry><para>Asia/Kuala_Lumpur</para></entry>
<entry><para>Australia/Perth</para></entry>
<entry><para>Asia/Taipei</para></entry>
</row>
<row>
<entry><para>Asia/Tokyo</para></entry>
<entry><para>Asia/Seoul</para></entry>
<entry><para>Australia/Adelaide</para></entry>
</row>
<row>
<entry><para>Australia/Darwin</para></entry>
<entry><para>Australia/Brisbane</para></entry>
<entry><para>Australia/Canberra</para></entry>
</row>
<row>
<entry><para>Pacific/Guam</para></entry>
<entry><para>Pacific/Auckland</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<title>Appendix A—Time Zones</title>
<para>The following time zone identifiers are accepted by &PRODUCT;. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table.</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Etc/GMT+12</para></entry>
<entry><para>America/La_Paz</para></entry>
<entry><para>Asia/Jerusalem</para></entry>
</row>
<row>
<entry><para>Etc/GMT+11</para></entry>
<entry><para>America/Santiago</para></entry>
<entry><para>Europe/Minsk</para></entry>
</row>
<row>
<entry><para>Pacific/Samoa</para></entry>
<entry><para>America/St_Johns</para></entry>
<entry><para>Europe/Moscow</para></entry>
</row>
<row>
<entry><para>Pacific/Honolulu</para></entry>
<entry><para>America/Araguaina</para></entry>
<entry><para>Africa/Nairobi</para></entry>
</row>
<row>
<entry><para>US/Alaska</para></entry>
<entry><para>America/Los_Angeles</para></entry>
<entry><para>Mexico/BajaNorte</para></entry>
</row>
<row>
<entry><para>US/Arizona</para></entry>
<entry><para>US/Mountain</para></entry>
<entry><para>America/Chihuahua</para></entry>
</row>
<row>
<entry><para>America/Chicago</para></entry>
<entry><para>America/Costa_Rica</para></entry>
<entry><para>America/Mexico_City</para></entry>
</row>
<row>
<entry><para>Canada/Saskatchewan</para></entry>
<entry><para>America/Bogota</para></entry>
<entry><para>America/New_York</para></entry>
</row>
<row>
<entry><para>America/Caracas</para></entry>
<entry><para>America/Asuncion</para></entry>
<entry><para>America/Cuiaba</para></entry>
</row>
<row>
<entry><para>America/Halifax</para></entry>
<entry><para>America/Argentina/Buenos_Aires</para></entry>
<entry><para>America/Cayenne</para></entry>
</row>
<row>
<entry><para>America/Godthab</para></entry>
<entry><para>America/Montevideo</para></entry>
<entry><para>Etc/GMT+2</para></entry>
</row>
<row>
<entry><para>Atlantic/Azores</para></entry>
<entry><para>Atlantic/Cape_Verde</para></entry>
<entry><para>Africa/Casablanca</para></entry>
</row>
<row>
<entry><para>Etc/UTC</para></entry>
<entry><para>Atlantic/Reykjavik</para></entry>
<entry><para>Europe/London</para></entry>
</row>
<row>
<entry><para>CET</para></entry>
<entry><para>Europe/Bucharest</para></entry>
<entry><para>Africa/Johannesburg</para></entry>
</row>
<row>
<entry><para>Asia/Beirut</para></entry>
<entry><para>Africa/Cairo</para></entry>
<entry><para>Asia/Karachi</para></entry>
</row>
<row>
<entry><para>Asia/Kolkata</para></entry>
<entry><para>Asia/Bangkok</para></entry>
<entry><para>Asia/Shanghai</para></entry>
</row>
<row>
<entry><para>Asia/Kuala_Lumpur</para></entry>
<entry><para>Australia/Perth</para></entry>
<entry><para>Asia/Taipei</para></entry>
</row>
<row>
<entry><para>Asia/Tokyo</para></entry>
<entry><para>Asia/Seoul</para></entry>
<entry><para>Australia/Adelaide</para></entry>
</row>
<row>
<entry><para>Australia/Darwin</para></entry>
<entry><para>Australia/Brisbane</para></entry>
<entry><para>Australia/Canberra</para></entry>
</row>
<row>
<entry><para>Pacific/Guam</para></entry>
<entry><para>Pacific/Auckland</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

174
docs/en-US/asynchronous-commands-example.xml
View File

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

26
docs/en-US/asynchronous-commands.xml
View File

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

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

@ -23,17 +23,17 @@
-->
<section id="attach-iso-to-vm">
<title>Attaching an ISO to a VM</title>
<orderedlist>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the virtual machine you want to work with.</para></listitem>
<listitem><para>Click the Attach ISO button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/iso-icon.png" />
</imageobject>
<textobject><phrase>iso.png: Depicts adding an iso image</phrase></textobject>
</inlinemediaobject></para></listitem>
<listitem><para>In the Attach ISO dialog box, select the desired ISO.</para></listitem>
<listitem><para>Click OK</para></listitem>
</orderedlist>
<title>Attaching an ISO to a VM</title>
<orderedlist>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the virtual machine you want to work with.</para></listitem>
<listitem><para>Click the Attach ISO button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/iso-icon.png" />
</imageobject>
<textobject><phrase>iso.png: Depicts adding an iso image</phrase></textobject>
</inlinemediaobject></para></listitem>
<listitem><para>In the Attach ISO dialog box, select the desired ISO.</para></listitem>
<listitem><para>Click OK</para></listitem>
</orderedlist>
</section>

36
docs/en-US/attaching-volume.xml
View File

@ -23,21 +23,21 @@
-->
<section id="attaching-volume">
<title>Attaching a Volume</title>
<para>You can attach a volume to a guest VM to provide extra disk storage. Attach a volume when you first create a new volume, when you are moving an existing volume from one VM to another, or after you have migrated a volume from one storage pool to another.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Storage.</para></listitem>
<listitem><para>In Select View, choose Volumes.</para></listitem>
<listitem><para>4. Click the volume name in the Volumes list, then click the Attach Disk button<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/attach-disk-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>In the Instance popup, choose the VM to which you want to attach the volume. You will only see instances to which you are allowed to attach volumes; for example, a user will see only instances created by that user, but the administrator will have more choices.</para>
<para>If the VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para></listitem>
<listitem><para>When the volume has been attached, you should be able to see it by clicking Instances, the instance name, and View Volumes.</para></listitem>
</orderedlist>
</section>
<title>Attaching a Volume</title>
<para>You can attach a volume to a guest VM to provide extra disk storage. Attach a volume when you first create a new volume, when you are moving an existing volume from one VM to another, or after you have migrated a volume from one storage pool to another.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Storage.</para></listitem>
<listitem><para>In Select View, choose Volumes.</para></listitem>
<listitem><para>4. Click the volume name in the Volumes list, then click the Attach Disk button<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/attach-disk-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>In the Instance popup, choose the VM to which you want to attach the volume. You will only see instances to which you are allowed to attach volumes; for example, a user will see only instances created by that user, but the administrator will have more choices.</para>
<para>If the VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para></listitem>
<listitem><para>When the volume has been attached, you should be able to see it by clicking Instances, the instance name, and View Volumes.</para></listitem>
</orderedlist>
</section>

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

@ -23,8 +23,8 @@
-->
<section id="automatic-snapshot-creation-retention">
<title>Automatic Snapshot Creation and Retention</title>
<para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>, <emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold">KVM</emphasis>)</para>
<para>Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30.</para>
<para>With each snapshot schedule, users can also specify the number of scheduled snapshots to be retained. Older snapshots that exceed the retention limit are automatically deleted. This user-defined limit must be equal to or lower than the global limit set by the &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>
<title>Automatic Snapshot Creation and Retention</title>
<para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>, <emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold">KVM</emphasis>)</para>
<para>Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30.</para>
<para>With each snapshot schedule, users can also specify the number of scheduled snapshots to be retained. Older snapshots that exceed the retention limit are automatically deleted. This user-defined limit must be equal to or lower than the global limit set by the &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>

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

@ -23,7 +23,7 @@
-->
<section id="basic-zone-configuration">
<title>Basic Zone Configuration</title>
<title>Basic Zone Configuration</title>
<orderedlist>
<listitem><para>After you select Basic in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next.</para>
<itemizedlist>

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

@ -1,9 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="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>
</section>
</section>

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

@ -1,10 +1,29 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="basic-zone-network-traffic-types">
<title>Basic Zone Network Traffic Types</title>
<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>
<itemizedlist>
<listitem><para>Guest. When end users run VMs, they generate guest traffic. The guest VMs communicate with each other over a network that can be referred to as the guest network. 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>

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

@ -23,7 +23,7 @@
-->
<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>
<title>Basic Zone Physical Network Configuration</title>
<para>In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to CloudPlatform, you set up the guest network through the Add Zone screens.</para>
</section>

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

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

12
docs/en-US/best-practices-primary-storage.xml
View File

@ -23,9 +23,9 @@
-->
<section id="best-practices-primary-storage">
<title>Best Practices for Primary Storage</title>
<itemizedlist>
<listitem><para>The speed of primary storage will impact guest performance. If possible, choose smaller, higher RPM drives for primary storage.</para></listitem>
<listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data</para></listitem>
</itemizedlist>
</section>
<title>Best Practices for Primary Storage</title>
<itemizedlist>
<listitem><para>The speed of primary storage will impact guest performance. If possible, choose smaller, higher RPM drives for primary storage.</para></listitem>
<listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data</para></listitem>
</itemizedlist>
</section>

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

@ -23,10 +23,10 @@
-->
<section id="best-practices-secondary-storage">
<title>Best Practices for Secondary Storage</title>
<itemizedlist>
<listitem><para>Each Zone can have one or more secondary storage servers. Multiple secondary storage servers provide increased scalability to the system.</para></listitem>
<listitem><para>Secondary storage has a high read:write ratio and is expected to consist of larger drives with lower IOPS than primary storage.</para></listitem>
<listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data.</para></listitem>
</itemizedlist>
</section>
<title>Best Practices for Secondary Storage</title>
<itemizedlist>
<listitem><para>Each Zone can have one or more secondary storage servers. Multiple secondary storage servers provide increased scalability to the system.</para></listitem>
<listitem><para>Secondary storage has a high read:write ratio and is expected to consist of larger drives with lower IOPS than primary storage.</para></listitem>
<listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data.</para></listitem>
</itemizedlist>
</section>

4
docs/en-US/best-practices-templates.xml
View File

@ -23,6 +23,6 @@
-->
<section id="best-practices-templates">
<title>Best Practices for Templates</title>
<para>If you plan to use large templates (100 GB or larger), be sure you have a 10-gigabit network to support the large templates. A slower network can lead to timeouts and other errors when large templates are used.</para>
<title>Best Practices for Templates</title>
<para>If you plan to use large templates (100 GB or larger), be sure you have a 10-gigabit network to support the large templates. A slower network can lead to timeouts and other errors when large templates are used.</para>
</section>

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

@ -23,22 +23,22 @@
-->
<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>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>In Network Offering, choose the new network offering, then click Apply.</para></listitem>
<listitem><para>A prompt appears asking whether you want to keep the existing CIDR. This is to let you know that if you change the network offering, the CIDR will be affected. Choose No to proceed with the change.</para></listitem>
<listitem><para>Wait for the update to complete. Don’t try to restart VMs until after the network change is complete.</para></listitem>
<listitem><para>If you stopped any VMs in step 2, restart them.</para></listitem>
</itemizedlist>
<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>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>In Network Offering, choose the new network offering, then click Apply.</para></listitem>
<listitem><para>A prompt appears asking whether you want to keep the existing CIDR. This is to let you know that if you change the network offering, the CIDR will be affected. Choose No to proceed with the change.</para></listitem>
<listitem><para>Wait for the update to complete. Don’t try to restart VMs until after the network change is complete.</para></listitem>
<listitem><para>If you stopped any VMs in step 2, restart them.</para></listitem>
</itemizedlist>
</section>
</section>

116
docs/en-US/change-to-behavior-of-list-commands.xml
View File

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

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

@ -23,7 +23,7 @@
-->
<section id="changing-root-password">
<title>Changing the Root Password</title>
<title>Changing the Root Password</title>
<para>During installation and ongoing cloud administration, you will need to log in to the UI as the root administrator.
The root administrator account manages the &PRODUCT; deployment, including physical infrastructure.
The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person.

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

@ -2,7 +2,7 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@ -23,22 +23,22 @@
-->
<section id="changing-secondary-storage-ip">
<title>Making API Requests</title>
<para>You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server:</para>
<programlisting>
# mysql -p
mysql> use cloud;
mysql> select id from host where type = 'SecondaryStorage';
mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1'
where host_id = HOSTID and name = 'orig.url';
mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
</programlisting>
<note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
<para>Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone.</para>
</section>
<title>Making API Requests</title>
<para>You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server:</para>
<programlisting>
# mysql -p
mysql> use cloud;
mysql> select id from host where type = 'SecondaryStorage';
mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1'
where host_id = HOSTID and name = 'orig.url';
mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
</programlisting>
<note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
<para>Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone.</para>
</section>

20
docs/en-US/changing-secondary-storage-servers.xml
View File

@ -23,14 +23,14 @@
-->
<section id="changing-secondary-storage-serversp">
<title>Changing Secondary Storage Servers</title>
<para>You can change the secondary storage NFS mount. Perform the following steps to do so:</para>
<orderedlist>
<listitem><para>Stop all running Management Servers.</para></listitem>
<listitem><para>Wait 30 minutes. This allows any writes to secondary storage to complete.</para></listitem>
<listitem><para>Copy all files from the old secondary storage mount to the new.</para></listitem>
<listitem><para>Use the procedure above to change the IP address for secondary storage if required.</para></listitem>
<listitem><para>Start the Management Server.</para></listitem>
</orderedlist>
</section>
<title>Changing Secondary Storage Servers</title>
<para>You can change the secondary storage NFS mount. Perform the following steps to do so:</para>
<orderedlist>
<listitem><para>Stop all running Management Servers.</para></listitem>
<listitem><para>Wait 30 minutes. This allows any writes to secondary storage to complete.</para></listitem>
<listitem><para>Copy all files from the old secondary storage mount to the new.</para></listitem>
<listitem><para>Use the procedure above to change the IP address for secondary storage if required.</para></listitem>
<listitem><para>Start the Management Server.</para></listitem>
</orderedlist>
</section>

20
docs/en-US/changing-secondary-storage-serversp.xml
View File

@ -23,14 +23,14 @@
-->
<section id="changing-secondary-storage-serversp">
<title>Changing Secondary Storage Servers</title>
<para>You can change the secondary storage NFS mount. Perform the following steps to do so:</para>
<orderedlist>
<listitem><para>Stop all running Management Servers.</para></listitem>
<listitem><para>Wait 30 minutes. This allows any writes to secondary storage to complete.</para></listitem>
<listitem><para>Copy all files from the old secondary storage mount to the new.</para></listitem>
<listitem><para>Use the procedure above to change the IP address for secondary storage if required.</para></listitem>
<listitem><para>Start the Management Server.</para></listitem>
</orderedlist>
</section>
<title>Changing Secondary Storage Servers</title>
<para>You can change the secondary storage NFS mount. Perform the following steps to do so:</para>
<orderedlist>
<listitem><para>Stop all running Management Servers.</para></listitem>
<listitem><para>Wait 30 minutes. This allows any writes to secondary storage to complete.</para></listitem>
<listitem><para>Copy all files from the old secondary storage mount to the new.</para></listitem>
<listitem><para>Use the procedure above to change the IP address for secondary storage if required.</para></listitem>
<listitem><para>Start the Management Server.</para></listitem>
</orderedlist>
</section>

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

@ -23,27 +23,27 @@
-->
<section id="changing-service-offering-for-vm">
<title>Changing the Service Offering for a VM</title>
<para>To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering.</para>
<orderedlist>
<listitem><para>Log in to the &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>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click the Change Service button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/change-service-icon.png" />
</imageobject>
<textobject><phrase>ChangeServiceButton.png: button to change the service of a VM</phrase></textobject>
</inlinemediaobject>. The Change service dialog box is displayed.</para></listitem>
<listitem><para>Select the offering you want.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>
<title>Changing the Service Offering for a VM</title>
<para>To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering.</para>
<orderedlist>
<listitem><para>Log in to the &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>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click the Change Service button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/change-service-icon.png" />
</imageobject>
<textobject><phrase>ChangeServiceButton.png: button to change the service of a VM</phrase></textobject>
</inlinemediaobject>. The Change service dialog box is displayed.</para></listitem>
<listitem><para>Select the offering you want.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

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

@ -23,32 +23,32 @@
-->
<section id="changing-vm-name-os-group">
<title>Changing the VM Name, OS, or Group</title>
<para>After a VM is created, you can modify the display name, operating system, and the group it belongs to.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<orderedlist>
<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>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click Edit <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to edit the properties of a VM</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>Make the desired changes to the following:</para></listitem>
<listitem><para>Display name: Enter a new display name if you want to change the name of the VM.</para></listitem>
<listitem><para>OS Type: Select the desired operating system.</para></listitem>
<listitem><para>Group: Enter the group name for the VM.</para></listitem>
<listitem><para>Click Apply.</para></listitem>
</orderedlist>
</section>
<title>Changing the VM Name, OS, or Group</title>
<para>After a VM is created, you can modify the display name, operating system, and the group it belongs to.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<orderedlist>
<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>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click Edit <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to edit the properties of a VM</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>Make the desired changes to the following:</para></listitem>
<listitem><para>Display name: Enter a new display name if you want to change the name of the VM.</para></listitem>
<listitem><para>OS Type: Select the desired operating system.</para></listitem>
<listitem><para>Group: Enter the group name for the VM.</para></listitem>
<listitem><para>Click Apply.</para></listitem>
</orderedlist>
</section>

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

@ -23,7 +23,7 @@
-->
<section id="cloud-infrastructure-concepts">
<title>Cloud Infrastructure Concepts</title>
<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" />
<xi:include href="about-clusters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

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

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

4
docs/en-US/cloudstack-admin.xml
View File

@ -23,8 +23,8 @@
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

2
docs/en-US/cloudstack.xml
View File

@ -23,7 +23,7 @@
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

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

@ -23,9 +23,9 @@
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

4
docs/en-US/cloudstack_developers.xml
View File

@ -23,9 +23,9 @@
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

84
docs/en-US/cloudstack_features.xml
View File

@ -22,45 +22,45 @@
under the License.
-->
<section id="cloudstack_features">
<title>What Can &PRODUCT; Do?</title>
<para>
<emphasis role="bold">Multiple Hypervisor Support</emphasis>
</para>
<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. &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.x0.)
</para>
<para>
<emphasis role="bold">Massively Scalable Infrastructure Management</emphasis>
</para>
<para>
&PRODUCT; can manage tens of thousands of servers installed in multiple geographically distributed datacenters. The centralized management server scales linearly, eliminating the need for intermediate cluster-level management servers. No single component failure can cause cloud-wide outage. Periodic maintenance of the management server can be performed without affecting the functioning of virtual machines running in the cloud.
</para>
<para>
<emphasis role="bold">Automatic Configuration Management</emphasis>
</para>
<para>&PRODUCT; automatically configures each guest virtual machine’s networking and storage settings.
</para>
<para>&PRODUCT; internally manages a pool of virtual appliances to support the cloud itself. These appliances offer services such as firewalling, routing, DHCP, VPN access, console proxy, storage access, and storage replication. The extensive use of virtual appliances simplifies the installation, configuration, and ongoing management of a cloud deployment.
</para>
<para>
<emphasis role="bold">Graphical User Interface</emphasis>
</para>
<para>&PRODUCT; offers an administrator's Web interface, used for provisioning and managing the cloud, as well as an end-user's Web interface, used for running VMs and managing VM templates. The UI can be customized to reflect the desired service provider or enterprise look and feel.
</para>
<para>
<emphasis role="bold">API and Extensibility</emphasis>
</para>
<para>
&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; platform pluggable allocation architecture allows the creation of new types of allocators for the selection of storage and Hosts. See the Allocator Implementation Guide (http://docs.cloud.com/CloudStack_Documentation/Allocator_Implementation_Guide).
</para>
<para>
<emphasis role="bold">High Availability</emphasis>
</para>
<para>The &PRODUCT; platform has a number of features to increase the availability of the system. The Management Server itself may be deployed in a multi-node installation where the servers are load balanced. MySQL may be configured to use replication to provide for a manual failover in the event of database loss. For the Hosts, the &PRODUCT; platform supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath.
</para>
</section>
<section id="cloudstack_features">
<title>What Can &PRODUCT; Do?</title>
<para>
<emphasis role="bold">Multiple Hypervisor Support</emphasis>
</para>
<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. &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.x0.)
</para>
<para>
<emphasis role="bold">Massively Scalable Infrastructure Management</emphasis>
</para>
<para>
&PRODUCT; can manage tens of thousands of servers installed in multiple geographically distributed datacenters. The centralized management server scales linearly, eliminating the need for intermediate cluster-level management servers. No single component failure can cause cloud-wide outage. Periodic maintenance of the management server can be performed without affecting the functioning of virtual machines running in the cloud.
</para>
<para>
<emphasis role="bold">Automatic Configuration Management</emphasis>
</para>
<para>&PRODUCT; automatically configures each guest virtual machine’s networking and storage settings.
</para>
<para>&PRODUCT; internally manages a pool of virtual appliances to support the cloud itself. These appliances offer services such as firewalling, routing, DHCP, VPN access, console proxy, storage access, and storage replication. The extensive use of virtual appliances simplifies the installation, configuration, and ongoing management of a cloud deployment.
</para>
<para>
<emphasis role="bold">Graphical User Interface</emphasis>
</para>
<para>&PRODUCT; offers an administrator's Web interface, used for provisioning and managing the cloud, as well as an end-user's Web interface, used for running VMs and managing VM templates. The UI can be customized to reflect the desired service provider or enterprise look and feel.
</para>
<para>
<emphasis role="bold">API and Extensibility</emphasis>
</para>
<para>
&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; platform pluggable allocation architecture allows the creation of new types of allocators for the selection of storage and Hosts. See the Allocator Implementation Guide (http://docs.cloud.com/CloudStack_Documentation/Allocator_Implementation_Guide).
</para>
<para>
<emphasis role="bold">High Availability</emphasis>
</para>
<para>The &PRODUCT; platform has a number of features to increase the availability of the system. The Management Server itself may be deployed in a multi-node installation where the servers are load balanced. MySQL may be configured to use replication to provide for a manual failover in the event of database loss. For the Hosts, the &PRODUCT; platform supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath.
</para>
</section>

4
docs/en-US/cloudstack_installation.xml
View File

@ -23,8 +23,8 @@
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

88
docs/en-US/cloudstack_system_requirements.xml
View File

@ -22,47 +22,47 @@
under the License.
-->
<section id="cloudstack_system_requirements">
<title>Minimum System Requirements</title>
<para>
The machines that will run the Management Server and MySQL database must meet the following requirements. The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS. The Management Server may be placed on a virtual machine.
</para>
<itemizedlist>
<listitem><para>Operating system:</para>
<itemizedlist>
<listitem><para>Commercial users: Preferred: RHEL 6.2+ 64-bit (https://access.redhat.com/downloads) or CentOS 6.2+ 64-bit (http://isoredirect.centos.org/centos/6/isos/x86_64/). Also supported (v3.0.3 and greater): RHEL and CentOS 5.4-5.x 64-bit</para></listitem>
<listitem><para>Open-source community users: RHEL 5.4-5.x 64-bit or 6.2+ 64-bit; CentOS 5.4-5.x 64-bit or 6.2+ 64-bit; Ubuntu 10.04 LTS</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem>
<listitem><para>4 GB of memory</para></listitem>
<listitem><para>250 GB of local disk (more results in better capability; 500 GB recommended)</para></listitem>
<listitem><para>At least 1 NIC</para></listitem>
<listitem><para>Statically allocated IP address</para></listitem>
<listitem><para>Fully qualified domain name as returned by the hostname command</para></listitem>
</itemizedlist>
<para>The host is where the cloud services run in the form of guest virtual machines. Each host is one machine that meets the following requirements:</para>
<itemizedlist>
<listitem><para>Must be 64-bit and must support HVM (Intel-VT or AMD-V enabled).</para></listitem>
<listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem>
<listitem><para>Hardware virtualization support required</para></listitem>
<listitem><para>4 GB of memory</para></listitem>
<listitem><para>36 GB of local disk</para></listitem>
<listitem><para>At least 1 NIC</para></listitem>
<listitem><para>Statically allocated IP Address</para></listitem>
<listitem><para>Latest hotfixes applied to hypervisor software</para></listitem>
<listitem><para>When you deploy &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 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>
<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 &PRODUCT;. For example, the requirements for XenServer are listed under Citrix XenServer Installation for &PRODUCT;.
</para>
</warning>
</section>
<section id="cloudstack_system_requirements">
<title>Minimum System Requirements</title>
<para>
The machines that will run the Management Server and MySQL database must meet the following requirements. The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS. The Management Server may be placed on a virtual machine.
</para>
<itemizedlist>
<listitem><para>Operating system:</para>
<itemizedlist>
<listitem><para>Commercial users: Preferred: RHEL 6.2+ 64-bit (https://access.redhat.com/downloads) or CentOS 6.2+ 64-bit (http://isoredirect.centos.org/centos/6/isos/x86_64/). Also supported (v3.0.3 and greater): RHEL and CentOS 5.4-5.x 64-bit</para></listitem>
<listitem><para>Open-source community users: RHEL 5.4-5.x 64-bit or 6.2+ 64-bit; CentOS 5.4-5.x 64-bit or 6.2+ 64-bit; Ubuntu 10.04 LTS</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem>
<listitem><para>4 GB of memory</para></listitem>
<listitem><para>250 GB of local disk (more results in better capability; 500 GB recommended)</para></listitem>
<listitem><para>At least 1 NIC</para></listitem>
<listitem><para>Statically allocated IP address</para></listitem>
<listitem><para>Fully qualified domain name as returned by the hostname command</para></listitem>
</itemizedlist>
<para>The host is where the cloud services run in the form of guest virtual machines. Each host is one machine that meets the following requirements:</para>
<itemizedlist>
<listitem><para>Must be 64-bit and must support HVM (Intel-VT or AMD-V enabled).</para></listitem>
<listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem>
<listitem><para>Hardware virtualization support required</para></listitem>
<listitem><para>4 GB of memory</para></listitem>
<listitem><para>36 GB of local disk</para></listitem>
<listitem><para>At least 1 NIC</para></listitem>
<listitem><para>Statically allocated IP Address</para></listitem>
<listitem><para>Latest hotfixes applied to hypervisor software</para></listitem>
<listitem><para>When you deploy &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 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>
<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 &PRODUCT;. For example, the requirements for XenServer are listed under Citrix XenServer Installation for &PRODUCT;.
</para>
</warning>
</section>

4
docs/en-US/cloudstack_trial_installation.xml
View File

@ -23,8 +23,8 @@
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="trial-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

28
docs/en-US/cloudstack_whatis.xml
View File

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

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

@ -23,6 +23,6 @@
-->
<section id="cluster-add">
<title>Adding a Cluster</title>
<para>TODO</para>
<title>Adding a Cluster</title>
<para>TODO</para>
</section>

180
docs/en-US/compatibility-matrix.xml
View File

@ -23,94 +23,94 @@
-->
<section id="compatibility-matrix">
<title>Compatibility Matrix</title>
<informaltable>
<tgroup cols="7" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>Hypervisor</para></entry>
<entry><para>CloudStack 2.1.x</para></entry>
<entry><para>CloudStack 2.2.x</para></entry>
<entry><para>CloudStack 3.0.0</para></entry>
<entry><para>CloudStack 3.0.1</para></entry>
<entry><para>CloudStack 3.0.2</para></entry>
<entry><para>CloudStack 3.0.3</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>XenServer 5.6</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>XenServer 5.6 FP1</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>XenServer 5.6 SP2</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.0.0</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.0.2</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.1</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>KVM (RHEL 6.0 or 6.1)</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>VMware (vSphere and vCenter, both version 4.1)</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<title>Compatibility Matrix</title>
<informaltable>
<tgroup cols="7" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>Hypervisor</para></entry>
<entry><para>CloudStack 2.1.x</para></entry>
<entry><para>CloudStack 2.2.x</para></entry>
<entry><para>CloudStack 3.0.0</para></entry>
<entry><para>CloudStack 3.0.1</para></entry>
<entry><para>CloudStack 3.0.2</para></entry>
<entry><para>CloudStack 3.0.3</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>XenServer 5.6</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>XenServer 5.6 FP1</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>XenServer 5.6 SP2</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.0.0</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.0.2</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>XenServer 6.1</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
<entry><para>No</para></entry>
</row>
<row>
<entry><para>KVM (RHEL 6.0 or 6.1)</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
<row>
<entry><para>VMware (vSphere and vCenter, both version 4.1)</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
<entry><para>Yes</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

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

@ -23,8 +23,8 @@
-->
<chapter id="concepts">
<title>Concepts</title>
<xi:include href="whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="feature-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="deployment-architecture-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Concepts</title>
<xi:include href="whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="feature-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="deployment-architecture-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

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

@ -23,28 +23,28 @@
-->
<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>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>
</itemizedlist>
</listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>
<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>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>
</itemizedlist>
</listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

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

@ -3,6 +3,25 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="configure-public-traffic-in-an-advanced-zone">
<title>Configure Public Traffic in an Advanced Zone</title>
<para>In a zone that uses advanced networking, you need to configure at least one range of IP addresses for Internet traffic.</para>

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

@ -54,7 +54,7 @@
<row>
<entry><para>usage.aggregation.timezone</para></entry>
<entry><para>Time zone of usage records. Set this if the usage records and daily job execution are in different time zones. For example, with the following settings, the usage job will run at PST 00:15 and generate usage records for the 24 hours from 00:00:00 GMT to 23:59:59 GMT:</para>
<programlisting>usage.stats.job.exec.time = 00:15
<programlisting>usage.stats.job.exec.time = 00:15
usage.execution.timezone = PST
usage.aggregation.timezone = GMT
</programlisting>

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

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

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

@ -23,46 +23,46 @@
-->
<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>
<para>For Linux VMs, you may need to do some preparation in Hyper-V before trying to get the VM to work in XenServer. Clone the VM and work on the clone if you still want to use the VM in Hyper-V. Uninstall Hyper-V Integration Components and check for any references to device names in /etc/fstab:</para>
<orderedlist>
<listitem><para>From the linux_ic/drivers/dist directory, run make uninstall (where "linux_ic" is the path to the copied Hyper-V Integration Components files).</para></listitem>
<listitem><para>Restore the original initrd from backup in /boot/ (the backup is named *.backup0).</para></listitem>
<listitem><para>Remove the "hdX=noprobe" entries from /boot/grub/menu.lst.</para></listitem>
<listitem><para>Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to mount by LABEL or UUID (get that information with the "blkid" command)..</para></listitem>
</orderedlist>
<para>The next step is make sure the VM is not running in Hyper-V, then get the VHD into XenServer. There are two options for doing this.</para>
<para>Option one:</para>
<orderedlist>
<listitem><para>Import the VHD using XenCenter. In XenCenter, go to Tools&gt;Virtual Appliance Tools&gt;Disk Image Import.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Name the VM, choose the NFS VHD SR under Storage, enable "Run Operating System Fixups" and choose the NFS ISO SR.</para></listitem>
<listitem><para>Click Next, then Finish. A VM should be created.</para></listitem>
</orderedlist>
<para>Option two</para>
<orderedlist>
<listitem><para>Run XenConvert, under From choose VHD, under To choose XenServer. Click Next.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Input the XenServer host info, then click Next.</para></listitem>
<listitem><para>Name the VM, then click Next, then Convert. A VM should be created</para></listitem>
</orderedlist>
<para>Once you have a VM created from the Hyper-V VHD, prepare it using the following steps:</para>
<orderedlist>
<listitem><para>Boot the VM, uninstall Hyper-V Integration Services, and reboot.</para></listitem>
<listitem><para>Install XenServer Tools, then reboot.</para></listitem>
<listitem><para>Prepare the VM as desired. For example, run sysprep on Windows VMs. See <xref linkend="create-windows-template"/></para></listitem>
</orderedlist>
<para>Either option above will create a VM in HVM mode. This is fine for Windows VMs, but Linux VMs may not perform optimally. Converting a Linux VM to PV mode will require additional steps and will vary by distribution.</para>
<orderedlist>
<listitem><para>Shut down the VM and copy the VHD from the NFS storage to a web server; for example, mount the NFS share on the web server and copy it, or from the XenServer host use sftp or scp to upload it to the web server.</para></listitem>
<listitem><para>In &PRODUCT;, create a new template using the following values:</para>
<itemizedlist>
<listitem><para>URL. Give the URL for the VHD</para></listitem>
<listitem><para>OS Type. Use the appropriate OS. For PV mode on CentOS, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServer.</para></listitem>
<listitem><para>Hypervisor. XenServer</para></listitem>
<listitem><para>Format. VHD</para></listitem>
</itemizedlist></listitem>
</orderedlist>
<para>The template will be created, and you can create instances from it.</para>
<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>
<para>For Linux VMs, you may need to do some preparation in Hyper-V before trying to get the VM to work in XenServer. Clone the VM and work on the clone if you still want to use the VM in Hyper-V. Uninstall Hyper-V Integration Components and check for any references to device names in /etc/fstab:</para>
<orderedlist>
<listitem><para>From the linux_ic/drivers/dist directory, run make uninstall (where "linux_ic" is the path to the copied Hyper-V Integration Components files).</para></listitem>
<listitem><para>Restore the original initrd from backup in /boot/ (the backup is named *.backup0).</para></listitem>
<listitem><para>Remove the "hdX=noprobe" entries from /boot/grub/menu.lst.</para></listitem>
<listitem><para>Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to mount by LABEL or UUID (get that information with the "blkid" command)..</para></listitem>
</orderedlist>
<para>The next step is make sure the VM is not running in Hyper-V, then get the VHD into XenServer. There are two options for doing this.</para>
<para>Option one:</para>
<orderedlist>
<listitem><para>Import the VHD using XenCenter. In XenCenter, go to Tools&gt;Virtual Appliance Tools&gt;Disk Image Import.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Name the VM, choose the NFS VHD SR under Storage, enable "Run Operating System Fixups" and choose the NFS ISO SR.</para></listitem>
<listitem><para>Click Next, then Finish. A VM should be created.</para></listitem>
</orderedlist>
<para>Option two</para>
<orderedlist>
<listitem><para>Run XenConvert, under From choose VHD, under To choose XenServer. Click Next.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Input the XenServer host info, then click Next.</para></listitem>
<listitem><para>Name the VM, then click Next, then Convert. A VM should be created</para></listitem>
</orderedlist>
<para>Once you have a VM created from the Hyper-V VHD, prepare it using the following steps:</para>
<orderedlist>
<listitem><para>Boot the VM, uninstall Hyper-V Integration Services, and reboot.</para></listitem>
<listitem><para>Install XenServer Tools, then reboot.</para></listitem>
<listitem><para>Prepare the VM as desired. For example, run sysprep on Windows VMs. See <xref linkend="create-windows-template"/></para></listitem>
</orderedlist>
<para>Either option above will create a VM in HVM mode. This is fine for Windows VMs, but Linux VMs may not perform optimally. Converting a Linux VM to PV mode will require additional steps and will vary by distribution.</para>
<orderedlist>
<listitem><para>Shut down the VM and copy the VHD from the NFS storage to a web server; for example, mount the NFS share on the web server and copy it, or from the XenServer host use sftp or scp to upload it to the web server.</para></listitem>
<listitem><para>In &PRODUCT;, create a new template using the following values:</para>
<itemizedlist>
<listitem><para>URL. Give the URL for the VHD</para></listitem>
<listitem><para>OS Type. Use the appropriate OS. For PV mode on CentOS, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServer.</para></listitem>
<listitem><para>Hypervisor. XenServer</para></listitem>
<listitem><para>Format. VHD</para></listitem>
</itemizedlist></listitem>
</orderedlist>
<para>The template will be created, and you can create instances from it.</para>
</section>

42
docs/en-US/create-bare-metal-template.xml
View File

@ -23,24 +23,24 @@
-->
<section id="create-bare-metal-template">
<title>Creating a Bare Metal Template</title>
<note><para><emphasis role="bold">Beta feature. Untested in &PRODUCT; 3.0.3. Provided without guarantee of performance</emphasis>.</para></note>
<para>Before you can create a bare metal template, you must have performed several other installation and setup steps to create a bare metal cluster and environment. See Bare Metal Installation in the Installation Guide. It is assumed you already have a directory named "win7_64bit" on your CIFS server, containing the image for the bare metal instance. This directory and image are set up as part of the Bare Metal Installation procedure.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>Click Create Template.</para></listitem>
<listitem><para>In the dialog box, enter the following values.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name</emphasis>. Short name for the template.</para></listitem>
<listitem><para><emphasis role="bold">Display Text</emphasis>. Description of the template.</para></listitem>
<listitem><para><emphasis role="bold">URL</emphasis>. The directory name which contains image file on your CIFS server. For example, win7_64bit.</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>. All Zones.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. Select the OS type of the ISO image. Choose other if the OS Type of the ISO is not listed or if the ISO is not bootable.</para></listitem>
<listitem><para><emphasis role="bold">Hypervisor</emphasis>. BareMetal.</para></listitem>
<listitem><para><emphasis role="bold">Format</emphasis>. BareMetal.</para></listitem>
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. No.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. No.</para></listitem>
<listitem><para><emphasis role="bold">Featured</emphasis>. Choose Yes if you would like this template to be more prominent for users to select. Only administrators may make templates featured.</para></listitem>
</itemizedlist></listitem></orderedlist>
</section>
<title>Creating a Bare Metal Template</title>
<note><para><emphasis role="bold">Beta feature. Untested in &PRODUCT; 3.0.3. Provided without guarantee of performance</emphasis>.</para></note>
<para>Before you can create a bare metal template, you must have performed several other installation and setup steps to create a bare metal cluster and environment. See Bare Metal Installation in the Installation Guide. It is assumed you already have a directory named "win7_64bit" on your CIFS server, containing the image for the bare metal instance. This directory and image are set up as part of the Bare Metal Installation procedure.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>Click Create Template.</para></listitem>
<listitem><para>In the dialog box, enter the following values.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name</emphasis>. Short name for the template.</para></listitem>
<listitem><para><emphasis role="bold">Display Text</emphasis>. Description of the template.</para></listitem>
<listitem><para><emphasis role="bold">URL</emphasis>. The directory name which contains image file on your CIFS server. For example, win7_64bit.</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>. All Zones.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. Select the OS type of the ISO image. Choose other if the OS Type of the ISO is not listed or if the ISO is not bootable.</para></listitem>
<listitem><para><emphasis role="bold">Hypervisor</emphasis>. BareMetal.</para></listitem>
<listitem><para><emphasis role="bold">Format</emphasis>. BareMetal.</para></listitem>
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. No.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. No.</para></listitem>
<listitem><para><emphasis role="bold">Featured</emphasis>. Choose Yes if you would like this template to be more prominent for users to select. Only administrators may make templates featured.</para></listitem>
</itemizedlist></listitem></orderedlist>
</section>

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

@ -23,27 +23,27 @@
-->
<section id="create-template-from-existing-vm">
<title>Creating a Template from an Existing Virtual Machine</title>
<para>Once you have at least one VM set up in the way you want, you can use it as the prototype for other VMs.</para>
<orderedlist>
<listitem><para>Create and start a virtual machine using any of the techniques given in <xref linkend="creating-vms"/>.</para></listitem>
<listitem><para>Make any desired configuration changes on the running VM, then click Stop.</para></listitem>
<listitem><para>Wait for the VM to stop. When the status shows Stopped, go to the next step.</para></listitem>
<listitem><para>Click Create Template and provide the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so choose something descriptive.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. This helps &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>
<listitem><para>If you want to boot from this template in PV mode, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere:</para>
<note><para>Note: Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all users of this &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>
</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>
<title>Creating a Template from an Existing Virtual Machine</title>
<para>Once you have at least one VM set up in the way you want, you can use it as the prototype for other VMs.</para>
<orderedlist>
<listitem><para>Create and start a virtual machine using any of the techniques given in <xref linkend="creating-vms"/>.</para></listitem>
<listitem><para>Make any desired configuration changes on the running VM, then click Stop.</para></listitem>
<listitem><para>Wait for the VM to stop. When the status shows Stopped, go to the next step.</para></listitem>
<listitem><para>Click Create Template and provide the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so choose something descriptive.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. This helps &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>
<listitem><para>If you want to boot from this template in PV mode, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere:</para>
<note><para>Note: Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all users of this &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>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
<para>The new template will be visible in the Templates section when the template creation process has been completed. The template is then available when creating a new VM</para>
</section>

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

@ -23,13 +23,13 @@
-->
<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>
<orderedlist>
<listitem><para>Launch a VM instance that has the operating system you want. Make any other desired configuration changes to the VM.</para></listitem>
<listitem><para>Stop the VM.</para></listitem>
<listitem><para>Convert the volume into a template.</para></listitem>
</orderedlist>
<para>There are other ways to add templates to &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>
<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>
<orderedlist>
<listitem><para>Launch a VM instance that has the operating system you want. Make any other desired configuration changes to the VM.</para></listitem>
<listitem><para>Stop the VM.</para></listitem>
<listitem><para>Convert the volume into a template.</para></listitem>
</orderedlist>
<para>There are other ways to add templates to &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>

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

@ -23,16 +23,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>
<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>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" />
<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>
<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>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>

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

@ -23,19 +23,19 @@
-->
<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>
<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>
<listitem><para>In Select View, choose Volumes.</para></listitem>
<listitem><para>To create a new volume, click Add Volume, provide the following details, and click OK.</para>
<itemizedlist>
<listitem><para>Name. Give the volume a unique name so you can find it later.</para></listitem>
<listitem><para>Availability Zone. Where do you want the storage to reside? This should be close to the VM that will use the volume.</para></listitem>
<listitem><para>Disk Offering. Choose the characteristics of the storage.</para></listitem>
</itemizedlist>
<para>The new volume appears in the list of volumes with the state “Allocated.” The volume data is stored in &PRODUCT;, but the volume is not yet ready for use</para></listitem>
<listitem><para>To start using the volume, continue to Attaching a Volume </para></listitem>
</orderedlist>
</section>
<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>
<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>
<listitem><para>In Select View, choose Volumes.</para></listitem>
<listitem><para>To create a new volume, click Add Volume, provide the following details, and click OK.</para>
<itemizedlist>
<listitem><para>Name. Give the volume a unique name so you can find it later.</para></listitem>
<listitem><para>Availability Zone. Where do you want the storage to reside? This should be close to the VM that will use the volume.</para></listitem>
<listitem><para>Disk Offering. Choose the characteristics of the storage.</para></listitem>
</itemizedlist>
<para>The new volume appears in the list of volumes with the state “Allocated.” The volume data is stored in &PRODUCT;, but the volume is not yet ready for use</para></listitem>
<listitem><para>To start using the volume, continue to Attaching a Volume </para></listitem>
</orderedlist>
</section>

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

@ -23,27 +23,27 @@
-->
<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>
<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>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>
</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 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>
<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>
<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>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>
</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 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>

14
docs/en-US/dates-in-usage-record.xml
View File

@ -16,11 +16,11 @@
under the License.
-->
<section id="dates-in-usage-record">
<title>Dates in the Usage Record</title>
<para>Usage records include a start date and an end date. These dates define the period of time for which the raw usage number was calculated. If daily aggregation is used, the start date is midnight on the day in question and the end date is 23:59:59 on the day in question (with one exception; see below). A virtual machine could have been deployed at noon on that day, stopped at 6pm on that day, then started up again at 11pm. When usage is calculated on that day, there will be 7 hours of running VM usage (usage type 1) and 12 hours of allocated VM usage (usage type 2). If the same virtual machine runs for the entire next day, there will 24 hours of both running VM usage (type 1) and allocated VM usage (type 2).</para>
<para>Note: The start date is not the time a virtual machine was started, and the end date is not the time when a virtual machine was stopped. The start and end dates give the time range within which usage was calculated.</para>
<para>For network usage, the start date and end date again define the range in which the number of bytes transferred was calculated. If a user downloads 10 MB and uploads 1 MB in one day, there will be two records, one showing the 10 megabytes received and one showing the 1 megabyte sent.</para>
<para>There is one case where the start date and end date do not correspond to midnight and 11:59:59pm when daily aggregation is used. This occurs only for network usage records. When the usage server has more than one day's worth of unprocessed data, the old data will be included in the aggregation period. The start date in the usage record will show the date and time of the earliest event. For other types of usage, such as IP addresses and VMs, the old unprocessed data is not included in daily aggregation.</para>
</section>
<section id="dates-in-usage-record">
<title>Dates in the Usage Record</title>
<para>Usage records include a start date and an end date. These dates define the period of time for which the raw usage number was calculated. If daily aggregation is used, the start date is midnight on the day in question and the end date is 23:59:59 on the day in question (with one exception; see below). A virtual machine could have been deployed at noon on that day, stopped at 6pm on that day, then started up again at 11pm. When usage is calculated on that day, there will be 7 hours of running VM usage (usage type 1) and 12 hours of allocated VM usage (usage type 2). If the same virtual machine runs for the entire next day, there will 24 hours of both running VM usage (type 1) and allocated VM usage (type 2).</para>
<para>Note: The start date is not the time a virtual machine was started, and the end date is not the time when a virtual machine was stopped. The start and end dates give the time range within which usage was calculated.</para>
<para>For network usage, the start date and end date again define the range in which the number of bytes transferred was calculated. If a user downloads 10 MB and uploads 1 MB in one day, there will be two records, one showing the 10 megabytes received and one showing the 1 megabyte sent.</para>
<para>There is one case where the start date and end date do not correspond to midnight and 11:59:59pm when daily aggregation is used. This occurs only for network usage records. When the usage server has more than one day's worth of unprocessed data, the old data will be included in the aggregation period. The start date in the usage record will show the date and time of the earliest event. For other types of usage, such as IP addresses and VMs, the old unprocessed data is not included in daily aggregation.</para>
</section>

12
docs/en-US/default-template.xml
View File

@ -23,12 +23,12 @@
-->
<section id="default-template">
<title>The Default Template</title>
<para>&PRODUCT; includes a CentOS template. This template is downloaded by the Secondary Storage VM after the primary and secondary storage are configured. You can use this template in your production deployment or you can delete it and use custom templates.</para>
<para>The root password for the default template is "password".</para>
<para>A default template is provided for each of XenServer, KVM, and vSphere. The templates that are downloaded depend on the hypervisor type that is available in your cloud. Each template is approximately 2.5 GB physical size.</para>
<para>The default template includes the standard iptables rules, which will block most access to the template excluding ssh.</para>
<programlisting># iptables --list
<title>The Default Template</title>
<para>&PRODUCT; includes a CentOS template. This template is downloaded by the Secondary Storage VM after the primary and secondary storage are configured. You can use this template in your production deployment or you can delete it and use custom templates.</para>
<para>The root password for the default template is "password".</para>
<para>A default template is provided for each of XenServer, KVM, and vSphere. The templates that are downloaded depend on the hypervisor type that is available in your cloud. Each template is approximately 2.5 GB physical size.</para>
<para>The default template includes the standard iptables rules, which will block most access to the template excluding ssh.</para>
<programlisting># iptables --list
Chain INPUT (policy ACCEPT)
target prot opt source destination
RH-Firewall-1-INPUT all -- anywhere anywhere

6
docs/en-US/delete-templates.xml
View File

@ -23,7 +23,7 @@
-->
<section id="delete-templates">
<title>Deleting Templates</title>
<para>Templates may be deleted. In general, when a template spans multiple Zones, only the copy that is selected for deletion will be deleted; the same template in other Zones will not be deleted. The provided CentOS template is an exception to this. If the provided CentOS template is deleted, it will be deleted from all Zones.</para>
<para>When templates are deleted, the VMs instantiated from them will continue to run. However, new VMs cannot be created based on the deleted template.</para>
<title>Deleting Templates</title>
<para>Templates may be deleted. In general, when a template spans multiple Zones, only the copy that is selected for deletion will be deleted; the same template in other Zones will not be deleted. The provided CentOS template is an exception to this. If the provided CentOS template is deleted, it will be deleted from all Zones.</para>
<para>When templates are deleted, the VMs instantiated from them will continue to run. However, new VMs cannot be created based on the deleted template.</para>
</section>

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

@ -23,19 +23,19 @@
-->
<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>
<para>To delete a virtual machine:</para>
<orderedlist>
<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>
<imageobject>
<imagedata fileref="./images/destroy-instance.png" />
</imageobject>
<textobject><phrase>Destroyinstance.png: button to destroy an instance</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</orderedlist>
</section>
<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>
<para>To delete a virtual machine:</para>
<orderedlist>
<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>
<imageobject>
<imagedata fileref="./images/destroy-instance.png" />
</imageobject>
<textobject><phrase>Destroyinstance.png: button to destroy an instance</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</orderedlist>
</section>

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

@ -23,22 +23,22 @@
-->
<section id="deployment-architecture-overview">
<title>Deployment Architecture Overview</title>
<para>
A &PRODUCT; installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a &PRODUCT; cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources.
</para>
<para>
The minimum production installation consists of one machine running the &PRODUCT; Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software). In a trial installation, a single machine can act as both the Management Server and the hypervisor host (using the KVM hypervisor).
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/basic-deployment.png" />
</imageobject>
<textobject><phrase>basic-deployment.png: Basic two-machine deployment</phrase></textobject>
</mediaobject>
<para>A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture.
</para>
<xi:include href="management-server-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="networking-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Deployment Architecture Overview</title>
<para>
A &PRODUCT; installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a &PRODUCT; cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources.
</para>
<para>
The minimum production installation consists of one machine running the &PRODUCT; Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software). In a trial installation, a single machine can act as both the Management Server and the hypervisor host (using the KVM hypervisor).
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/basic-deployment.png" />
</imageobject>
<textobject><phrase>basic-deployment.png: Basic two-machine deployment</phrase></textobject>
</mediaobject>
<para>A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture.
</para>
<xi:include href="management-server-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="networking-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -23,21 +23,21 @@
-->
<section id="detach-move-volumes">
<title>Attaching a Volume</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>
<para>If the destination VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para>
<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>
<imageobject>
<imagedata fileref="./images/detach-disk-icon.png" />
</imageobject>
<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>
</orderedlist>
</section>
<title>Attaching a Volume</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>
<para>If the destination VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para>
<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>
<imageobject>
<imagedata fileref="./images/detach-disk-icon.png" />
</imageobject>
<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>
</orderedlist>
</section>

24
docs/en-US/developer-getting-started.xml
View File

@ -23,16 +23,16 @@
under the License.
-->
<section id="getting-started">
<title>Getting Started</title>
<para>
To get started using the &PRODUCT; API, you should have the following:</para>
<itemizedlist>
<listitem><para>URL of the &PRODUCT; server you wish to integrate with.</para></listitem>
<listitem><para>Both the API Key and Secret Key for an account. This should have been generated by the administrator of the cloud instance and given to you.</para></listitem>
<listitem><para>Familiarity with HTTP GET/POST and query strings.</para></listitem>
<listitem><para>Knowledge of either XML or JSON.</para></listitem>
<listitem><para>Knowledge of a programming language that can generate HTTP requests; for example, Java or PHP.</para></listitem>
</itemizedlist>
</section>
<section id="getting-started">
<title>Getting Started</title>
<para>
To get started using the &PRODUCT; API, you should have the following:</para>
<itemizedlist>
<listitem><para>URL of the &PRODUCT; server you wish to integrate with.</para></listitem>
<listitem><para>Both the API Key and Secret Key for an account. This should have been generated by the administrator of the cloud instance and given to you.</para></listitem>
<listitem><para>Familiarity with HTTP GET/POST and query strings.</para></listitem>
<listitem><para>Knowledge of either XML or JSON.</para></listitem>
<listitem><para>Knowledge of a programming language that can generate HTTP requests; for example, Java or PHP.</para></listitem>
</itemizedlist>
</section>

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

@ -23,8 +23,8 @@
-->
<chapter id="developer-guide">
<title>Using the API</title>
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Using the API</title>
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="making-api-request.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="enabling-api-call-expiration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

6
docs/en-US/developer-introduction.xml
View File

@ -23,8 +23,8 @@
-->
<section id="developer-introduction">
<title>Introduction for Developers</title>
<xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Introduction for Developers</title>
<xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="api-reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

4
docs/en-US/developer_guide.xml
View File

@ -23,8 +23,8 @@
-->
<chapter id="developer_guide">
<title>Developer Guide</title>
<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Developer Guide</title>
<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="making-api-request.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="enabling-api-call-expiration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

38
docs/en-US/disk-volume-usage-record-format.xml
View File

@ -17,22 +17,22 @@
-->
<section id="disk-volume-usage-record-format">
<title>Disk Volume Usage Record Format</title>
<para>For disk volumes, the following fields exist in a usage record.</para>
<itemizedlist>
<listitem><para>account – name of the account</para></listitem>
<listitem><para>accountid – ID of the account</para></listitem>
<listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
<listitem><para>zoneid – Zone where the usage occurred</para></listitem>
<listitem><para>description – A string describing what the usage record is tracking</para></listitem>
<listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
<listitem><para>usageid – The volume ID</para></listitem>
<listitem><para>offeringid – The ID of the disk offering</para></listitem>
<listitem><para>type – Hypervisor</para></listitem>
<listitem><para>templateid – ROOT template ID</para></listitem>
<listitem><para>size – The amount of storage allocated</para></listitem>
<listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
</itemizedlist>
</section>
<title>Disk Volume Usage Record Format</title>
<para>For disk volumes, the following fields exist in a usage record.</para>
<itemizedlist>
<listitem><para>account – name of the account</para></listitem>
<listitem><para>accountid – ID of the account</para></listitem>
<listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
<listitem><para>zoneid – Zone where the usage occurred</para></listitem>
<listitem><para>description – A string describing what the usage record is tracking</para></listitem>
<listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
<listitem><para>usageid – The volume ID</para></listitem>
<listitem><para>offeringid – The ID of the disk offering</para></listitem>
<listitem><para>type – Hypervisor</para></listitem>
<listitem><para>templateid – ROOT template ID</para></listitem>
<listitem><para>size – The amount of storage allocated</para></listitem>
<listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
</itemizedlist>
</section>

4
docs/en-US/dns-dhcp.xml
View File

@ -23,6 +23,6 @@
-->
<section id="dns-dhcp">
<title>DNS and DHCP</title>
<para>The Virtual Router provides DNS and DHCP services to the guests. It proxies DNS requests to the DNS server configured on the Availability Zone.</para>
<title>DNS and DHCP</title>
<para>The Virtual Router provides DNS and DHCP services to the guests. It proxies DNS requests to the DNS server configured on the Availability Zone.</para>
</section>

6
docs/en-US/domains.xml
View File

@ -23,6 +23,6 @@
-->
<section id="domains">
<title>Domains</title>
<para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
</section>
<title>Domains</title>
<para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
</section>

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

@ -23,22 +23,22 @@
-->
<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>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>
<imageobject>
<imagedata fileref="./images/release-ip-icon.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>
</orderedlist>
<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>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>
<imageobject>
<imagedata fileref="./images/release-ip-icon.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>
</orderedlist>
</section>

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

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

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