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

Fix the docs builds for Admin, Developer's, and Installation guides. Remove unneeded files. Add new files. Reorganize chapter structure. Can also build all together with publican-all.cfg.

Browse Source
This commit is contained in:
Jessica Tomechak 2012-10-09 00:08:52 -07:00
parent b0c7e385d7
commit 1b0e40c3c8
41 changed files with 626 additions and 607 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -45,7 +45,13 @@
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<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="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="api-calls.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

27
docs/en-US/Admin_Guide.xml
View File

@ -24,7 +24,7 @@
<book>
<bookinfo id="cloudstack_admin">
<title>&PRODUCT; Admin Guide</title>
<title>&PRODUCT; Administrator's Guide</title>
<productname>Apache CloudStack</productname>
<productnumber>4.0</productnumber>
<edition>1</edition>
@ -45,7 +45,30 @@
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<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="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="virtual-machines.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="work-with-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-system-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sys-reliability-and-ha.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="manage-cloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="api-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

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

@ -49,6 +49,7 @@
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="hypervisor-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="choosing-a-deployment-architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History_Install_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

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

@ -24,8 +24,8 @@
<section id="about-virtual-networks">
<title>About Virtual Networks</title>
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT;, a virtual network can be shared or isolated.</para>
<para><xref linkend="isolated-networks" />XenServer and Maintenance Mode</para>
<para><xref linkend="shared-networks" />Working with Usage</para>
<para><xref linkend="runtime-allocation-virtual-network-resources" />XenServer and Maintenance Mode</para>
</section>
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT; a virtual network can be shared or isolated.</para>
<xi:include href="isolated-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="shared-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="runtime-allocation-virtual-network-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -22,9 +22,8 @@
under the License.
-->
<section id="accounts">
<chapter id="accounts">
<title>Accounts</title>
<xi:include href="accounts-users-domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="LDAPserver-for-user-authentication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>

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

@ -20,7 +20,8 @@
-->
<section id="added-API-commands">
<title>Added API commands</title>
<para>Added in 4.0</para>
<section id="added-API-commands-4.0">
<title>Added in 4.0</title>
<itemizedlist>
<listitem>
<para>createCounter (Adds metric counter)</para>
@ -148,9 +149,6 @@
<listitem>
<para>listVpnConnections (Lists site to site vpn connection gateways)</para>
</listitem>
</itemizedlist>
<para>Added in 3.0.3:</para>
<itemizedlist>
<listitem>
<para>enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
</listitem>
@ -165,7 +163,9 @@
as the IP address of the Nexus 1000v dvSwitch.)</para>
</listitem>
</itemizedlist>
<para>Added in 3.0.2:</para>
</section>
<section id="added-api-commands-3.0.2">
<title>Added in 3.0.2</title>
<itemizedlist>
<listitem>
<para>changeServiceForSystemVm</para>
@ -173,7 +173,9 @@
system VM must be in a "Stopped" state for this command to take effect.</para>
</listitem>
</itemizedlist>
<para>Added in 3.0.1:</para>
</section>
<section id="added-api-commands-3.0.1">
<title>Added in 3.0.1</title>
<itemizedlist>
<listitem>
<para>changeServiceForSystemVm</para>
@ -181,7 +183,9 @@
system VM must be in a "Stopped" state for this command to take effect.</para>
</listitem>
</itemizedlist>
<para>Added in 3.0.0:</para>
</section>
<section id="added-api-commands-3.0.0">
<title>Added in 3.0.0</title>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1"/>
@ -331,4 +335,5 @@
</tbody>
</tgroup>
</informaltable>
</section>
</section>

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

@ -1,3 +1,8 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@ -16,8 +21,8 @@
under the License.
-->
<section id="alerts">
<title>Alerts</title>
<appendix id="alerts">
<title>Alerts</title>
<para>The following is the list of alert type numbers. The current alerts can be found by calling listAlerts.</para>
<programlisting>MEMORY = 0</programlisting>
<programlisting>CPU = 1</programlisting>
@ -45,5 +50,4 @@
<programlisting>DIRECT_ATTACHED_PUBLIC_IP = 23;</programlisting>
<programlisting>LOCAL_STORAGE = 24;</programlisting>
<programlisting>RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only</programlisting>
</section>
</appendix>

10
docs/en-US/developer-guide.xml → docs/en-US/api-calls.xml
View File

@ -22,17 +22,11 @@
under the License.
-->
<chapter id="developer-guide">
<title>Using the API</title>
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<chapter id="api-calls">
<title>Calling the &PRODUCT; API</title>
<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" />
<xi:include href="signing-api-requests.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="responses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="asynchronous-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

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

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

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

