You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ed...@apache.org on 2013/10/11 03:01:31 UTC
[28/67] [abbrv] [partial] Removing docs from master
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/multi_node_overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multi_node_overview.xml b/docs/en-US/multi_node_overview.xml
deleted file mode 100644
index 1eee037..0000000
--- a/docs/en-US/multi_node_overview.xml
+++ /dev/null
@@ -1,43 +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="multi_node_installation_overview">
- <title>Management Server Multi-Node Installation Overview</title>
- <para>
- This section describes installing multiple Management Servers and installing MySQL on a node separate from the Management Servers. The machines must meet the system requirements described in System Requirements.
- </para>
- <warning><para>For the sake of security, be sure the public Internet can not access port 8096 or port 8250 on the Management Server.</para></warning>
- <para>
- The procedure for a multi-node installation is:
- </para>
- <orderedlist>
- <listitem><para>Prepare the Operating System</para></listitem>
- <listitem><para>Install the First Management Server</para></listitem>
- <listitem><para>Install and Configure the Database</para></listitem>
- <listitem><para>Prepare NFS Shares</para></listitem>
- <listitem><para>Prepare and Start Additional Management Servers</para></listitem>
- <listitem><para>Prepare the System VM Template</para></listitem>
- </orderedlist>
- </section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/multi_site_deployment.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multi_site_deployment.xml b/docs/en-US/multi_site_deployment.xml
deleted file mode 100644
index 8ad94aa..0000000
--- a/docs/en-US/multi_site_deployment.xml
+++ /dev/null
@@ -1,50 +0,0 @@
-<!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="multi_site_deployment">
- <title>Multi-Site Deployment</title>
- <para>The &PRODUCT; platform scales well into multiple sites through the use of zones. The following diagram shows an example of a multi-site deployment.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/multi-site-deployment.png" />
- </imageobject>
- <textobject><phrase>Example Of A Multi-Site Deployment</phrase></textobject>
- </mediaobject>
- <para>Data Center 1 houses the primary Management Server as well as zone 1. The MySQL database is replicated in real time to the secondary Management Server installation in Data Center 2.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/separate-storage-network.png" />
- </imageobject>
- <textobject><phrase>Separate Storage Network</phrase></textobject>
- </mediaobject>
- <para>This diagram illustrates a setup with a separate storage network. Each server has four NICs, two connected to pod-level network switches and two connected to storage network switches.</para>
- <para>There are two ways to configure the storage network:</para>
- <itemizedlist>
- <listitem><para> Bonded NIC and redundant switches can be deployed for NFS. In NFS deployments, redundant switches and bonded NICs still result in one network (one CIDR block+ default gateway address).</para></listitem>
- <listitem><para> iSCSI can take advantage of two separate storage networks (two CIDR blocks each with its own default gateway). Multipath iSCSI client can failover and load balance between separate storage networks.</para></listitem>
- </itemizedlist>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/nic-bonding-and-multipath-io.png" />
- </imageobject>
- <textobject><phrase>NIC Bonding And Multipath I/O</phrase></textobject>
- </mediaobject>
- <para> This diagram illustrates the differences between NIC bonding and Multipath I/O (MPIO). NIC bonding configuration involves only one network. MPIO involves two separate networks.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/multiple-ip-nic.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multiple-ip-nic.xml b/docs/en-US/multiple-ip-nic.xml
deleted file mode 100644
index 344dc8d..0000000
--- a/docs/en-US/multiple-ip-nic.xml
+++ /dev/null
@@ -1,95 +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="multiple-ip-nic">
- <title>Configuring Multiple IP Addresses on a Single NIC</title>
- <para>&PRODUCT; provides you the ability to associate multiple private IP addresses per guest VM
- NIC. In addition to the primary IP, you can assign additional IPs to the guest VM NIC. This
- feature is supported on all the network configurations—Basic, Advanced, and VPC. Security
- Groups, Static NAT and Port forwarding services are supported on these additional IPs. </para>
- <para>As always, you can specify an IP from the guest subnet; if not specified, an IP is
- automatically picked up from the guest VM subnet. You can view the IPs associated with for each
- guest VM NICs on the UI. You can apply NAT on these additional guest IPs by using network
- configuration option in the &PRODUCT; UI. You must specify the NIC to which the IP should be
- associated.</para>
- <para>This feature is supported on XenServer, KVM, and VMware hypervisors. Note that Basic zone
- security groups are not supported on VMware.</para>
- <section id="usecases-mip">
- <title>Use Cases</title>
- <para>Some of the use cases are described below:</para>
- <itemizedlist>
- <listitem>
- <para>Network devices, such as firewalls and load balancers, generally work best when they
- have access to multiple IP addresses on the network interface.</para>
- </listitem>
- <listitem>
- <para>Moving private IP addresses between interfaces or instances. Applications that are
- bound to specific IP addresses can be moved between instances. </para>
- </listitem>
- <listitem>
- <para>Hosting multiple SSL Websites on a single instance. You can install multiple SSL
- certificates on a single instance, each associated with a distinct IP address.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="guideline-nic">
- <title>Guidelines</title>
- <para>To prevent IP conflict, configure different subnets when multiple networks are connected
- to the same VM.</para>
- </section>
- <section id="workflow-rn">
- <title>Assigning Additional IPs to a VM</title>
- <orderedlist>
- <listitem>
- <para>Log in to the &PRODUCT; UI.</para>
- </listitem>
- <listitem>
- <para>In the left navigation bar, click Instances.</para>
- </listitem>
- <listitem>
- <para>Click the name of the instance you want to work with.</para>
- </listitem>
- <listitem>
- <para>In the Details tab, click NICs.</para>
- </listitem>
- <listitem>
- <para>Click View Secondary IPs.</para>
- </listitem>
- <listitem>
- <para>Click Acquire New Secondary IP, and click Yes in the confirmation dialog.</para>
- <para>You need to configure the IP on the guest VM NIC manually. &PRODUCT; will not
- automatically configure the acquired IP address on the VM. Ensure that the IP address
- configuration persist on VM reboot.</para>
- <para>Within a few moments, the new IP address should appear with the state Allocated. You
- can now use the IP address in Port Forwarding or StaticNAT rules.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="caveats">
- <title>Port Forwarding and StaticNAT Services Changes</title>
- <para>Because multiple IPs can be associated per NIC, you are allowed to select a desired IP for
- the Port Forwarding and StaticNAT services. The default is the primary IP. To enable this
- functionality, an extra optional parameter 'vmguestip' is added to the Port forwarding and
- StaticNAT APIs (enableStaticNat, createIpForwardingRule) to indicate on what IP address NAT
- need to be configured. If vmguestip is passed, NAT is configured on the specified private IP
- of the VM. if not passed, NAT is configured on the primary IP of the VM.</para>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/multiple-ip-range.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multiple-ip-range.xml b/docs/en-US/multiple-ip-range.xml
deleted file mode 100644
index 42e0c2a..0000000
--- a/docs/en-US/multiple-ip-range.xml
+++ /dev/null
@@ -1,42 +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="multiple-ip-range">
- <title>About Multiple IP Ranges</title>
- <note>
- <para>The feature can only be implemented on IPv4 addresses.</para>
- </note>
- <para>&PRODUCT; provides you with the flexibility to add guest IP ranges from different subnets in
- Basic zones and security groups-enabled Advanced zones. For security groups-enabled Advanced
- zones, it implies multiple subnets can be added to the same VLAN. With the addition of this
- feature, you will be able to add IP address ranges from the same subnet or from a different one
- when IP address are exhausted. This would in turn allows you to employ higher number of subnets
- and thus reduce the address management overhead. To support this feature, the capability of
- <code>createVlanIpRange</code> API is extended to add IP ranges also from a different
- subnet.</para>
- <para>Ensure that you manually configure the gateway of the new subnet before adding the IP range.
- Note that &PRODUCT; supports only one gateway for a subnet; overlapping subnets are not
- currently supported.</para>
- <para>Use the <code>deleteVlanRange</code> API to delete IP ranges. This operation fails if an IP
- from the remove range is in use. If the remove range contains the IP address on which the DHCP
- server is running, &PRODUCT; acquires a new IP from the same subnet. If no IP is available in
- the subnet, the remove operation fails.</para>
- <para>This feature is supported on KVM, xenServer, and VMware hypervisors.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/multiple-system-vm-vmware.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multiple-system-vm-vmware.xml b/docs/en-US/multiple-system-vm-vmware.xml
deleted file mode 100644
index 014dfa1..0000000
--- a/docs/en-US/multiple-system-vm-vmware.xml
+++ /dev/null
@@ -1,28 +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="multiple-system-vm-vmware">
- <title>Multiple System VM Support for VMware</title>
- <para>Every &PRODUCT; zone has single System VM for template processing tasks such as downloading templates, uploading templates, and uploading ISOs. In a zone where VMware is being used, additional System VMs can be launched to process VMware-specific tasks such as taking snapshots and creating private templates. The &PRODUCT; management server launches additional System VMs for VMware-specific tasks as the load increases. The management server monitors and weights all commands sent to these System VMs and performs dynamic load balancing and scaling-up of more System VMs.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/network-offering-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/network-offering-usage-record-format.xml b/docs/en-US/network-offering-usage-record-format.xml
deleted file mode 100644
index a1b0da9..0000000
--- a/docs/en-US/network-offering-usage-record-format.xml
+++ /dev/null
@@ -1,43 +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="network-offering-usage-record-format">
- <title>Network Offering Usage Record Format</title>
- <itemizedlist>
- <listitem><para>account – name of the account</para></listitem>
- <listitem><para>accountid – ID of the account</para></listitem>
- <listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
- <listitem><para>zoneid – Zone where the usage occurred</para></listitem>
- <listitem><para>description – A string describing what the usage record is tracking</para></listitem>
- <listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
- <listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
- <listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
- <listitem><para>usageid – ID of the network offering</para></listitem>
- <listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
- <listitem><para>offeringid – Network offering ID</para></listitem>
- <listitem><para>virtualMachineId – The ID of the virtual machine</para></listitem>
- <listitem><para>virtualMachineId – The ID of the virtual machine</para></listitem>
- <listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/network-offerings.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/network-offerings.xml b/docs/en-US/network-offerings.xml
deleted file mode 100644
index 8c685bf..0000000
--- a/docs/en-US/network-offerings.xml
+++ /dev/null
@@ -1,87 +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="network-offerings">
- <title>Network Offerings</title>
- <note>
- <para>For the most up-to-date list of supported network services, see the &PRODUCT; UI or call
- listNetworkServices.</para>
- </note>
- <para>A network offering is a named set of network services, such as:</para>
- <itemizedlist>
- <listitem>
- <para>DHCP</para>
- </listitem>
- <listitem>
- <para>DNS</para>
- </listitem>
- <listitem>
- <para>Source NAT</para>
- </listitem>
- <listitem>
- <para>Static NAT</para>
- </listitem>
- <listitem>
- <para>Port Forwarding</para>
- </listitem>
- <listitem>
- <para>Load Balancing</para>
- </listitem>
- <listitem>
- <para>Firewall</para>
- </listitem>
- <listitem>
- <para>VPN</para>
- </listitem>
- <listitem>
- <para>(Optional) Name one of several available providers to use for a given service, such as
- Juniper for the firewall</para>
- </listitem>
- <listitem>
- <para>(Optional) Network tag to specify which physical network to use</para>
- </listitem>
- </itemizedlist>
- <para>When creating a new VM, the user chooses one of the available network offerings, and that
- determines which network services the VM can use.</para>
- <para>The &PRODUCT; administrator can create any number of custom network offerings, in addition
- to the default network offerings provided by &PRODUCT;. By creating multiple custom network
- offerings, you can set up your cloud to offer different classes of service on a single
- multi-tenant physical network. For example, while the underlying physical wiring may be the same
- for two tenants, tenant A may only need simple firewall protection for their website, while
- tenant B may be running a web server farm and require a scalable firewall solution, load
- balancing solution, and alternate networks for accessing the database backend.</para>
- <note>
- <para>If you create load balancing rules while using a network service offering that includes an
- external load balancer device such as NetScaler, and later change the network service offering
- to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual
- router for each of your existing load balancing rules so that they continue to
- function.</para>
- </note>
- <para>When creating a new virtual network, the &PRODUCT; administrator chooses which network
- offering to enable for that network. Each virtual network is associated with one network
- offering. A virtual network can be upgraded or downgraded by changing its associated network
- offering. If you do this, be sure to reprogram the physical network to match.</para>
- <para>&PRODUCT; also has internal network offerings for use by &PRODUCT; system VMs. These network
- offerings are not visible to users but can be modified by administrators.</para>
- <xi:include href="creating-network-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/network-rate.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/network-rate.xml b/docs/en-US/network-rate.xml
deleted file mode 100644
index 56fe25c..0000000
--- a/docs/en-US/network-rate.xml
+++ /dev/null
@@ -1,144 +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="network-rate">
- <title>Network Throttling</title>
- <para>Network throttling is the process of controlling the network access and bandwidth usage
- based on certain rules. &PRODUCT; controls this behaviour of the guest networks in the cloud by
- using the network rate parameter. This parameter is defined as the default data transfer rate in
- Mbps (Megabits Per Second) allowed in a guest network. It defines the upper limits for network
- utilization. If the current utilization is below the allowed upper limits, access is granted,
- else revoked.</para>
- <para>You can throttle the network bandwidth either to control the usage above a certain limit for
- some accounts, or to control network congestion in a large cloud environment. The network rate
- for your cloud can be configured on the following:</para>
- <itemizedlist>
- <listitem>
- <para>Network Offering</para>
- </listitem>
- <listitem>
- <para>Service Offering</para>
- </listitem>
- <listitem>
- <para>Global parameter</para>
- </listitem>
- </itemizedlist>
- <para>If network rate is set to NULL in service offering, the value provided in the
- vm.network.throttling.rate global parameter is applied. If the value is set to NULL for network
- offering, the value provided in the network.throttling.rate global parameter is
- considered.</para>
- <para>For the default public, storage, and management networks, network rate is set to 0. This
- implies that the public, storage, and management networks will have unlimited bandwidth by
- default. For default guest networks, network rate is set to NULL. In this case, network rate is
- defaulted to the global parameter value.</para>
- <para>The following table gives you an overview of how network rate is applied on different types
- of networks in &PRODUCT;.</para>
- <informaltable>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colwidth="1.0*" colname="1" colnum="1"/>
- <colspec colwidth="3.18*" colname="2" colnum="2"/>
- <thead>
- <row>
- <entry><para>Networks</para></entry>
- <entry><para>Network Rate Is Taken from</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Guest network of Virtual Router</para></entry>
- <entry><para>Guest Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Public network of Virtual Router</para></entry>
- <entry><para>Guest Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Storage network of Secondary Storage VM</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Management network of Secondary Storage VM</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Storage network of Console Proxy VM</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Management network of Console Proxy VM</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Storage network of Virtual Router</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Management network of Virtual Router</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Public network of Secondary Storage VM</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Public network of Console Proxy VM</para></entry>
- <entry><para>System Network Offering</para></entry>
- </row>
- <row>
- <entry><para>Default network of a guest VM</para></entry>
- <entry><para>Compute Offering</para></entry>
- </row>
- <row>
- <entry><para>Additional networks of a guest VM</para></entry>
- <entry><para>Corresponding Network Offerings</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <para>A guest VM must have a default network, and can also have many additional networks.
- Depending on various parameters, such as the host and virtual switch used, you can observe a
- difference in the network rate in your cloud. For example, on a VMware host the actual network
- rate varies based on where they are configured (compute offering, network offering, or both);
- the network type (shared or isolated); and traffic direction (ingress or egress). </para>
- <para>The network rate set for a network offering used by a particular network in &PRODUCT; is
- used for the traffic shaping policy of a port group, for example: port group A, for that
- network: a particular subnet or VLAN on the actual network. The virtual routers for that network
- connects to the port group A, and by default instances in that network connects to this port
- group. However, if an instance is deployed with a compute offering with the network rate set,
- and if this rate is used for the traffic shaping policy of another port group for the network,
- for example port group B, then instances using this compute offering are connected to the port
- group B, instead of connecting to port group A.</para>
- <para>The traffic shaping policy on standard port groups in VMware only applies to the egress
- traffic, and the net effect depends on the type of network used in &PRODUCT;. In shared
- networks, ingress traffic is unlimited for &PRODUCT;, and egress traffic is limited to the rate
- that applies to the port group used by the instance if any. If the compute offering has a
- network rate configured, this rate applies to the egress traffic, otherwise the network rate set
- for the network offering applies. For isolated networks, the network rate set for the network
- offering, if any, effectively applies to the ingress traffic. This is mainly because the network
- rate set for the network offering applies to the egress traffic from the virtual router to the
- instance. The egress traffic is limited by the rate that applies to the port group used by the
- instance if any, similar to shared networks. </para>
- <para>For example:</para>
- <para>Network rate of network offering = 10 Mbps</para>
- <para>Network rate of compute offering = 200 Mbps</para>
- <para>In shared networks, ingress traffic will not be limited for &PRODUCT;, while egress traffic
- will be limited to 200 Mbps. In an isolated network, ingress traffic will be limited to 10 Mbps
- and egress to 200 Mbps.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/network-service-providers.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/network-service-providers.xml b/docs/en-US/network-service-providers.xml
deleted file mode 100644
index 32f36ae..0000000
--- a/docs/en-US/network-service-providers.xml
+++ /dev/null
@@ -1,151 +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="network-service-providers">
- <title>Network Service Providers</title>
- <note>
- <para>For the most up-to-date list of supported network service providers, see the &PRODUCT; UI
- or call listNetworkServiceProviders.</para>
- </note>
- <para>A service provider (also called a network element) is hardware or virtual appliance that
- makes a network service possible; for example, a firewall appliance can be installed in the
- cloud to provide firewall service. On a single network, multiple providers can provide the same
- network service. For example, a firewall service may be provided by Cisco or Juniper devices in
- the same physical network.</para>
- <para>You can have multiple instances of the same service provider in a network (say, more than
- one Juniper SRX device).</para>
- <para>If different providers are set up to provide the same service on the network, the
- administrator can create network offerings so users can specify which network service provider
- they prefer (along with the other choices offered in network offerings). Otherwise, &PRODUCT;
- will choose which provider to use whenever the service is called for. </para>
- <formalpara>
- <title>Supported Network Service Providers</title>
- <para>&PRODUCT; ships with an internal list of the supported service providers, and you can
- choose from this list when creating a network offering.</para>
- </formalpara>
- <informaltable>
- <tgroup cols="7" align="left" colsep="1" rowsep="1">
- <colspec colnum="1" colname="c1" colwidth="1.64*"/>
- <colspec colnum="2" colname="c2" colwidth="1.48*"/>
- <colspec colnum="3" colname="c3" colwidth="1.11*"/>
- <colspec colnum="4" colname="c4" colwidth="1.0*"/>
- <colspec colnum="5" colname="c5" colwidth="1.2*"/>
- <colspec colnum="6" colname="c6" colwidth="2.45*"/>
- <colspec colnum="7" colname="c6" colwidth="3.39*"/>
- <thead>
- <row>
- <entry/>
- <entry><para>Virtual Router</para></entry>
- <entry><para>Citrix NetScaler</para></entry>
- <entry><para>Juniper SRX</para></entry>
- <entry><para>F5 BigIP</para></entry>
- <entry><para>Host based (KVM/Xen)</para></entry>
- <entry><para>Cisco VNMC</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Remote Access VPN</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- </row>
- <row>
- <entry><para>DNS/DHCP/User Data</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- </row>
- <row>
- <entry><para>Firewall</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry>Yes</entry>
- </row>
- <row>
- <entry><para>Load Balancing</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry>No</entry>
- </row>
- <row>
- <entry><para>Elastic IP</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- </row>
- <row>
- <entry><para>Elastic LB</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- </row>
- <row>
- <entry><para>Source NAT</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- </row>
- <row>
- <entry><para>Static NAT</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- </row>
- <row>
- <entry><para>Port Forwarding</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>No</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/network-setup.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/network-setup.xml b/docs/en-US/network-setup.xml
deleted file mode 100644
index ceee190..0000000
--- a/docs/en-US/network-setup.xml
+++ /dev/null
@@ -1,35 +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="network-setup">
- <title>Network Setup</title>
- <para>Achieving the correct networking setup is crucial to a successful &PRODUCT;
- installation. This section contains information to help you make decisions and follow the right
- procedures to get your network set up correctly.</para>
- <xi:include href="basic-adv-networking.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="vlan-allocation-eg.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="hardware-config-eg.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="layer2-switch.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="hardware-firewall.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="management-server-lb.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="guest-nw-usage-with-traffic-sentinel.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="set-zone-vlan-run-vm-max.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- </chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/network-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/network-usage-record-format.xml b/docs/en-US/network-usage-record-format.xml
deleted file mode 100644
index 34b8f2d..0000000
--- a/docs/en-US/network-usage-record-format.xml
+++ /dev/null
@@ -1,40 +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="network-usage-record-format">
- <title>Network Usage Record Format</title>
- <para>For network usage (bytes sent/received), the following fields exist in a usage record.</para>
- <itemizedlist>
- <listitem><para>account – name of the account</para></listitem>
- <listitem><para>accountid – ID of the account</para></listitem>
- <listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
- <listitem><para>zoneid – Zone where the usage occurred</para></listitem>
- <listitem><para>description – A string describing what the usage record is tracking</para></listitem>
- <listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
- <listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
- <listitem><para>usageid – Device ID (virtual router ID or external device ID)</para></listitem>
- <listitem><para>type – Device type (domain router, external load balancer, etc.)</para></listitem>
- <listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/networking-in-a-pod.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networking-in-a-pod.xml b/docs/en-US/networking-in-a-pod.xml
deleted file mode 100644
index 5a569bf..0000000
--- a/docs/en-US/networking-in-a-pod.xml
+++ /dev/null
@@ -1,46 +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="networking-in-a-pod">
- <title>Networking in a Pod</title>
- <para>The figure below illustrates network setup within a single pod. The hosts are connected to a
- pod-level switch. At a minimum, the hosts should have one physical uplink to each switch.
- Bonded NICs are supported as well. The pod-level switch is a pair of redundant gigabit
- switches with 10 G uplinks.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/network-singlepod.png" />
- </imageobject>
- <textobject>
- <phrase>networksinglepod.png: diagram showing logical view of network in a pod</phrase>
- </textobject>
- </mediaobject>
- <para>Servers are connected as follows:</para>
- <itemizedlist>
- <listitem><para>Storage devices are connected to only the network that carries management traffic.</para></listitem>
- <listitem><para>Hosts are connected to networks for both management traffic and public traffic. </para></listitem>
- <listitem><para>Hosts are also connected to one or more networks carrying guest traffic.</para></listitem>
- </itemizedlist>
- <para>We recommend the use of multiple physical Ethernet cards to implement each network interface as well as redundant switch fabric in order to maximize throughput and improve reliability.</para>
-
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/networking-in-a-zone.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networking-in-a-zone.xml b/docs/en-US/networking-in-a-zone.xml
deleted file mode 100644
index e50efba..0000000
--- a/docs/en-US/networking-in-a-zone.xml
+++ /dev/null
@@ -1,38 +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="networking-in-a-zone">
- <title>Networking in a Zone</title>
- <para>The following figure illustrates the network setup within a single zone.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/network-setup-zone.png" />
- </imageobject>
- <textobject>
- <phrase>networksetupzone.png: Depicts network setup in a single zone</phrase>
- </textobject>
- </mediaobject>
- <para>A firewall for management traffic operates in the NAT mode. The network typically is assigned IP addresses in the 192.168.0.0/16 Class B private address space. Each pod is assigned IP addresses in the 192.168.*.0/24 Class C private address space.</para>
- <para>Each zone has its own set of public IP addresses. Public IP addresses from different zones do not overlap.</para>
-
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/networking-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networking-overview.xml b/docs/en-US/networking-overview.xml
deleted file mode 100644
index a71fe95..0000000
--- a/docs/en-US/networking-overview.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="networking-overview">
- <title>Networking Overview</title>
- <para>&PRODUCT; offers two types of networking scenario:
- </para>
- <itemizedlist>
- <listitem><para>Basic. For AWS-style networking. Provides a single network where guest isolation can be provided through layer-3 means such as security groups (IP address source filtering).</para></listitem>
- <listitem><para>Advanced. For more sophisticated network topologies. This network model provides the most flexibility in defining guest networks.</para></listitem>
- </itemizedlist>
- <para>For more details, see Network Setup.</para>
- </section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/networking_overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networking_overview.xml b/docs/en-US/networking_overview.xml
deleted file mode 100644
index a5f27c3..0000000
--- a/docs/en-US/networking_overview.xml
+++ /dev/null
@@ -1,36 +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="networking_overview">
- <title>Networking Overview</title>
- <para>
- CloudStack offers two types of networking scenario:
- </para>
- <itemizedlist>
- <listitem><para>Basic. For AWS-style networking. Provides a single network where guest isolation can be provided through layer-3 means such as security groups (IP address source filtering).</para></listitem>
- <listitem><para>Advanced. For more sophisticated network topologies. This network model provides the most flexibility in defining guest networks.</para></listitem>
- </itemizedlist>
- <para>For more details, see Network Setup.</para>
-</section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/networks-for-users-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networks-for-users-overview.xml b/docs/en-US/networks-for-users-overview.xml
deleted file mode 100644
index 19602c4..0000000
--- a/docs/en-US/networks-for-users-overview.xml
+++ /dev/null
@@ -1,35 +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="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>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/networks.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml
deleted file mode 100644
index b28f985..0000000
--- a/docs/en-US/networks.xml
+++ /dev/null
@@ -1,58 +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="networks">
- <title>Managing Networks and Traffic</title>
- <para>In a &PRODUCT;, guest VMs can communicate with each other using shared infrastructure with
- the security and user perception that the guests have a private LAN. The &PRODUCT; virtual
- router is the main component providing networking features for guest traffic. </para>
- <xi:include href="guest-traffic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="networking-in-a-pod.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="networking-in-a-zone.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="basic-zone-physical-network-configuration.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="advanced-zone-physical-network-configuration.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="reserved-ip-addresses-non-csvms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="ip-vlan-tenant.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="multiple-ip-nic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="multiple-ip-range.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="elastic-ip.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="portable-ip.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="add-ip-range.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="pvlan.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="external-firewalls-and-load-balancers.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="gslb.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="ip-forwarding-firewalling.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="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"/>
- <xi:include href="persistent-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/nfs-shares-on-management-server.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/nfs-shares-on-management-server.xml b/docs/en-US/nfs-shares-on-management-server.xml
deleted file mode 100644
index 881ca8d..0000000
--- a/docs/en-US/nfs-shares-on-management-server.xml
+++ /dev/null
@@ -1,117 +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.
--->
-
-<section id="nfs-shares-on-management-server">
- <title>Using the Management Server as the NFS Server</title>
- <para>This section tells how to set up NFS shares for primary and secondary storage on the same node with the Management Server. This is more typical of a trial installation, but is technically possible in a larger deployment. It is assumed that you will have less than 16TB of storage on the host.</para>
- <para>The exact commands for the following steps may vary depending on your operating system version.</para>
- <orderedlist>
- <listitem><para>On RHEL/CentOS systems, you'll need to install the nfs-utils package:</para>
- <programlisting>
-$ sudo yum install nfs-utils
- </programlisting>
- </listitem>
- <listitem><para>On the Management Server host, create two directories that you will use for primary and secondary storage. For example:</para>
- <programlisting>
-# mkdir -p /export/primary
-# mkdir -p /export/secondary
- </programlisting>
- </listitem>
- <listitem><para>To configure the new directories as NFS exports, edit /etc/exports. Export the NFS share(s) with rw,async,no_root_squash. For example:</para>
- <programlisting># vi /etc/exports</programlisting>
- <para>Insert the following line.</para>
- <programlisting>/export *(rw,async,no_root_squash)</programlisting>
- </listitem>
- <listitem><para>Export the /export directory.</para>
- <programlisting># exportfs -a</programlisting>
- </listitem>
- <listitem><para>Edit the /etc/sysconfig/nfs file.</para>
- <programlisting># vi /etc/sysconfig/nfs</programlisting>
- <para>Uncomment the following lines:</para>
- <programlisting>
-LOCKD_TCPPORT=32803
-LOCKD_UDPPORT=32769
-MOUNTD_PORT=892
-RQUOTAD_PORT=875
-STATD_PORT=662
-STATD_OUTGOING_PORT=2020
- </programlisting>
- </listitem>
- <listitem><para>Edit the /etc/sysconfig/iptables file.</para>
- <programlisting># vi /etc/sysconfig/iptables</programlisting>
- <para>Add the following lines at the beginning of the INPUT chain where <NETWORK> is the network that you'll be using:</para>
- <programlisting>
--A INPUT -s <NETWORK> -m state --state NEW -p udp --dport 111 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p tcp --dport 111 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p tcp --dport 2049 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p tcp --dport 32803 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p udp --dport 32769 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p tcp --dport 892 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p udp --dport 892 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p tcp --dport 875 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p udp --dport 875 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p tcp --dport 662 -j ACCEPT
--A INPUT -s <NETWORK> -m state --state NEW -p udp --dport 662 -j ACCEPT
- </programlisting>
- </listitem>
- <listitem><para>Run the following commands:</para>
- <programlisting>
-# service iptables restart
-# service iptables save
- </programlisting>
- </listitem>
- <listitem><para>If NFS v4 communication is used between client and server, add your domain to /etc/idmapd.conf on both the hypervisor host and Management Server.</para>
- <programlisting># vi /etc/idmapd.conf</programlisting>
- <para>Remove the character # from the beginning of the Domain line in idmapd.conf and replace the value in the file with your own domain. In the example below, the domain is company.com.</para>
- <programlisting>Domain = company.com</programlisting>
- </listitem>
- <listitem><para>Reboot the Management Server host.</para>
- <para>Two NFS shares called /export/primary and /export/secondary are now set up.</para>
- </listitem>
- <listitem><para>It is recommended that you test to be sure the previous steps have been successful.</para>
- <orderedlist numeration="loweralpha">
- <listitem><para>Log in to the hypervisor host.</para></listitem>
- <listitem><para>Be sure NFS and rpcbind are running. The commands might be different depending on your OS. For example:</para>
- <programlisting>
-# service rpcbind start
-# service nfs start
-# chkconfig nfs on
-# chkconfig rpcbind on
-# reboot
- </programlisting>
- </listitem>
- <listitem><para>Log back in to the hypervisor host and try to mount the /export directories. For example (substitute your own management server name):</para>
- <programlisting>
-# mkdir /primarymount
-# mount -t nfs <management-server-name>:/export/primary /primarymount
-# umount /primarymount
-# mkdir /secondarymount
-# mount -t nfs <management-server-name>:/export/secondary /secondarymount
-# umount /secondarymount
- </programlisting>
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/nfs-shares-on-separate-server.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/nfs-shares-on-separate-server.xml b/docs/en-US/nfs-shares-on-separate-server.xml
deleted file mode 100644
index 947106d..0000000
--- a/docs/en-US/nfs-shares-on-separate-server.xml
+++ /dev/null
@@ -1,52 +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="nfs-shares-on-separate-server">
- <title>Using a Separate NFS Server</title>
- <para>This section tells how to set up NFS shares for secondary and (optionally) primary storage on an NFS server running on a separate node from the Management Server.</para>
- <para>The exact commands for the following steps may vary depending on your operating system version.</para>
- <warning><para>(KVM only) Ensure that no volume is already mounted at your NFS mount point.</para></warning>
- <orderedlist>
- <listitem><para>On the storage server, create an NFS share for secondary storage and, if you are using NFS for primary storage as well, create a second NFS share. For example:</para>
- <programlisting>
-# mkdir -p /export/primary
-# mkdir -p /export/secondary
- </programlisting>
- </listitem>
- <listitem><para>To configure the new directories as NFS exports, edit /etc/exports. Export the NFS share(s) with rw,async,no_root_squash. For example:</para>
- <programlisting># vi /etc/exports</programlisting>
- <para>Insert the following line.</para>
- <programlisting>/export *(rw,async,no_root_squash)</programlisting>
- </listitem>
- <listitem><para>Export the /export directory.</para>
- <programlisting># exportfs -a</programlisting>
- </listitem>
- <listitem><para>On the management server, create a mount point for secondary storage. For example:</para>
- <programlisting># mkdir -p /mnt/secondary</programlisting>
- </listitem>
- <listitem><para>Mount the secondary storage on your Management Server. Replace the example NFS server name and NFS share paths below with your own.</para>
- <programlisting># mount -t nfs nfsservername:/nfs/share/secondary /mnt/secondary</programlisting>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/non-contiguous-vlan.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/non-contiguous-vlan.xml b/docs/en-US/non-contiguous-vlan.xml
deleted file mode 100644
index 193b916..0000000
--- a/docs/en-US/non-contiguous-vlan.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="non-contiguous-vlan">
- <title>Adding Non Contiguous VLAN Ranges</title>
- <para>&PRODUCT; provides you with the flexibility to add non contiguous VLAN ranges to your
- network. The administrator can either update an existing VLAN range or add multiple non
- contiguous VLAN ranges while creating a zone. You can also use the UpdatephysicalNetwork API to
- extend the VLAN range.</para>
- <orderedlist>
- <listitem>
- <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
- </listitem>
- <listitem>
- <para>Ensure that the VLAN range does not already exist.</para>
- </listitem>
- <listitem>
- <para>In the left navigation, choose Infrastructure. </para>
- </listitem>
- <listitem>
- <para>On Zones, click View More, then click the zone to which you want to work with.</para>
- </listitem>
- <listitem>
- <para>Click Physical Network.</para>
- </listitem>
- <listitem>
- <para>In the Guest node of the diagram, click Configure.</para>
- </listitem>
- <listitem>
- <para>Click Edit <inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/edit-icon.png"/>
- </imageobject>
- <textobject>
- <phrase>edit-icon.png: button to edit the VLAN range.</phrase>
- </textobject>
- </inlinemediaobject></para>
- <para>The VLAN Ranges field now is editable.</para>
- </listitem>
- <listitem>
- <para>Specify the start and end of the VLAN range in comma-separated list.</para>
- <para>Specify all the VLANs you want to use, VLANs not specified will be removed if you are
- adding new ranges to the existing list. </para>
- </listitem>
- <listitem>
- <para>Click Apply.</para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/offerings.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/offerings.xml b/docs/en-US/offerings.xml
deleted file mode 100644
index c880a9c..0000000
--- a/docs/en-US/offerings.xml
+++ /dev/null
@@ -1,30 +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="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" />
- <xi:include href="network-rate.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="sys-offering-sysvm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/ongoing-config-of-external-firewalls-lb.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ongoing-config-of-external-firewalls-lb.xml b/docs/en-US/ongoing-config-of-external-firewalls-lb.xml
deleted file mode 100644
index f5864da..0000000
--- a/docs/en-US/ongoing-config-of-external-firewalls-lb.xml
+++ /dev/null
@@ -1,46 +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="ongoing-config-of-external-firewalls-ld">
- <title>Ongoing Configuration of External Firewalls and Load Balancers</title>
- <para>Additional user actions (e.g. setting a port forward) will cause further programming of the
- firewall and load balancer. A user may request additional public IP addresses and forward
- traffic received at these IPs to specific VMs. This is accomplished by enabling static NAT for a
- public IP address, assigning the IP to a VM, and specifying a set of protocols and port ranges
- to open. When a static NAT rule is created, &PRODUCT; programs the zone's external firewall with
- the following objects:</para>
- <itemizedlist>
- <listitem>
- <para>A static NAT rule that maps the public IP address to the private IP address of a
- VM.</para>
- </listitem>
- <listitem>
- <para>A security policy that allows traffic within the set of protocols and port ranges that
- are specified.</para>
- </listitem>
- <listitem>
- <para>A firewall filter counter that measures the number of bytes of incoming traffic to the
- public IP.</para>
- </listitem>
- </itemizedlist>
- <para>The number of incoming and outgoing bytes through source NAT, static NAT, and load balancing
- rules is measured and saved on each external element. This data is collected on a regular basis
- and stored in the &PRODUCT; database.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/over-provisioning-service-offering-limits.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/over-provisioning-service-offering-limits.xml b/docs/en-US/over-provisioning-service-offering-limits.xml
deleted file mode 100644
index 5a403a3..0000000
--- a/docs/en-US/over-provisioning-service-offering-limits.xml
+++ /dev/null
@@ -1,161 +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="over-provisioning-service-offering-limits">
- <title>Over-Provisioning and Service Offering Limits</title>
- <para>(Supported for XenServer, KVM, and VMware)</para>
- <para>CPU and memory (RAM) over-provisioning factors can be set for each cluster to change the
- number of VMs that can run on each host in the cluster. This helps optimize the use of
- resources. By increasing the over-provisioning ratio, more resource capacity will be used. If
- the ratio is set to 1, no over-provisioning is done.</para>
- <para>The administrator can also set global default over-provisioning ratios
- in the cpu.overprovisioning.factor and mem.overprovisioning.factor global configuration variables.
- The default value of these variables is 1: over-provisioning is turned off by default.
- </para>
- <para>Over-provisioning ratios are dynamically substituted in &PRODUCT;'s capacity
- calculations. For example: </para>
- <para>Capacity = 2 GB</para>
- <para>Over-provisioning factor = 2</para>
- <para>Capacity after over-provisioning = 4 GB</para>
- <para>With this configuration, suppose you deploy 3 VMs of 1 GB each:</para>
- <para>Used = 3 GB</para>
- <para>Free = 1 GB</para>
- <para>The administrator can specify a memory over-provisioning ratio, and can specify both CPU and
- memory over-provisioning ratios on a per-cluster basis.</para>
- <para>In any given cloud, the optimum number of VMs for each host is affected by such things as
- the hypervisor, storage, and hardware configuration. These may be different for each cluster in
- the same cloud. A single global over-provisioning setting can not provide the best utilization
- for all the different clusters in the cloud. It has to be set for the lowest common denominator.
- The per-cluster setting provides a finer granularity for better utilization of resources, no
- matter where the &PRODUCT; placement algorithm decides to place a VM.</para>
- <para>The overprovisioning settings can be used along with dedicated resources (assigning a
- specific cluster to an account) to effectively offer different levels of service to
- different accounts. For example, an account paying for a more expensive level of service
- could be assigned to a dedicated cluster with an over-provisioning ratio of 1, and a
- lower-paying account to a cluster with a ratio of 2.</para>
- <para>When a new host is added to a cluster, &PRODUCT; will assume the host has the
- capability to perform the CPU and RAM over-provisioning which is configured for that
- cluster. It is up to the administrator to be sure the host is actually suitable for the
- level of over-provisioning which has been set.</para>
- <section id="overcommit-limitations">
- <title>Limitations on Over-Provisioning in XenServer and KVM</title>
- <itemizedlist>
- <listitem><para>In XenServer, due to a constraint of this hypervisor, you can not use an
- over-provisioning factor greater than 4.</para></listitem>
- <listitem><para>The KVM hypervisor can not manage memory allocation to VMs dynamically.
- &PRODUCT; sets the minimum and maximum amount of memory that a VM can use.
- The hypervisor adjusts the memory within the set limits based on the memory contention.</para></listitem>
- </itemizedlist>
- </section>
- <section id="overcommit-prerequisites">
- <title>Requirements for Over-Provisioning</title>
- <para>Several prerequisites are required in order for over-provisioning to function
- properly. The feature is dependent on the OS type, hypervisor capabilities, and certain
- scripts. It is the administrator's responsibility to ensure that these requirements are
- met.</para>
- <section id="balloon-driver">
- <title>Balloon Driver</title>
- <para>All VMs should have a balloon driver installed in them. The hypervisor
- communicates with the balloon driver to free up and make the memory available to a
- VM.</para>
- <formalpara>
- <title>XenServer</title>
- <para>The balloon driver can be found as a part of xen pv or PVHVM drivers. The xen
- pvhvm drivers are included in upstream linux kernels 2.6.36+.</para>
- </formalpara>
- <formalpara>
- <title>VMware</title>
- <para>The balloon driver can be found as a part of the VMware tools. All the VMs that
- are deployed in a over-provisioned cluster should have the VMware tools
- installed.</para>
- </formalpara>
- <formalpara>
- <title>KVM</title>
- <para>All VMs are required to support the virtio drivers. These drivers are installed
- in all Linux kernel versions 2.6.25 and greater. The administrator must set
- CONFIG_VIRTIO_BALLOON=y in the virtio configuration. </para>
- </formalpara>
- </section>
- <section id="memory-ballooning">
- <title>Hypervisor capabilities</title>
- <para>The hypervisor must be capable of using the memory ballooning.</para>
- <formalpara>
- <title>XenServer</title>
- <para>The DMC (Dynamic Memory Control) capability of the hypervisor should be enabled.
- Only XenServer Advanced and above versions have this feature.</para>
- </formalpara>
- <formalpara>
- <title>VMware, KVM</title>
- <para>Memory ballooning is supported by default.</para>
- </formalpara>
- </section>
- </section>
- <section id="create-overcommit">
- <title>Setting Over-Provisioning Ratios</title>
- <para>There are two ways the root admin can set CPU and RAM over-provisioning ratios. First, the
- global configuration settings cpu.overprovisioning.factor and mem.overprovisioning.factor will
- be applied when a new cluster is created. Later, the ratios can be modified for an existing
- cluster.</para>
- <para>Only VMs deployed after the change are affected by the new setting.
- If you want VMs deployed before the change to adopt the new over-provisioning ratio,
- you must stop and restart the VMs.
- When this is done, &PRODUCT; recalculates or scales the used and
- reserved capacities based on the new over-provisioning ratios,
- to ensure that &PRODUCT; is correctly tracking the amount of free capacity.</para>
- <note><para>It is safer not to deploy additional new VMs while the capacity recalculation is underway, in
- case the new values for available capacity are not high enough to accommodate the new VMs.
- Just wait for the new used/available values to become available, to be sure there is room
- for all the new VMs you want.</para></note>
- <para>To change the over-provisioning ratios for an existing cluster:</para>
- <orderedlist>
- <listitem>
- <para>Log in as administrator to the &PRODUCT; UI.</para>
- </listitem>
- <listitem>
- <para>In the left navigation bar, click Infrastructure.</para>
- </listitem>
- <listitem>
- <para>Under Clusters, click View All.</para>
- </listitem>
- <listitem>
- <para>Select the cluster you want to work with, and click the Edit button.</para>
- </listitem>
- <listitem>
- <para>Fill in your desired over-provisioning multipliers in the fields CPU overcommit
- ratio and RAM overcommit ratio. The value which is intially shown in these
- fields is the default value inherited from the global configuration settings.
- </para>
- <note>
- <para>In XenServer, due to a constraint of this hypervisor, you can not use an
- over-provisioning factor greater than 4.</para>
- </note>
- </listitem>
- </orderedlist>
- </section>
- <section id="op-service-offering-limits">
- <title>Service Offering Limits and Over-Provisioning</title>
- <para>Service offering limits (e.g. 1 GHz, 1 core) are strictly enforced for core count. For example, a guest with a service offering of one core will have only one core available to it regardless of other activity on the Host. </para>
- <para>Service offering limits for gigahertz are enforced only in the presence of contention for CPU resources. For example, suppose that a guest was created with a service offering of 1 GHz on a Host that has 2 GHz cores, and that guest is the only guest running on the Host. The guest will have the full 2 GHz available to it. When multiple guests are attempting to use the CPU a weighting factor is used to schedule CPU resources. The weight is based on the clock speed in the service offering. Guests receive a CPU allocation that is proportionate to the GHz in the service offering. For example, a guest created from a 2 GHz service offering will receive twice the CPU allocation as a guest created from a 1 GHz service offering. &PRODUCT; does not perform memory over-provisioning.</para>
- </section>
-</section>
\ No newline at end of file