http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/added-API-commands.xml ---------------------------------------------------------------------- diff --git a/en-US/added-API-commands.xml b/en-US/added-API-commands.xml deleted file mode 100644 index 99635de..0000000 --- a/en-US/added-API-commands.xml +++ /dev/null @@ -1,195 +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="added-API-commands"> - <title>Added API commands in 3.0</title> - <section id="added-api-commands-3.0.2"> - <title>Added in 3.0.2</title> - <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> - </section> - <section id="added-api-commands-3.0.1"> - <title>Added in 3.0.1</title> - <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> - </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"/> - <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 account 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/></entry> - <entry><para/></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> -</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/added-error-codes.xml ---------------------------------------------------------------------- diff --git a/en-US/added-error-codes.xml b/en-US/added-error-codes.xml deleted file mode 100644 index ae73891..0000000 --- a/en-US/added-error-codes.xml +++ /dev/null @@ -1,138 +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="added-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.</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 : "org.apache.cloudstack.api.ServerApiException"</para></entry> - <entry><para></para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/adding-IP-addresses-for-the-public-network.xml ---------------------------------------------------------------------- diff --git a/en-US/adding-IP-addresses-for-the-public-network.xml b/en-US/adding-IP-addresses-for-the-public-network.xml deleted file mode 100644 index abf4d02..0000000 --- a/en-US/adding-IP-addresses-for-the-public-network.xml +++ /dev/null @@ -1,45 +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="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> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/additional-installation-options.xml ---------------------------------------------------------------------- diff --git a/en-US/additional-installation-options.xml b/en-US/additional-installation-options.xml deleted file mode 100644 index 622ef03..0000000 --- a/en-US/additional-installation-options.xml +++ /dev/null @@ -1,31 +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="additional-installation-options"> - <title>Additional Installation Options</title> - <para>The next few sections describe &PRODUCT; features above and beyond the basic deployment options.</para> - <xi:include href="install-usage-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="ssl.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="database-replication.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/admin-alerts.xml ---------------------------------------------------------------------- diff --git a/en-US/admin-alerts.xml b/en-US/admin-alerts.xml deleted file mode 100644 index e98f79d..0000000 --- a/en-US/admin-alerts.xml +++ /dev/null @@ -1,128 +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="admin-alerts"> - <title>Administrator Alerts</title> - <para>The system provides alerts and events to help with the management of the cloud. Alerts are notices to an administrator, generally delivered by e-mail, notifying the administrator that an error has occurred in the cloud. Alert behavior is configurable.</para> - <para>Events track all of the user and administrator actions in the cloud. For example, every guest VM start creates an associated event. Events are stored in the Management Serverâs database.</para> - <para>Emails will be sent to administrators under the following circumstances:</para> - <itemizedlist> - <listitem><para>The Management Server cluster runs low on CPU, memory, or storage resources</para></listitem> - <listitem><para>The Management Server loses heartbeat from a Host for more than 3 minutes</para></listitem> - <listitem><para>The Host cluster runs low on CPU, memory, or storage resources</para></listitem> - </itemizedlist> - <section id="external-snmp-manager"> - <!-- CLOUDSTACK-680 --> - <title>Sending Alerts to External SNMP and Syslog Managers</title> - <para>In addition to showing administrator alerts on the Dashboard in the &PRODUCT; UI and - sending them in email, &PRODUCT; can also send the same alerts to external SNMP or - Syslog management software. This is useful if you prefer to use an SNMP or Syslog - manager to monitor your cloud.</para> - <para>The alerts which can be sent are listed in <xref linkend="alerts"/>. You can also - display the most up to date list by calling the API command listAlerts.</para> - <section id="snmp-alert-details"> - <title>SNMP Alert Details</title> - <para>The supported protocol is SNMP version 2.</para> - <para>Each SNMP trap contains the following information: message, podId, dataCenterId, clusterId, and generationTime.</para> - </section> - <section id="syslog-alert-details"> - <title>Syslog Alert Details</title> - <para>&PRODUCT; generates a syslog message for every alert. Each syslog message incudes - the fields alertType, message, podId, dataCenterId, and clusterId, in the following - format. If any field does not have a valid value, it will not be included.</para> - <programlisting>Date severity_level Management_Server_IP_Address/Name alertType:: value dataCenterId:: value podId:: value clusterId:: value message:: value</programlisting> - <para>For example:</para> - <programlisting>Mar 4 10:13:47 WARN localhost alertType:: managementNode message:: Management server node 127.0.0.1 is up</programlisting> - </section> - <section id="snmp-syslog-config"> - <title>Configuring SNMP and Syslog Managers</title> - <para>To configure one or more SNMP managers or Syslog managers to receive alerts from - &PRODUCT;:</para> - <orderedlist> - <listitem><para>For an SNMP manager, install the &PRODUCT; MIB file on your SNMP manager system. - This maps the SNMP OIDs to trap types that can be more easily read by users. - The file must be publicly available. - For more information on how to install this file, consult the documentation provided with the SNMP manager.</para></listitem> - <listitem> - <para>Edit the file /etc/cloudstack/management/log4j-cloud.xml.</para> - <programlisting># vi /etc/cloudstack/management/log4j-cloud.xml</programlisting> - </listitem> - <listitem> - <para>Add an entry using the syntax shown below. Follow the appropriate example - depending on whether you are adding an SNMP manager or a Syslog manager. To specify - multiple external managers, separate the IP addresses and other configuration values - with commas (,).</para> - <note> - <para>The recommended maximum number of SNMP or Syslog managers is 20 for - each.</para> - </note> - <para/> - <para>The following example shows how to configure two SNMP managers at IP addresses - 10.1.1.1 and 10.1.1.2. Substitute your own IP addresses, ports, and communities. Do - not change the other values (name, threshold, class, and layout values).</para> - <programlisting><appender name="SNMP" class="org.apache.cloudstack.alert.snmp.SnmpTrapAppender"> - <param name="Threshold" value="WARN"/> <!-- Do not edit. The alert feature assumes WARN. --> - <param name="SnmpManagerIpAddresses" value="10.1.1.1,10.1.1.2"/> - <param name="SnmpManagerPorts" value="162,162"/> - <param name="SnmpManagerCommunities" value="public,public"/> - <layout class="org.apache.cloudstack.alert.snmp.SnmpEnhancedPatternLayout"> <!-- Do not edit --> - <param name="PairDelimeter" value="//"/> - <param name="KeyValueDelimeter" value="::"/> - </layout> -</appender></programlisting> - <para>The following example shows how to configure two Syslog managers at IP - addresses 10.1.1.1 and 10.1.1.2. Substitute your own IP addresses. You can - set Facility to any syslog-defined value, such as LOCAL0 - LOCAL7. Do not - change the other values.</para> - <programlisting><appender name="ALERTSYSLOG"> - <param name="Threshold" value="WARN"/> - <param name="SyslogHosts" value="10.1.1.1,10.1.1.2"/> - <param name="Facility" value="LOCAL6"/> - <layout> - <param name="ConversionPattern" value=""/> - </layout> -</appender></programlisting> - </listitem> - <listitem> - <para>If your cloud has multiple Management Server nodes, repeat these steps to edit - log4j-cloud.xml on every instance.</para> - </listitem> - <listitem> - <para>If you have made these changes while the Management Server is running, wait a - few minutes for the change to take effect.</para> - </listitem> - </orderedlist> - <para><emphasis role="bold">Troubleshooting:</emphasis> If no alerts appear at the - configured SNMP or Syslog manager after a reasonable amount of time, it is likely that - there is an error in the syntax of the <appender> entry in log4j-cloud.xml. Check - to be sure that the format and settings are correct.</para> - </section> - <section id="delete-snmp-syslog-manager"> - <title>Deleting an SNMP or Syslog Manager</title> - <para>To remove an external SNMP manager or Syslog manager so that it no longer receives - alerts from &PRODUCT;, remove the corresponding entry from the file - /etc/cloudstack/management/log4j-cloud.xml.</para> - </section> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/admin-guide.xml ---------------------------------------------------------------------- diff --git a/en-US/admin-guide.xml b/en-US/admin-guide.xml deleted file mode 100644 index f1b0327..0000000 --- a/en-US/admin-guide.xml +++ /dev/null @@ -1,92 +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="admin-guide"> - <title>Administrator Guide</title> - <xi:include href="whats-in-this-adminguide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="about-working-with-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="creating-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="vm-lifecycle.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="accessing-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="stopping-and-starting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="changing-vm-name-os-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="changing-service-offering-for-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="manual-live-migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="deleting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="best-practices-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="runtime-behavior-of-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="hypervisor-support-for-primarystorage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="storage-tags.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="maintenance-mode-for-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="best-practices-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="secondary-storage-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="changing-secondary-storage-ip.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="changing-secondary-storage-servers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="using-swift-for-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="working-with-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="creating-new-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="upload-existing-volume-to-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="upload-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="private-public-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="attaching-volume.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="detach-move-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="resizing-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="volume-deletion-garbage-collection.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="incremental-snapshots-backup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="volume-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="snapshot-restore.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="guest-traffic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="using-multiple-guest-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="add-additional-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="change-network-offering-on-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="about-virtual-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="isolated-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="shared-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="add-ingress-egress-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="runtime-allocation-virtual-network-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="creating-network-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="enable-security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="add-security-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="add-load-balancer-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="sticky-session-policies-for-lb-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="guest-ip-ranges.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="acquire-new-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="release-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="static-nat.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="enable-disable-static-nat.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="ip-forwarding-firewalling.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="firewall-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="port-forwarding.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="ip-load-balancing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="dns-dhcp.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="add-password-management-to-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="configure-vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="cloudstack-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - </chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/adv-zone-topology-req.xml ---------------------------------------------------------------------- diff --git a/en-US/adv-zone-topology-req.xml b/en-US/adv-zone-topology-req.xml deleted file mode 100644 index 3764e92..0000000 --- a/en-US/adv-zone-topology-req.xml +++ /dev/null @@ -1,25 +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="adv-zone-topology-req"> - <title>Advanced Zone Topology Requirements</title> - <para>With Advanced Networking, separate subnets must be used for private and public - networks.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/advanced-zone-configuration.xml ---------------------------------------------------------------------- diff --git a/en-US/advanced-zone-configuration.xml b/en-US/advanced-zone-configuration.xml deleted file mode 100644 index 451b545..0000000 --- a/en-US/advanced-zone-configuration.xml +++ /dev/null @@ -1,385 +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="advanced-zone-configuration"> - <title>Advanced Zone Configuration</title> - <orderedlist> - <listitem> - <para>After you select Advanced in the Add Zone wizard and click Next, you will be asked to - enter the following details. Then click Next.</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name.</emphasis> A name for the zone.</para> - </listitem> - <listitem> - <para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest - VMs in the zone. These DNS servers will be accessed via the public network you will add - later. The public IP addresses for the zone must have a route to the DNS server named - here.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS - servers for use by system VMs in the zone(these are VMs used by &PRODUCT; itself, such - as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will - be accessed via the management traffic network interface of the System VMs. The private - IP address you provide for the pods must have a route to the internal DNS server named - here.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a - special domain name to the guest VM network, specify the DNS suffix.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Guest CIDR.</emphasis> This is the CIDR that describes the IP - addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. - As a matter of good practice you should set different CIDRs for different zones. This - will make it easier to set up VPNs between networks in different zones.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose - the hypervisor for the first cluster in the zone. You can add clusters with different - hypervisors later, after you finish adding the zone.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A - zone that is not public will be assigned to a particular domain. Only users in that - domain will be allowed to create guest VMs in this zone.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Choose which traffic types will be carried by the physical network.</para> - <para>The traffic types are management, public, guest, and storage traffic. For more - information about the types, roll over the icons to display their tool tips, or see <xref - linkend="advanced-zone-network-traffic-types"/>. This screen starts out with one network - already configured. If you have multiple physical networks, you need to add more. Drag and - drop traffic types onto a greyed-out network and it will become active. You can move the - traffic icons from one network to another; for example, if the default traffic types shown - for Network 1 do not match your actual setup, you can move them down. You can also change - the network names if desired.</para> - </listitem> - <listitem> - <para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on - each physical network. These labels must match the labels you have already defined on the - hypervisor host. To assign each label, click the Edit button under the traffic type icon - within each physical network. A popup dialog appears where you can type the label, then - click OK.</para> - <para>These traffic labels will be defined only for the hypervisor selected for the first - cluster. For all other hypervisors, the labels can be configured after the zone is - created.</para> - <para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify - the corresponding Ethernet port profile names as network traffic label for each traffic type - on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere - Cluster with Nexus 1000v Virtual Switch in the Installation Guide. If you have enabled - VMware dvSwitch in the environment, you must specify the corresponding Switch name as - network traffic label for each traffic type on the physical network. For more information, - see Configuring a VMware Datacenter with VMware Distributed Virtual Switch in the - Installation Guide. </para> - </listitem> - <listitem> - <para>Click Next.</para> - </listitem> - <listitem> - <para>Configure the IP range for public Internet traffic. Enter the following details, then - click Add. If desired, you can repeat this step to add more public Internet IP ranges. When - done, click Next.</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP - addresses.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP - range.</para> - </listitem> - <listitem> - <para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public - traffic.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are - assumed to be accessible from the Internet and will be allocated for access to guest - networks.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. - For an overview of what a pod is, see <xref linkend="about-pods"/>.</para> - <para>To configure the first pod, enter the following, then click Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts - in that pod.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that - defines the pod's subnet. Use CIDR notation.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the - management network that &PRODUCT; uses to manage various system VMs, such as Secondary - Storage VMs, Console Proxy VMs, and DHCP. For more information, see <xref - linkend="system-reserved-ip-addresses"/>.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN - Allocation Example ), then click Next.</para> - </listitem> - <listitem> - <para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters - later. For an overview of what a cluster is, see <xref linkend="about-clusters"/>.</para> - <para>To configure the first cluster, enter the following, then click Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this - field is read only) Choose the type of hypervisor software that all hosts in this - cluster will run. If you choose VMware, additional fields appear so you can give - information about a vSphere cluster. For vSphere servers, we recommend creating the - cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add - Cluster: vSphere .</para> - </listitem> - <listitem> - <para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This - can be text of your choosing and is not used by &PRODUCT;.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts - later. For an overview of what a host is, see <xref linkend="about-hosts"/>.</para> - <note> - <para>When you deploy &PRODUCT;, the hypervisor host must not have any VMs already - running.</para> - </note> - <para>Before you can configure the host, you need to install the hypervisor software on the - host. You will need to know which version of the hypervisor software version is supported by - &PRODUCT; and what additional configuration is required to ensure the host will work with - &PRODUCT;. To find these installation details, see:</para> - <itemizedlist> - <listitem> - <para>Citrix XenServer Installation for &PRODUCT;</para> - </listitem> - <listitem> - <para>VMware vSphere Installation and Configuration</para> - </listitem> - <listitem> - <para>KVM Installation and Configuration</para> - </listitem> - <!-- <listitem> - <para>Oracle VM (OVM) Installation and Configuration</para> - </listitem> --> - </itemizedlist> - <para>To configure the first host, enter the following, then click Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the - host.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Username.</emphasis> Usually root.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Password.</emphasis> This is the password for the user named - above (from your XenServer or KVM install).</para> - </listitem> - <listitem> - <para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to - categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag - (set in the ha.tag global configuration parameter) if you want this host to be used only - for VMs with the "high availability" feature enabled. For more information, see - HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration - Guide.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can - always add more servers later. For an overview of what primary storage is, see <xref - linkend="about-primary-storage"/>.</para> - <para>To configure the first primary storage server, enter the following, then click - Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI, - or PreSetup. For KVM, choose NFS, SharedMountPoint, CLVM, and RBD. For vSphere choose - either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary - depending on what you choose here.</para> - <informaltable frame="all"> - <tgroup cols="2" align="left" colsep="1" rowsep="1"> - <colspec colname="c1"/> - <colspec colname="c2"/> - <tbody> - <row> - <entry><para>NFS</para></entry> - <entry> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of - the storage device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Path.</emphasis> The exported path from the - server.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated - list of tags for this storage device. It should be an equivalent set or - superset of the tags on your disk offerings.</para> - </listitem> - </itemizedlist> - <para>The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that has tags T1 - and T2, all other clusters in the Zone must also provide primary storage that - has tags T1 and T2.</para> - </entry> - </row> - <row> - <entry><para>iSCSI</para></entry> - <entry> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of - the storage device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Target IQN.</emphasis> The IQN of the target. - For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Lun.</emphasis> The LUN number. For example, - 3.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated - list of tags for this storage device. It should be an equivalent set or - superset of the tags on your disk offerings.</para> - </listitem> - </itemizedlist> - <para>The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that has tags T1 - and T2, all other clusters in the Zone must also provide primary storage that - has tags T1 and T2.</para> - </entry> - </row> - <row> - <entry><para>preSetup</para></entry> - <entry> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of - the storage device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">SR Name-Label.</emphasis> Enter the name-label - of the SR that has been set up outside &PRODUCT;.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated - list of tags for this storage device. It should be an equivalent set or - superset of the tags on your disk offerings.</para> - </listitem> - </itemizedlist> - <para>The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that has tags T1 - and T2, all other clusters in the Zone must also provide primary storage that - has tags T1 and T2.</para> - </entry> - </row> - <row> - <entry><para>SharedMountPoint</para></entry> - <entry> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Path.</emphasis> The path on each host that is - where this primary storage is mounted. For example, "/mnt/primary".</para> - </listitem> - <listitem> - <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated - list of tags for this storage device. It should be an equivalent set or - superset of the tags on your disk offerings.</para> - </listitem> - </itemizedlist> - <para>The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that has tags T1 - and T2, all other clusters in the Zone must also provide primary storage that - has tags T1 and T2.</para> - </entry> - </row> - <row> - <entry><para>VMFS</para></entry> - <entry> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of - the vCenter server.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Path.</emphasis> A combination of the datacenter - name and the datastore name. The format is "/" datacenter name "/" - datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para> - </listitem> - <listitem> - <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated - list of tags for this storage device. It should be an equivalent set or - superset of the tags on your disk offerings.</para> - </listitem> - </itemizedlist> - <para>The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that has tags T1 - and T2, all other clusters in the Zone must also provide primary storage that - has tags T1 and T2.</para> - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new zone, &PRODUCT; adds the first secondary storage server for you. For an - overview of what secondary storage is, see <xref linkend="about-secondary-storage"/>.</para> - <para>Before you can fill out this screen, you need to prepare the secondary storage by - setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding - Secondary Storage :</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">NFS Server.</emphasis> The IP address of the server or fully - qualified domain name of the server.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Click Launch.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/advanced-zone-guest-ip-addresses.xml ---------------------------------------------------------------------- diff --git a/en-US/advanced-zone-guest-ip-addresses.xml b/en-US/advanced-zone-guest-ip-addresses.xml deleted file mode 100644 index 66bc082..0000000 --- a/en-US/advanced-zone-guest-ip-addresses.xml +++ /dev/null @@ -1,31 +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="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. Additionally, the - administrator can reserve a part of the IP address space for non-&PRODUCT; VMs and - servers.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/advanced-zone-network-traffic-types.xml ---------------------------------------------------------------------- diff --git a/en-US/advanced-zone-network-traffic-types.xml b/en-US/advanced-zone-network-traffic-types.xml deleted file mode 100644 index 4d1f465..0000000 --- a/en-US/advanced-zone-network-traffic-types.xml +++ /dev/null @@ -1,34 +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="advanced-zone-network-traffic-types"> - <title>Advanced Zone Network Traffic Types</title> - <para>When advanced networking is used, there can be multiple physical networks in the zone. Each physical network can carry one or more traffic types, and you need to let &PRODUCT; know which type of network traffic you want each network to carry. The traffic types in an advanced zone are:</para> - <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> - <listitem><para>Management. When &PRODUCT;âs internal resources communicate with each other, they generate management traffic. This includes communication between hosts, system VMs (VMs used by &PRODUCT; to perform various tasks in the cloud), and any other component that communicates directly with the &PRODUCT; Management Server. You must configure the IP range for the system VMs to use.</para></listitem> - <listitem><para>Public. Public traffic is generated when VMs in the cloud access the Internet. Publicly accessible IPs must be allocated for this purpose. End users can use the &PRODUCT; UI to acquire these IPs to implement NAT between their guest network and the public network, as described in âAcquiring a New IP Addressâ in the Administration Guide.</para></listitem> - <listitem><para>Storage. While labeled "storage" this is specifically about secondary storage, and doesn't affect traffic for primary storage. This includes 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> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/advanced-zone-physical-network-configuration.xml ---------------------------------------------------------------------- diff --git a/en-US/advanced-zone-physical-network-configuration.xml b/en-US/advanced-zone-physical-network-configuration.xml deleted file mode 100644 index cfc6184..0000000 --- a/en-US/advanced-zone-physical-network-configuration.xml +++ /dev/null @@ -1,30 +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="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> - <xi:include href="configure-guest-traffic-in-advanced-zone.xml" - xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="configure-public-traffic-in-an-advanced-zone.xml" - xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="creating-shared-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/advanced-zone-public-ip-addresses.xml ---------------------------------------------------------------------- diff --git a/en-US/advanced-zone-public-ip-addresses.xml b/en-US/advanced-zone-public-ip-addresses.xml deleted file mode 100644 index 82b71d1..0000000 --- a/en-US/advanced-zone-public-ip-addresses.xml +++ /dev/null @@ -1,27 +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="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> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/alerts.xml ---------------------------------------------------------------------- diff --git a/en-US/alerts.xml b/en-US/alerts.xml deleted file mode 100644 index 19efede..0000000 --- a/en-US/alerts.xml +++ /dev/null @@ -1,54 +0,0 @@ -<?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 - 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="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 // Available Memory below configured threshold</programlisting> - <programlisting>CPU = 1 // Unallocated CPU below configured threshold</programlisting> - <programlisting>STORAGE =2 // Available Storage below configured threshold</programlisting> - <programlisting>STORAGE_ALLOCATED = 3 // Remaining unallocated Storage is below configured threshold</programlisting> - <programlisting>PUBLIC_IP = 4 // Number of unallocated virtual network public IPs is below configured threshold</programlisting> - <programlisting>PRIVATE_IP = 5 // Number of unallocated private IPs is below configured threshold</programlisting> - <programlisting>SECONDARY_STORAGE = 6 // Available Secondary Storage in availability zone is below configured threshold</programlisting> - <programlisting>HOST = 7 // Host related alerts like host disconnected</programlisting> - <programlisting>USERVM = 8 // User VM stopped unexpectedly</programlisting> - <programlisting>DOMAIN_ROUTER = 9 // Domain Router VM stopped unexpectedly</programlisting> - <programlisting>CONSOLE_PROXY = 10 // Console Proxy VM stopped unexpectedly</programlisting> - <programlisting>ROUTING = 11 // Lost connection to default route (to the gateway)</programlisting> - <programlisting>STORAGE_MISC = 12 // Storage issue in system VMs</programlisting> - <programlisting>USAGE_SERVER = 13 // No usage server process running</programlisting> - <programlisting>MANAGMENT_NODE = 14 // Management network CIDR is not configured originally</programlisting> - <programlisting>DOMAIN_ROUTER_MIGRATE = 15 // Domain Router VM Migration was unsuccessful</programlisting> - <programlisting>CONSOLE_PROXY_MIGRATE = 16 // Console Proxy VM Migration was unsuccessful</programlisting> - <programlisting>USERVM_MIGRATE = 17 // User VM Migration was unsuccessful</programlisting> - <programlisting>VLAN = 18 // Number of unallocated VLANs is below configured threshold in availability zone</programlisting> - <programlisting>SSVM = 19 // SSVM stopped unexpectedly</programlisting> - <programlisting>USAGE_SERVER_RESULT = 20 // Usage job failed</programlisting> - <programlisting>STORAGE_DELETE = 21 // Failed to delete storage pool</programlisting> - <programlisting>UPDATE_RESOURCE_COUNT = 22 // Failed to update the resource count</programlisting> - <programlisting>USAGE_SANITY_RESULT = 23 // Usage Sanity Check failed</programlisting> - <programlisting>DIRECT_ATTACHED_PUBLIC_IP = 24 // Number of unallocated shared network IPs is low in availability zone</programlisting> - <programlisting>LOCAL_STORAGE = 25 // Remaining unallocated Local Storage is below configured threshold</programlisting> - <programlisting>RESOURCE_LIMIT_EXCEEDED = 26 //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only</programlisting> -</appendix> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/api-calls.xml ---------------------------------------------------------------------- diff --git a/en-US/api-calls.xml b/en-US/api-calls.xml deleted file mode 100644 index af4073a..0000000 --- a/en-US/api-calls.xml +++ /dev/null @@ -1,33 +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="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="signing-api-requests.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="api-throttling.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"; /> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/api-overview.xml ---------------------------------------------------------------------- diff --git a/en-US/api-overview.xml b/en-US/api-overview.xml deleted file mode 100644 index 347e39e..0000000 --- a/en-US/api-overview.xml +++ /dev/null @@ -1,37 +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="api-overview"> - <title>&PRODUCT; API</title> - <para>The &PRODUCT; API is a low level API that has been used to implement the &PRODUCT; web UIs. - It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF - standards.</para> - <para>Many &PRODUCT; API calls are asynchronous. These will return a Job ID immediately when - called. This Job ID can be used to query the status of the job later. Also, status calls on - impacted resources will provide some indication of their state.</para> - <para>The API has a REST-like query basis and returns results in XML or JSON.</para> - <para>See <ulink - url="http://docs.cloudstack.org/CloudStack_Documentation/Developer's_Guide%3A_CloudStack">the - Developerâs Guide</ulink> and <ulink - url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack";>the API - Reference</ulink>.</para> - <xi:include href="provisioning-auth-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="user-data-and-meta-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/api-reference.xml ---------------------------------------------------------------------- diff --git a/en-US/api-reference.xml b/en-US/api-reference.xml deleted file mode 100644 index 9a1acc1..0000000 --- a/en-US/api-reference.xml +++ /dev/null @@ -1,24 +0,0 @@ -<!-- 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="api-reference"> - <title>API Reference Documentation</title> - <para>You can find all the API reference documentation at the below site:</para> - <para><ulink url="http://cloudstack.apache.org/docs/api/";>http://cloudstack.apache.org/docs/api/</ulink></para> - </section> - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/api-throttling.xml ---------------------------------------------------------------------- diff --git a/en-US/api-throttling.xml b/en-US/api-throttling.xml deleted file mode 100644 index 908e223..0000000 --- a/en-US/api-throttling.xml +++ /dev/null @@ -1,67 +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="api-throttling"> - <title>Limiting the Rate of API Requests</title> - <para>You can limit the rate at which API requests can be placed for each - account. This is useful to avoid malicious attacks on the Management Server, prevent - performance degradation, and provide fairness to all accounts.</para> - <para>If the number of API calls exceeds the threshold, an error message is returned for any additional API calls. - The caller will have to retry these API calls at another time.</para> - <section id="api-throttling-configure"> - <title>Configuring the API Request Rate</title> - <para>To control the API request rate, use the following global configuration - settings:</para> - <itemizedlist> - <listitem><para>api.throttling.enabled - Enable/Disable API throttling. By default, this setting is false, so - API throttling is not enabled.</para></listitem> - <listitem><para>api.throttling.interval (in seconds) - Time interval during which the number of API requests is to be counted. - When the interval has passed, the API count is reset to 0.</para></listitem> - <listitem><para>api.throttling.max - Maximum number of APIs that can be placed within the api.throttling.interval period.</para></listitem> - <listitem><para>api.throttling.cachesize - Cache size for storing API counters. - Use a value higher than the total number of accounts managed by the cloud. - One cache entry is needed for each account, to store the running API total for that account. - </para></listitem> - </itemizedlist> - </section> - <section id="api-throttling-limitations"> - <title>Limitations on API Throttling</title> - <para>The following limitations exist in the current implementation of this feature.</para> - <note><para>Even with these limitations, &PRODUCT; is still able to effectively use API throttling to - avoid malicious attacks causing denial of service.</para></note> - <para/> - <itemizedlist> - <listitem><para>In a deployment with multiple Management Servers, - the cache is not synchronized across them. - In this case, &PRODUCT; might not be able to - ensure that only the exact desired number of API requests are allowed. - In the worst case, the number of API calls that might be allowed is - (number of Management Servers) * (api.throttling.max). - </para></listitem> - <listitem><para>The API commands resetApiLimit and getApiLimit are limited to the - Management Server where the API is invoked. - </para></listitem> - </itemizedlist> - </section> -</section> \ No newline at end of file