@ -1,3 +1,8 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@ -16,8 +21,19 @@
under the License.
-->
<section id="vm-lifecycle">
<title>VM Lifecycle</title>
<para>The CloudPlatform administrator should monitor the total number of VM instances in each cluster, and disable allocation to the cluster if the total is approaching the maximum that the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of one or more hosts failing, which would increase the VM load on the other hosts as the VMs are automatically redeployed. Consult the documentation for your chosen hypervisor to find the maximum permitted number of VMs per host, then use CloudPlatform global configuration settings to set this as the default limit. Monitor the VM activity in each cluster at all times. Keep the total number of VMs below a safe level that allows for the occasional host failure. For example, if there are N hosts in the cluster, and you want to allow for one host in the cluster to be down at any given time, the total number of VM instances you can permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this number of VMs, use the CloudPlatform UI to disable allocation of more VMs to the cluster..</para>
</section>
<section id="best-practices-vm">
<title>Best Practices for Virtual Machines</title>
<para>The &PRODUCT; administrator should monitor the total number of VM instances in each
cluster, and disable allocation to the cluster if the total is approaching the maximum that
the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of
one or more hosts failing, which would increase the VM load on the other hosts as the VMs
are automatically redeployed. Consult the documentation for your chosen hypervisor to find
the maximum permitted number of VMs per host, then use &PRODUCT; global configuration
settings to set this as the default limit. Monitor the VM activity in each cluster at all
times. Keep the total number of VMs below a safe level that allows for the occasional host
failure. For example, if there are N hosts in the cluster, and you want to allow for one
host in the cluster to be down at any given time, the total number of VM instances you can
permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this
number of VMs, use the &PRODUCT; UI to disable allocation of more VMs to the
cluster.</para>
</section>

28
docs/en-US/change-database-config.xml Normal file
View File

@ -0,0 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="change-database-config">
<title>Changing the Database Configuration</title>
<para>The &PRODUCT; Management Server stores database configuration information (e.g., hostname, port, credentials) in the file /etc/cloud/management/db.properties. To effect a change, edit this file on each Management Server, then restart the Management Server.</para>
</section>

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

@ -23,20 +23,40 @@
-->
<book>
<xi:include href="Book_Info_Build_All.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<bookinfo id="cloudstack_all">
<title>&PRODUCT; Complete Documentation</title>
<productname>Apache CloudStack</productname>
<productnumber>4.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Complete documentation for &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>
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="xenserver-install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="kvm-install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="vmware-install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="hypervisor-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="choosing-a-deployment-architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="virtual-machines.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@ -49,7 +69,10 @@
<xi:include href="api-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<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="api-calls.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

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

@ -58,13 +58,13 @@
usage.execution.timezone = PST
usage.aggregation.timezone = GMT
</programlisting>
<para>Valid values for the time zone are specified in <xref linkend="appendix-a-time-zones"/></para>
<para>Valid values for the time zone are specified in <xref linkend="time-zones"/></para>
<para>Default: GMT</para>
</entry>
</row>
<row>
<entry><para>usage.execution.timezone</para></entry>
<entry><para>The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in <xref linkend="appendix-a-time-zones"/></para>
<entry><para>The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in <xref linkend="time-zones"/></para>
<para>Default: The time zone of the management server.</para>
</entry>
</row>

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

@ -22,9 +22,9 @@
under the License.
-->
<section id="developer-introduction">
<chapter id="developer-introduction">
<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" />
</section>
</chapter>

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

@ -1,39 +0,0 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<chapter id="developer_guide">
<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" />
<xi:include href="signing-api-requests.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="responses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="asynchronous-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="contacting-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

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

@ -22,199 +22,199 @@
under the License.
-->
<section id="event-types">
<title>Event Types</title>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<tbody>
<row>
<entry><para>VM.CREATE</para></entry>
<entry><para>TEMPLATE.EXTRACT</para></entry>
<entry><para>SG.REVOKE.INGRESS</para></entry>
</row>
<row>
<entry><para>VM.DESTROY</para></entry>
<entry><para>TEMPLATE.UPLOAD</para></entry>
<entry><para>HOST.RECONNECT</para></entry>
</row>
<row>
<entry><para>VM.START</para></entry>
<entry><para>TEMPLATE.CLEANUP</para></entry>
<entry><para>MAINT.CANCEL</para></entry>
</row>
<row>
<entry><para>VM.STOP</para></entry>
<entry><para>VOLUME.CREATE</para></entry>
<entry><para>MAINT.CANCEL.PS</para></entry>
</row>
<row>
<entry><para>VM.REBOOT</para></entry>
<entry><para>VOLUME.DELETE</para></entry>
<entry><para>MAINT.PREPARE</para></entry>
</row>
<row>
<entry><para>VM.UPGRADE</para></entry>
<entry><para>VOLUME.ATTACH</para></entry>
<entry><para>MAINT.PREPARE.PS</para></entry>
</row>
<row>
<entry><para>VM.RESETPASSWORD</para></entry>
<entry><para>VOLUME.DETACH</para></entry>
<entry><para>VPN.REMOTE.ACCESS.CREATE</para></entry>
</row>
<row>
<entry><para>ROUTER.CREATE</para></entry>
<entry><para>VOLUME.UPLOAD</para></entry>
<entry><para>VPN.USER.ADD</para></entry>
</row>
<row>
<entry><para>ROUTER.DESTROY</para></entry>
<entry><para>SERVICEOFFERING.CREATE</para></entry>
<entry><para>VPN.USER.REMOVE</para></entry>
</row>
<row>
<entry><para>ROUTER.START</para></entry>
<entry><para>SERVICEOFFERING.UPDATE</para></entry>
<entry><para>NETWORK.RESTART</para></entry>
</row>
<row>
<entry><para>ROUTER.STOP</para></entry>
<entry><para>SERVICEOFFERING.DELETE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.REBOOT</para></entry>
<entry><para>DOMAIN.CREATE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.HA</para></entry>
<entry><para>DOMAIN.DELETE</para></entry>
<entry><para>STATICNAT.DISABLE</para></entry>
</row>
<row>
<entry><para>PROXY.CREATE</para></entry>
<entry><para>DOMAIN.UPDATE</para></entry>
<entry><para>SSVM.CREATE</para></entry>
</row>
<row>
<entry><para>PROXY.DESTROY</para></entry>
<entry><para>SNAPSHOT.CREATE</para></entry>
<entry><para>SSVM.DESTROY</para></entry>
</row>
<row>
<entry><para>PROXY.START</para></entry>
<entry><para>SNAPSHOT.DELETE</para></entry>
<entry><para>SSVM.START</para></entry>
</row>
<row>
<entry><para>PROXY.STOP</para></entry>
<entry><para>SNAPSHOTPOLICY.CREATE</para></entry>
<entry><para>SSVM.STOP</para></entry>
</row>
<row>
<entry><para>PROXY.REBOOT</para></entry>
<entry><para>SNAPSHOTPOLICY.UPDATE</para></entry>
<entry><para>SSVM.REBOOT</para></entry>
</row>
<row>
<entry><para>PROXY.HA</para></entry>
<entry><para>SNAPSHOTPOLICY.DELETE</para></entry>
<entry><para>SSVM.H</para></entry>
</row>
<row>
<entry><para>VNC.CONNECT</para></entry>
<entry><para>VNC.DISCONNECT</para></entry>
<entry><para>NET.IPASSIGN</para></entry>
</row>
<row>
<entry><para>NET.IPRELEASE</para></entry>
<entry><para>NET.RULEADD</para></entry>
<entry><para>NET.RULEDELETE</para></entry>
</row>
<row>
<entry><para>NET.RULEMODIFY</para></entry>
<entry><para>NETWORK.CREATE</para></entry>
<entry><para>NETWORK.DELETE</para></entry>
</row>
<row>
<entry><para>LB.ASSIGN.TO.RULE</para></entry>
<entry><para>LB.REMOVE.FROM.RULE</para></entry>
<entry><para>LB.CREATE</para></entry>
</row>
<row>
<entry><para>LB.DELETE</para></entry>
<entry><para>LB.UPDATE</para></entry>
<entry><para>USER.LOGIN</para></entry>
</row>
<row>
<entry><para>USER.LOGOUT</para></entry>
<entry><para>USER.CREATE</para></entry>
<entry><para>USER.DELETE</para></entry>
</row>
<row>
<entry><para>USER.UPDATE</para></entry>
<entry><para>USER.DISABLE</para></entry>
<entry><para>TEMPLATE.CREATE</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DELETE</para></entry>
<entry><para>TEMPLATE.UPDATE</para></entry>
<entry><para>TEMPLATE.COPY</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DOWNLOAD.START</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.SUCCESS</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.FAILED</para></entry>
</row>
<row>
<entry><para>ISO.CREATE</para></entry>
<entry><para>ISO.DELETE</para></entry>
<entry><para>ISO.COPY</para></entry>
</row>
<row>
<entry><para>ISO.ATTACH</para></entry>
<entry><para>ISO.DETACH</para></entry>
<entry><para>ISO.EXTRACT</para></entry>
</row>
<row>
<entry><para>ISO.UPLOAD</para></entry>
<entry><para>SERVICE.OFFERING.CREATE</para></entry>
<entry><para>SERVICE.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>SERVICE.OFFERING.DELETE</para></entry>
<entry><para>DISK.OFFERING.CREATE</para></entry>
<entry><para>DISK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>DISK.OFFERING.DELETE</para></entry>
<entry><para>NETWORK.OFFERING.CREATE</para></entry>
<entry><para>NETWORK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>NETWORK.OFFERING.DELETE</para></entry>
<entry><para>POD.CREATE</para></entry>
<entry><para>POD.EDIT</para></entry>
</row>
<row>
<entry><para>POD.DELETE</para></entry>
<entry><para>ZONE.CREATE</para></entry>
<entry><para>ZONE.EDIT</para></entry>
</row>
<row>
<entry><para>ZONE.DELETE</para></entry>
<entry><para>VLAN.IP.RANGE.CREATE</para></entry>
<entry><para>VLAN.IP.RANGE.DELETE</para></entry>
</row>
<row>
<entry><para>CONFIGURATION.VALUE.EDIT</para></entry>
<entry><para>SG.AUTH.INGRESS</para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<appendix id="event-types">
<title>Event Types</title>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<tbody>
<row>
<entry><para>VM.CREATE</para></entry>
<entry><para>TEMPLATE.EXTRACT</para></entry>
<entry><para>SG.REVOKE.INGRESS</para></entry>
</row>
<row>
<entry><para>VM.DESTROY</para></entry>
<entry><para>TEMPLATE.UPLOAD</para></entry>
<entry><para>HOST.RECONNECT</para></entry>
</row>
<row>
<entry><para>VM.START</para></entry>
<entry><para>TEMPLATE.CLEANUP</para></entry>
<entry><para>MAINT.CANCEL</para></entry>
</row>
<row>
<entry><para>VM.STOP</para></entry>
<entry><para>VOLUME.CREATE</para></entry>
<entry><para>MAINT.CANCEL.PS</para></entry>
</row>
<row>
<entry><para>VM.REBOOT</para></entry>
<entry><para>VOLUME.DELETE</para></entry>
<entry><para>MAINT.PREPARE</para></entry>
</row>
<row>
<entry><para>VM.UPGRADE</para></entry>
<entry><para>VOLUME.ATTACH</para></entry>
<entry><para>MAINT.PREPARE.PS</para></entry>
</row>
<row>
<entry><para>VM.RESETPASSWORD</para></entry>
<entry><para>VOLUME.DETACH</para></entry>
<entry><para>VPN.REMOTE.ACCESS.CREATE</para></entry>
</row>
<row>
<entry><para>ROUTER.CREATE</para></entry>
<entry><para>VOLUME.UPLOAD</para></entry>
<entry><para>VPN.USER.ADD</para></entry>
</row>
<row>
<entry><para>ROUTER.DESTROY</para></entry>
<entry><para>SERVICEOFFERING.CREATE</para></entry>
<entry><para>VPN.USER.REMOVE</para></entry>
</row>
<row>
<entry><para>ROUTER.START</para></entry>
<entry><para>SERVICEOFFERING.UPDATE</para></entry>
<entry><para>NETWORK.RESTART</para></entry>
</row>
<row>
<entry><para>ROUTER.STOP</para></entry>
<entry><para>SERVICEOFFERING.DELETE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.REBOOT</para></entry>
<entry><para>DOMAIN.CREATE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.HA</para></entry>
<entry><para>DOMAIN.DELETE</para></entry>
<entry><para>STATICNAT.DISABLE</para></entry>
</row>
<row>
<entry><para>PROXY.CREATE</para></entry>
<entry><para>DOMAIN.UPDATE</para></entry>
<entry><para>SSVM.CREATE</para></entry>
</row>
<row>
<entry><para>PROXY.DESTROY</para></entry>
<entry><para>SNAPSHOT.CREATE</para></entry>
<entry><para>SSVM.DESTROY</para></entry>
</row>
<row>
<entry><para>PROXY.START</para></entry>
<entry><para>SNAPSHOT.DELETE</para></entry>
<entry><para>SSVM.START</para></entry>
</row>
<row>
<entry><para>PROXY.STOP</para></entry>
<entry><para>SNAPSHOTPOLICY.CREATE</para></entry>
<entry><para>SSVM.STOP</para></entry>
</row>
<row>
<entry><para>PROXY.REBOOT</para></entry>
<entry><para>SNAPSHOTPOLICY.UPDATE</para></entry>
<entry><para>SSVM.REBOOT</para></entry>
</row>
<row>
<entry><para>PROXY.HA</para></entry>
<entry><para>SNAPSHOTPOLICY.DELETE</para></entry>
<entry><para>SSVM.H</para></entry>
</row>
<row>
<entry><para>VNC.CONNECT</para></entry>
<entry><para>VNC.DISCONNECT</para></entry>
<entry><para>NET.IPASSIGN</para></entry>
</row>
<row>
<entry><para>NET.IPRELEASE</para></entry>
<entry><para>NET.RULEADD</para></entry>
<entry><para>NET.RULEDELETE</para></entry>
</row>
<row>
<entry><para>NET.RULEMODIFY</para></entry>
<entry><para>NETWORK.CREATE</para></entry>
<entry><para>NETWORK.DELETE</para></entry>
</row>
<row>
<entry><para>LB.ASSIGN.TO.RULE</para></entry>
<entry><para>LB.REMOVE.FROM.RULE</para></entry>
<entry><para>LB.CREATE</para></entry>
</row>
<row>
<entry><para>LB.DELETE</para></entry>
<entry><para>LB.UPDATE</para></entry>
<entry><para>USER.LOGIN</para></entry>
</row>
<row>
<entry><para>USER.LOGOUT</para></entry>
<entry><para>USER.CREATE</para></entry>
<entry><para>USER.DELETE</para></entry>
</row>
<row>
<entry><para>USER.UPDATE</para></entry>
<entry><para>USER.DISABLE</para></entry>
<entry><para>TEMPLATE.CREATE</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DELETE</para></entry>
<entry><para>TEMPLATE.UPDATE</para></entry>
<entry><para>TEMPLATE.COPY</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DOWNLOAD.START</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.SUCCESS</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.FAILED</para></entry>
</row>
<row>
<entry><para>ISO.CREATE</para></entry>
<entry><para>ISO.DELETE</para></entry>
<entry><para>ISO.COPY</para></entry>
</row>
<row>
<entry><para>ISO.ATTACH</para></entry>
<entry><para>ISO.DETACH</para></entry>
<entry><para>ISO.EXTRACT</para></entry>
</row>
<row>
<entry><para>ISO.UPLOAD</para></entry>
<entry><para>SERVICE.OFFERING.CREATE</para></entry>
<entry><para>SERVICE.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>SERVICE.OFFERING.DELETE</para></entry>
<entry><para>DISK.OFFERING.CREATE</para></entry>
<entry><para>DISK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>DISK.OFFERING.DELETE</para></entry>
<entry><para>NETWORK.OFFERING.CREATE</para></entry>
<entry><para>NETWORK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>NETWORK.OFFERING.DELETE</para></entry>
<entry><para>POD.CREATE</para></entry>
<entry><para>POD.EDIT</para></entry>
</row>
<row>
<entry><para>POD.DELETE</para></entry>
<entry><para>ZONE.CREATE</para></entry>
<entry><para>ZONE.EDIT</para></entry>
</row>
<row>
<entry><para>ZONE.DELETE</para></entry>
<entry><para>VLAN.IP.RANGE.CREATE</para></entry>
<entry><para>VLAN.IP.RANGE.DELETE</para></entry>
</row>
<row>
<entry><para>CONFIGURATION.VALUE.EDIT</para></entry>
<entry><para>SG.AUTH.INGRESS</para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</appendix>

4
docs/en-US/global-config.xml
View File

@ -18,7 +18,7 @@
specific language governing permissions and limitations
under the License.
-->
<section id="global-config">
<chapter id="global-config">
<title>Setting Global Configuration Parameters</title>
<para>&PRODUCT; provides parameters that you can set to control many aspects of the cloud. When
&PRODUCT; is first installed, and periodically thereafter, you might need to modify these
@ -51,4 +51,4 @@
must click the name of the hypervisor first to display the editing screen.</para>
</listitem>
</orderedlist>
</section>
</chapter>

100
docs/en-US/globally-configured-limit.xml
View File

@ -1,100 +0,0 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="globally-configured-limits">
<title>Globally Configured Limits</title>
<para>In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses.</para>
<para>The following table lists limits set in the Global Configuration:</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry><para>Parameter Name</para></entry>
<entry><para>Definition</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>max.account.public.ips</para></entry>
<entry><para>Number of public IP addresses that can be owned by an account</para></entry>
</row>
<row>
<entry><para>max.account.snapshots</para></entry>
<entry><para>Number of snapshots that can exist for an account</para></entry>
</row>
<row>
<entry><para>max.account.templates</para></entry>
<entry><para>Number of templates that can exist for an account</para></entry>
</row>
<row>
<entry><para>max.account.user.vms</para></entry>
<entry><para>Number of virtual machine instances that can exist for an account</para></entry>
</row>
<row>
<entry><para>max.account.volumes</para></entry>
<entry><para>Number of disk volumes that can exist for an account</para></entry>
</row>
<row>
<entry><para>max.template.iso.size</para></entry>
<entry><para>Maximum size for a downloaded template or ISO in GB</para></entry>
</row>
<row>
<entry><para>max.volume.size.gb</para></entry>
<entry><para>Maximum size for a volume in GB</para></entry>
</row>
<row>
<entry><para>network.throttling.rate</para></entry>
<entry><para>Default data transfer rate in megabits per second allowed per user (supported on XenServer)</para></entry>
</row>
<row>
<entry><para>snapshot.max.hourly</para></entry>
<entry><para>Maximum recurring hourly snapshots to be retained for a volume. If the limit is reached, early snapshots from the start of the hour are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring hourly snapshots can not be scheduled</para></entry>
</row>
<row>
<entry><para>snapshot.max.daily</para></entry>
<entry><para>Maximum recurring daily snapshots to be retained for a volume. If the limit is reached, snapshots from the start of the day are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring daily snapshots can not be scheduled</para></entry>
</row>
<row>
<entry><para>snapshot.max.weekly</para></entry>
<entry><para>Maximum recurring weekly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the week are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring weekly snapshots can not be scheduled</para></entry>
</row>
<row>
<entry><para>snapshot.max.monthly</para></entry>
<entry><para>Maximum recurring monthly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the month are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring monthly snapshots can not be scheduled.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>To modify global configuration parameters, use the global configuration screen in the &PRODUCT; UI. See Setting Global Configuration Parameters </para>
</section>

2
docs/en-US/globally-configured-limits.xml
View File

@ -22,7 +22,7 @@
under the License.
-->
<section id="globally-configured-limits">
<section id="globally-configured-limit">
<title>Globally Configured Limits</title>
<para>In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses.</para>
<para>The following table lists limits set in the Global Configuration:</para>

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

@ -29,5 +29,4 @@
<xi:include href="minimum-system-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="configure-package-repository.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="management-server-install-flow.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>

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

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

35
docs/en-US/networks-for-users-overview.xml Normal file
View File

@ -0,0 +1,35 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "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="networks-for-users-overview">
<title>Overview of Setting Up Networking for Users</title>
<para>People using cloud infrastructure have a variety of needs and preferences when it comes to the networking services provided by the cloud. As a &PRODUCT; administrator, you can do the following things to set up networking for your users:</para>
<itemizedlist>
<listitem><para>Set up physical networks in zones</para></listitem>
<listitem><para>Set up several different providers for the same service on a single physical network (for example, both Cisco and Juniper firewalls)</para></listitem>
<listitem><para>Bundle different types of network services into network offerings, so users can choose the desired network services for any given virtual machine </para></listitem>
<listitem><para>Add new network offerings as time goes on so end users can upgrade to a better class of service on their network</para></listitem>
<listitem><para>Provide more ways for a network to be accessed by a user, such as through a project of which the user is a member </para></listitem>
</itemizedlist>
</section>

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

@ -45,4 +45,4 @@
<xi:include href="vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="inter-vlan-routing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="configure-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>
</chapter>

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

@ -0,0 +1,31 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<chapter id="offerings">
<title>Service Offerings</title>
<para>In this chapter we discuss compute, disk, and system service offerings. Network offerings
are discussed in the section on setting up networking for users.</para>
<xi:include href="compute-disk-service-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="system-service-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

30
docs/en-US/removing-hosts.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="removing-hosts">
<title>Removing Hosts</title>
<para>Hosts can be removed from the cloud as needed. The procedure to remove a host depends on the hypervisor type.</para>
<xi:include href="removing-xenserver-kvm-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="removing-vsphere-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

16
docs/en-US/set-up-network-for-users.xml
View File

@ -22,14 +22,10 @@
under the License.
-->
<section id="set-up-network-for-users">
<chapter id="set-up-network-for-users">
<title>Setting Up Networking for Users</title>
<para>People using cloud infrastructure have a variety of needs and preferences when it comes to the networking services provided by the cloud. As a &PRODUCT; administrator, you can do the following things to set up networking for your users:</para>
<itemizedlist>
<listitem><para>Set up physical networks in zones</para></listitem>
<listitem><para>Set up several different providers for the same service on a single physical network (for example, both Cisco and Juniper firewalls)</para></listitem>
<listitem><para>Bundle different types of network services into network offerings, so users can choose the desired network services for any given virtual machine </para></listitem>
<listitem><para>Add new network offerings as time goes on so end users can upgrade to a better class of service on their network</para></listitem>
<listitem><para>Provide more ways for a network to be accessed by a user, such as through a project of which the user is a member </para></listitem>
</itemizedlist>
</section>
<xi:include href="networks-for-users-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-virtual-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="network-service-providers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="network-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

14
docs/en-US/storage.xml
View File

@ -22,9 +22,11 @@
under the License.
-->
<section id="storage">
<title>Deleting VMs</title>
<para>&PRODUCT; defines two types of storage: primary and secondary. Primary storage can be accessed by either iSCSI or NFS. Additionally, direct attached storage may be used for primary storage. Secondary storage is always accessed using NFS.</para>
<para>There is no ephemeral storage in &PRODUCT;. All volumes on all nodes are persistent</para>
</section>
<chapter id="storage">
<title>Working With Storage</title>
<xi:include href="storage-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-snapshots.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

15
docs/en-US/sys-reliability-and-ha.xml
View File

@ -22,10 +22,11 @@
under the License.
-->
<section id="sys-reliability-and-ha">
<title>System Reliability and High Availability</title>
<para><xref linkend="ha-management-server" />vCenter Maintenance Mode</para>
<para><xref linkend="ha-enabled-vm" />XenServer and Maintenance Mode</para>
<para><xref linkend="ha-for-hosts" />vCenter Maintenance Mode</para>
<para><xref linkend="dedicated-ha-hosts" />XenServer and Maintenance Mode</para>
</section>
<chapter id="sys-reliability-and-ha">
<title>System Reliability and High Availability</title>
<xi:include href="ha-management-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ha-enabled-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ha-for-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="primary-storage-outage-and-data-loss.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="secondary-storage-outage-and-data-loss.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

69
docs/en-US/tagging-resources.xml Normal file
View File

@ -0,0 +1,69 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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="tagging-resources">
<title>Using Tags to Organize Resources in the Cloud</title>
<para>A tag is a key-value pair that stores metadata about a resource in the cloud. Tags are
useful for categorizing resources. For example, you can tag a user VM with a
value that indicates the user's city of residence. In this case, the key would
be "city" and the value might be "Toronto" or "Tokyo." You can then request
&PRODUCT; to find all resources that have a given tag; for example, VMs for
users in a given city.</para>
<para>You can tag a user virtual machine, volume, snapshot, guest network, template,
ISO, firewall rule, port forwarding rule, public IP address, security group,
load balancer rule, project, VPC, network ACL, or static route. You can not tag
a remote access VPN.</para>
<para>You can work with tags through the UI or through the API commands createTags,
deleteTags, and listTags. You can define multiple tags for each resource. There
is no limit on the number of tags you can define. Each tag can be up to 255
characters long. Users can define tags on the resources they own, and
administrators can define tags on any resources in the cloud.</para>
<para>An optional input parameter, "tags," exists on many of the list* API commands.
The following example shows how to use this new parameter to find all the volumes
having tag region=canada OR tag city=Toronto:</para>
<programlisting>command=listVolumes
&amp;listAll=true
&amp;tags[0].key=region
&amp;tags[0].value=canada
&amp;tags[1].key=city
&amp;tags[1].value=Toronto</programlisting>
<para>The following API commands have the "tags" input parameter:</para>
<itemizedlist>
<listitem><para>listVirtualMachines</para></listitem>
<listitem><para>listVolumes</para></listitem>
<listitem><para>listSnapshots</para></listitem>
<listitem><para>listNetworks</para></listitem>
<listitem><para>listTemplates</para></listitem>
<listitem><para>listIsos</para></listitem>
<listitem><para>listFirewallRules</para></listitem>
<listitem><para>listPortForwardingRules</para></listitem>
<listitem><para>listPublicIpAddresses</para></listitem>
<listitem><para>listSecurityGroups</para></listitem>
<listitem><para>listLoadBalancerRules</para></listitem>
<listitem><para>listProjects</para></listitem>
<listitem><para>listVPCs</para></listitem>
<listitem><para>listNetworkACLs</para></listitem>
<listitem><para>listStaticRoutes</para></listitem>
</itemizedlist>
</section>

6
docs/en-US/time-zones.xml
View File

@ -22,9 +22,9 @@
under the License.
-->
<section id="time-zones">
<appendix id="time-zones">
<title>Time Zones</title>
<para>The following time zone identifiers are accepted by the &PRODUCT; API. 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>
<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 frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
@ -134,4 +134,4 @@
</tbody>
</tgroup>
</informaltable>
</section>
</appendix>

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

@ -22,13 +22,14 @@
under the License.
-->
<section id="troubleshooting">
<para><xref linkend="troubleshooting-alerts" />Alert Type Numbers</para>
<para><xref linkend="troubleshooting-dataloss-on-exported-primary-storage" />Data Loss on Exported Primary Storage</para>
<para><xref linkend="troubleshooting-lb-rules-fails" />Load balancer rules fail after changing network offering</para>
<para><xref linkend="troubleshooting-maintenance-mode-not-working-on-vCenter" />Maintenance mode not working on vCenter</para>
<para><xref linkend="troubleshooting-recover-lost-virtual-router" />Recovering a Lost Virtual Router</para>
<para><xref linkend="troubleshooting-unable-to-deploy-vms" />Unable to deploy VMs from uploaded vSphere template</para>
<para><xref linkend="troubleshooting-unable-to-power-on-vm" />Unable to power on virtual machine on VMware</para>
<para><xref linkend="troubleshooting-working-with-server-logs" />Working with Server Logs</para>
</section>
<chapter id="troubleshooting">
<title>Troubleshooting</title>
<xi:include href="events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting-working-with-server-logs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting-dataloss-on-exported-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting-recover-lost-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting-maintenance-mode-not-working-on-vCenter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting-unable-to-deploy-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting-unable-to-power-on-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting-lb-rules-fails.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

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

@ -22,7 +22,7 @@
under the License.
-->
<section id="tuning">
<chapter id="tuning">
<title>Tuning</title>
<para>This section provides tips on how to improve the performance of your cloud.</para>
<xi:include href="performance-monitoring.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@ -30,4 +30,4 @@
<xi:include href="set-database-buffer-pool-size.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-monitor-total-vm-limits-per-host.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="configure-xenserver-dom0-memory.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>

4
docs/en-US/user-services-overview.xml
View File

@ -22,7 +22,7 @@
under the License.
-->
<section id="user-services-overview">
<chapter id="user-services-overview">
<title>User Services Overview</title>
<para>In addition to the physical and logical infrastructure of your cloud,
and the &PRODUCT; software and servers, you also need a layer of user
@ -69,4 +69,4 @@
System Service Offerings.
</para>
</section>
</section>
</chapter>

2
docs/en-US/using-multiple-guest-networks.xml
View File

@ -28,4 +28,6 @@
<para>A VM's networks are defined at VM creation time. A VM cannot add or remove networks after it has been created, although the user can go into the guest and remove the IP address from the NIC on a particular network.</para>
<para>Each VM has just one default network. The virtual router's DHCP reply will set the guest's default gateway as that for the default network. Multiple non-default networks may be added to a guest in addition to the single, required default network. The administrator can control which networks are available as the default network.</para>
<para>Additional networks can either be available to all accounts or be assigned to a specific account. Networks that are available to all accounts are zone-wide. Any user with access to the zone can create a VM with access to that network. These zone-wide networks provide little or no isolation between guests.Networks that are assigned to a specific account provide strong isolation.</para>
<xi:include href="add-additional-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="change-network-offering-on-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -30,4 +30,8 @@
<listitem><para><emphasis role="bold">Road Warrior / Remote Access</emphasis>. Users want to be able to connect securely from a home or office to a private network in the cloud. Typically, the IP address of the connecting client is dynamic and cannot be preconfigured on the VPN server.</para></listitem>
<listitem><para><emphasis role="bold">Site to Site</emphasis>. In this scenario, two private subnets are connected over the public Internet with a secure VPN tunnel. The cloud user’s subnet (for example, an office network) is connected through a gateway to the network in the cloud. The address of the user’s gateway must be preconfigured on the VPN server in the cloud. Note that although L2TP-over-IPsec can be used to set up Site-to-Site VPNs, this is not the primary intent of this feature.</para></listitem>
</itemizedlist>
<xi:include href="configure-vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="using-vpn-with-windows.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="using-vpn-with-mac.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="site-to-site-vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

27
docs/en-US/whats-new.xml
View File

@ -22,13 +22,20 @@
under the License.
-->
<section id="whats-new">
<title>What's New in 3.0.x?</title>
<para>The following describes any new major features of each CloudPlatform version as it applies to API usage.</para>
<xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="change-to-behavior-of-list-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="added-cloudPlatform-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<chapter id="whats-new">
<title>What's New in the API?</title>
<para>The following describes any new major features of each &PRODUCT; version as it applies to API usage.</para>
<section id="whats-new-in-api-4.0">
<title>What's New in the API for 4.0</title>
<para>TODO</para>
</section>
<section id="whats-new-in-api-3.0">
<title>What's New in the API for 3.0</title>
<xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="change-to-behavior-of-list-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="added-cloudPlatform-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>

16
docs/en-US/work-with-usage.xml
View File

@ -22,7 +22,15 @@
under the License.
-->
<section id="change-database-config">
<title>Changing the Database Configuration</title>
<para>The &PRODUCT; Management Server stores database configuration information (e.g., hostname, port, credentials) in the file /etc/cloud/management/db.properties. To effect a change, edit this file on each Management Server, then restart the Management Server.</para>
</section>
<chapter id="work-with-usage">
<title>Working with Usage</title>
<para>The Usage Server is an optional, separately-installed part of &PRODUCT; that provides aggregated usage records which you can use to create billing integration for &PRODUCT;. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call. </para>
<para>The usage records show the amount of resources, such as VM run time or template storage
space, consumed by guest instances.</para>
<para>The Usage Server runs at least once per day. It can be configured to run multiple times per day.</para>
<xi:include href="configure-usage-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-usage-limit.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="globally-configured-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="default-account-resource-limit.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="per-domain-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

19
docs/en-US/working-with-hosts.xml
View File

@ -22,7 +22,18 @@
under the License.
-->
<section id="removing-hosts">
<title>Removing Hosts</title>
<para>Hosts can be removed from the cloud as needed. The procedure to remove a host depends on the hypervisor type.</para>
</section>
<chapter id="working-with-hosts">
<title>Working With Hosts</title>
<section id="adding-hosts">
<title>Adding Hosts</title>
<para>Additional hosts can be added at any time to provide more capacity for guest VMs. For requirements and instructions, see <xref linkend="host-add"/>.</para>
</section>
<xi:include href="scheduled-maintenance-maintenance-mode-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="disable-enable-zones-pods-clusters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="removing-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="re-install-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="maintain-hypervisors-on-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="change-host-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="host-allocation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="vlan-provisioning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

13
docs/en-US/working-with-system-vm.xml
View File

@ -22,7 +22,12 @@
under the License.
-->
<section id="working-with-system-vm">
<title>Working with System Virtual Machines</title>
<para>&PRODUCT; uses several types of system virtual machines to perform tasks in the cloud. In general &PRODUCT; manages these system VMs and creates, starts, and stops them as needed based on scale and immediate needs. However, the administrator should be aware of them and their roles to assist in debugging issues.</para>
</section>
<chapter id="working-with-system-vm">
<title>Working with System Virtual Machines</title>
<para>&PRODUCT; uses several types of system virtual machines to perform tasks in the cloud. In general &PRODUCT; manages these system VMs and creates, starts, and stops them as needed based on scale and immediate needs. However, the administrator should be aware of them and their roles to assist in debugging issues.</para>
<xi:include href="system-vm-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="multiple-system-vm-vmware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="console-proxy.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="secondary-storage-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

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

@ -22,7 +22,7 @@
under the License.
-->
<section id="working-with-templates">
<chapter id="working-with-templates">
<title>Working with Templates</title>
<para>A template is a reusable configuration for virtual machines. When users launch VMs, they can choose from a list of templates in &PRODUCT;.</para>
<para>Specifically, a template is a virtual disk image that includes one of a variety of operating systems, optional additional software such as office applications, and settings such as access control to determine who can use the template. Each template is associated with a particular type of hypervisor, which is specified when the template is added to &PRODUCT;.</para>
@ -38,7 +38,7 @@
<xi:include href="export-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="create-windows-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="import-ami.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="create-bare-metal-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="convert-hyperv-vm-to-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-password-management-to-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="delete-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>

4
docs/en-US/working-with-usage-data.xml
View File

@ -22,7 +22,7 @@
under the License.
-->
<section id="working-with-usage-data">
<chapter id="working-with-usage-data">
<title>Working With Usage Data</title>
<para>The Usage Server provides aggregated usage records which you can use to create billing integration for the &PRODUCT; platform. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call.</para>
<para>The usage records show the amount of resources, such as VM run time or template storage space, consumed by guest instances. In the special case of bare metal instances, no template storage resources are consumed, but records showing zero usage are still included in the Usage Server's output.</para>
@ -31,4 +31,4 @@
<xi:include href="usage-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="example-response-from-listUsageRecords.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="dates-in-usage-record.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>