You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by se...@apache.org on 2014/05/28 19:13:27 UTC
[2/4] fixed the formatting in all the files and added the license to
each file: This closes #4
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/e55976f3/rtd/source/index.rst
----------------------------------------------------------------------
diff --git a/rtd/source/index.rst b/rtd/source/index.rst
index 3972486..398a1f6 100644
--- a/rtd/source/index.rst
+++ b/rtd/source/index.rst
@@ -1,69 +1,97 @@
+.. 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.
+
.. CloudStack Documentation documentation master file, created by
sphinx-quickstart on Sat Nov 2 11:17:30 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
+
Welcome to CloudStack Documentation !
=====================================
.. figure:: /_static/images/acslogo.png
- :align: center
+ :align: center
-.. warning:: We are in the process of changing documentation format as well as hosting mechanism.
- Please be patient with us as we migrate our entire documentation to this new setup.
+.. warning::
+ We are in the process of changing documentation format as well as hosting
+ mechanism. Please be patient with us as we migrate our entire documentation
+ to this new setup.
.. toctree::
+
Introduction
------------
-If you are new to CloudStack you should go through this short introduction on concepts and terminology before proceeding to the installation or administration guides.
+If you are new to CloudStack you should go through this short introduction on
+concepts and terminology before proceeding to the installation or
+administration guides.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 2
+
+ concepts
- concepts
Navigating the docs
-------------------
-Now that you have gone over the basic concepts of CloudStack you are ready to dive into installation and operation documentation.
+Now that you have gone over the basic concepts of CloudStack you are ready to
+dive into installation and operation documentation.
-- `Installation Guide <http://docs.cloudstack.apache.org/projects/cloudstack-installation>`_
+- `Installation Guide
+ <http://docs.cloudstack.apache.org/projects/cloudstack-installation>`_
-- `Administration Guide <http://docs.cloudstack.apache.org/projects/cloudstack-administration>`_
+- `Administration Guide
+ <http://docs.cloudstack.apache.org/projects/cloudstack-administration>`_
-- `Release Notes <http://docs.cloudstack.apache.org/projects/cloudstack-release-notes>`_
+- `Release Notes
+ <http://docs.cloudstack.apache.org/projects/cloudstack-release-notes>`_
-Below you will find very specific documentation on advanced networking_ which you can skip if you are just getting started.
-Developers will also find below a short developers_ guide.
+Below you will find very specific documentation on advanced networking_ which
+you can skip if you are just getting started. Developers will also find below
+a short developers_ guide.
.. _networking:
+
Advanced Networking Guides
--------------------------
.. toctree::
- :maxdepth: 2
+ :maxdepth: 2
- networking/nicira-plugin
- networking/midonet
- networking/vxlan.rst
- networking/ovs-plugin
- networking/ipv6
- networking/autoscale_without_netscaler.rst
+ networking/nicira-plugin
+ networking/midonet
+ networking/vxlan.rst
+ networking/ovs-plugin
+ networking/ipv6
+ networking/autoscale_without_netscaler.rst
.. _developers:
+
Developers Guide
----------------
.. toctree::
- :maxdepth: 2
-
- developer_guide
- dev
- plugins
- alloc.rst
- ansible
+ :maxdepth: 2
+ developer_guide
+ dev
+ plugins
+ alloc.rst
+ ansible
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/e55976f3/rtd/source/networking/autoscale_without_netscaler.rst
----------------------------------------------------------------------
diff --git a/rtd/source/networking/autoscale_without_netscaler.rst b/rtd/source/networking/autoscale_without_netscaler.rst
index 9dbac42..b35eaaf 100644
--- a/rtd/source/networking/autoscale_without_netscaler.rst
+++ b/rtd/source/networking/autoscale_without_netscaler.rst
@@ -1,87 +1,177 @@
+.. 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.
+
+
Configuring AutoScale without using NetScaler
=============================================
-.. warning:: This feature is currently only available on the master branch and will be released in the 4.4 release.
+.. warning::
+ This feature is currently only available on the master branch and will be
+ released in the 4.4 release.
+
What is AutoScaling?
-~~~~~~~~~~~~~~~~~~~~
+--------------------
+
+AutoScaling allows you to scale your back-end services or application VMs up
+or down seamlessly and automatically according to the conditions you define.
+With AutoScaling enabled, you can ensure that the number of VMs you are using
+seamlessly scale up when demand increases, and automatically decreases when
+demand subsides. Thus it helps you save compute costs by terminating underused
+VMs automatically and launching new VMs when you need them, without the need
+for manual intervention.
-AutoScaling allows you to scale your back-end services or application VMs up or down seamlessly and automatically according to the conditions you define. With AutoScaling enabled, you can ensure that the number of VMs you are using seamlessly scale up when demand increases, and automatically decreases when demand subsides. Thus it helps you save compute costs by terminating underused VMs automatically and launching new VMs when you need them, without the need for manual intervention.
Hypervisor support
-~~~~~~~~~~~~~~~~~~
+------------------
+
+At that time, AutoScaling without NetScaler only supports for Xenserver. We
+are working to support KVM also.
-At that time, AutoScaling without NetScaler only supports for Xenserver. We are working to support KVM also.
Prerequisites
-~~~~~~~~~~~~~
+-------------
Before you configure an AutoScale rule, consider the following:
-* Ensure that the necessary template is prepared before configuring AutoScale. Firstly you must install the PV-driver, which helps Xenserver collect performance parameters (CPU and memory) into VMs. Beside, When a VM is deployed by using a template and when it comes up, the application should be up and running.
+- Ensure that the necessary template is prepared before configuring AutoScale.
+ Firstly you must install the PV-driver, which helps Xenserver collect
+ performance parameters (CPU and memory) into VMs. Beside, When a VM is
+ deployed by using a template and when it comes up, the application should be
+ up and running.
+
Configuration
-~~~~~~~~~~~~~
+-------------
Specify the following:
.. image:: ../_static/images/autoscale-config.png
-* Template: A template consists of a base OS image and application. A template is used to provision the new instance of an application on a scaleup action. When a VM is deployed from a template, the VM can start taking the traffic from the load balancer without any admin intervention. For example, if the VM is deployed for a Web service, it should have the Web server running, the database connected, and so on.
+- Template: A template consists of a base OS image and application. A
+ template is used to provision the new instance of an application on a
+ scaleup action. When a VM is deployed from a template, the VM can start
+ taking the traffic from the load balancer without any admin intervention.
+ For example, if the VM is deployed for a Web service, it should have the
+ Web server running, the database connected, and so on.
+
+- Compute offering: A predefined set of virtual hardware attributes,
+ including CPU speed, number of CPUs, and RAM size, that the user can select
+ when creating a new virtual machine instance. Choose one of the compute
+ offerings to be used while provisioning a VM instance as part of scaleup
+ action.
+
+- Min Instance: The minimum number of active VM instances that is assigned to
+ a load balancing rule. The active VM instances are the application
+ instances that are up and serving the traffic, and are being load balanced.
+ This parameter ensures that a load balancing rule has at least the
+ configured number of active VM instances are available to serve the traffic.
+
+- Max Instance: Maximum number of active VM instances that should be assigned
+ to a load balancing rule. This parameter defines the upper limit of active
+ VM instances that can be assigned to a load balancing rule.
+
+ Specifying a large value for the maximum instance parameter might result in
+ provisioning large number of VM instances, which in turn leads to a single
+ load balancing rule exhausting the VM instances limit specified at the
+ account or domain level.
-* Compute offering: A predefined set of virtual hardware attributes, including CPU speed, number of CPUs, and RAM size, that the user can select when creating a new virtual machine instance. Choose one of the compute offerings to be used while provisioning a VM instance as part of scaleup action.
+Specify the following scale-up and scale-down policies:
-* Min Instance: The minimum number of active VM instances that is assigned to a load balancing rule. The active VM instances are the application instances that are up and serving the traffic, and are being load balanced. This parameter ensures that a load balancing rule has at least the configured number of active VM instances are available to serve the traffic.
+- Duration: The duration, in seconds, for which the conditions you specify
+ must be true to trigger a scaleup action. The conditions defined should
+ hold true for the entire duration you specify for an AutoScale action to be
+ invoked.
-* Max Instance: Maximum number of active VM instances that should be assigned to a load balancing rule. This parameter defines the upper limit of active VM instances that can be assigned to a load balancing rule.
+- Counter: The performance counters expose the state of the monitored
+ instances. We added two new counter to work with that feature:
-Specifying a large value for the maximum instance parameter might result in provisioning large number of VM instances, which in turn leads to a single load balancing rule exhausting the VM instances limit specified at the account or domain level.
+ - Linux User CPU [native] - percentage
+ - Linux User RAM [native] - percentage
-Specify the following scale-up and scale-down policies:
+ Remember to choose one of them. If you choose anything else, the
+ autoscaling will not work.
-* Duration: The duration, in seconds, for which the conditions you specify must be true to trigger a scaleup action. The conditions defined should hold true for the entire duration you specify for an AutoScale action to be invoked.
+- Operator: The following five relational operators are supported in
+ AutoScale feature: Greater than, Less than, Less than or equal to, Greater
+ than or equal to, and Equal to.
-* Counter: The performance counters expose the state of the monitored instances. We added two new counter to work with that feature:
+- Threshold: Threshold value to be used for the counter. Once the counter
+ defined above breaches the threshold value, the AutoScale feature initiates
+ a scaleup or scaledown action.
-- Linux User CPU [native] - percentage
-- Linux User RAM [native] - percentage
+- Add: Click Add to add the condition.
-Remember to choose one of them. If you choose anything else, the autoscaling will not work.
+ Additionally, if you want to configure the advanced settings, click Show
+ advanced settings, and specify the following:
-* Operator: The following five relational operators are supported in AutoScale feature: Greater than, Less than, Less than or equal to, Greater than or equal to, and Equal to.
+- Polling interval: Frequency in which the conditions, combination of counter,
+ operator and threshold, are to be evaluated before taking a scale up or
+ down action. The default polling interval is 30 seconds.
-* Threshold: Threshold value to be used for the counter. Once the counter defined above breaches the threshold value, the AutoScale feature initiates a scaleup or scaledown action.
+- Quiet Time: This is the cool down period after an AutoScale action is
+ initiated. The time includes the time taken to complete provisioning a VM
+ instance from its template and the time taken by an application to be ready
+ to serve traffic. This quiet time allows the fleet to come up to a stable
+ state before any action can take place. The default is 300 seconds.
-* Add: Click Add to add the condition.
+- Destroy VM Grace Period: The duration in seconds, after a scaledown action
+ is initiated, to wait before the VM is destroyed as part of scaledown
+ action. This is to ensure graceful close of any pending sessions or
+ transactions being served by the VM marked for destroy. The default is 120
+ seconds.
-Additionally, if you want to configure the advanced settings, click Show advanced settings, and specify the following:
+- Apply: Click Apply to create the AutoScale configuration.
-* Polling interval: Frequency in which the conditions, combination of counter, operator and threshold, are to be evaluated before taking a scale up or down action. The default polling interval is 30 seconds.
-* Quiet Time: This is the cool down period after an AutoScale action is initiated. The time includes the time taken to complete provisioning a VM instance from its template and the time taken by an application to be ready to serve traffic. This quiet time allows the fleet to come up to a stable state before any action can take place. The default is 300 seconds.
+Disabling and Enabling an AutoScale Configuration
+-------------------------------------------------
-* Destroy VM Grace Period: The duration in seconds, after a scaledown action is initiated, to wait before the VM is destroyed as part of scaledown action. This is to ensure graceful close of any pending sessions or transactions being served by the VM marked for destroy. The default is 120 seconds.
+If you want to perform any maintenance operation on the AutoScale VM instances,
+disable the AutoScale configuration. When the AutoScale configuration is
+disabled, no scaleup or scaledown action is performed. You can use this
+downtime for the maintenance activities. To disable the AutoScale
+configuration, click the Disable AutoScale button.
-* Apply: Click Apply to create the AutoScale configuration.
+The button toggles between enable and disable, depending on whether AutoScale
+is currently enabled or not. After the maintenance operations are done, you
+can enable the AutoScale configuration back. To enable, open the AutoScale
+configuration page again, then click the Enable AutoScale button.
-Disabling and Enabling an AutoScale Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you want to perform any maintenance operation on the AutoScale VM instances, disable the AutoScale configuration. When the AutoScale configuration is disabled, no scaleup or scaledown action is performed. You can use this downtime for the maintenance activities. To disable the AutoScale configuration, click the Disable AutoScale button.
+Updating an AutoScale Configuration
+-----------------------------------
-The button toggles between enable and disable, depending on whether AutoScale is currently enabled or not. After the maintenance operations are done, you can enable the AutoScale configuration back. To enable, open the AutoScale configuration page again, then click the Enable AutoScale button.
+You can update the various parameters and add or delete the conditions in a
+scaleup or scaledown rule. Before you update an AutoScale configuration,
+ensure that you disable the AutoScale load balancer rule by clicking the
+Disable AutoScale button.
-Updating an AutoScale Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+After you modify the required AutoScale parameters, click Apply. To apply the
+new AutoScale policies, open the AutoScale configuration page again, then
+click the Enable AutoScale button.
-You can update the various parameters and add or delete the conditions in a scaleup or scaledown rule. Before you update an AutoScale configuration, ensure that you disable the AutoScale load balancer rule by clicking the Disable AutoScale button.
-After you modify the required AutoScale parameters, click Apply. To apply the new AutoScale policies, open the AutoScale configuration page again, then click the Enable AutoScale button.
Runtime Considerations
-~~~~~~~~~~~~~~~~~~~~~~
-
-An administrator should not assign a VM to a load balancing rule which is configured for AutoScale.
+----------------------
-Making API calls outside the context of AutoScale, such as destroyVM, on an autoscaled VM leaves the load balancing configuration in an inconsistent state. Though VM is destroyed from the load balancer rule, it continues be showed as a service assigned to a rule inside the context of AutoScale.
+An administrator should not assign a VM to a load balancing rule which is
+configured for AutoScale.
+Making API calls outside the context of AutoScale, such as destroyVM, on an
+autoscaled VM leaves the load balancing configuration in an inconsistent state.
+Though VM is destroyed from the load balancer rule, it continues be showed as
+a service assigned to a rule inside the context of AutoScale.
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/e55976f3/rtd/source/networking/ipv6.rst
----------------------------------------------------------------------
diff --git a/rtd/source/networking/ipv6.rst b/rtd/source/networking/ipv6.rst
index 2e5a1b6..117fdc2 100644
--- a/rtd/source/networking/ipv6.rst
+++ b/rtd/source/networking/ipv6.rst
@@ -1,3 +1,19 @@
+.. 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.
+
+
IPv6 Support in CloudStack
===========================
@@ -19,17 +35,11 @@ support is only an experimental feature.
Here's the sequence of events when IPv6 is used:
-#.
-
- The administrator creates an IPv6 shared network in an advanced zone.
-
-#.
+#. The administrator creates an IPv6 shared network in an advanced zone.
- The user deploys a VM in an IPv6 shared network.
+#. The user deploys a VM in an IPv6 shared network.
-#.
-
- The user VM generates an IPv6 link local address by itself, and gets
+#. The user VM generates an IPv6 link local address by itself, and gets
an IPv6 global or site local address through DHCPv6.
@@ -38,48 +48,38 @@ Prerequisites and Guidelines
Consider the following:
--
-
- CIDR size must be 64 for IPv6 networks.
-
--
+- CIDR size must be 64 for IPv6 networks.
- The DHCP client of the guest VMs should support generating DUID based
+- The DHCP client of the guest VMs should support generating DUID based
on Link-layer Address (DUID- LL). DUID-LL derives from the MAC
address of guest VMs, and therefore the user VM can be identified by
using DUID. See `Dynamic Host Configuration Protocol for
IPv6 <http://tools.ietf.org/html/rfc3315>`__\ for more information.
--
-
- The gateway of the guest network generates Router Advisement and
+- The gateway of the guest network generates Router Advisement and
Response messages to Router Solicitation. The M (Managed Address
Configuration) flag of Router Advisement should enable stateful IP
address configuration. Set the M flag to where the end nodes receive
their IPv6 addresses from the DHCPv6 server as opposed to the router
or switch.
- .. note:: The M flag is the 1-bit Managed Address Configuration flag for Router
- Advisement. When set, Dynamic Host Configuration Protocol (DHCPv6) is
- available for address configuration in addition to any IPs set by
- using stateless address auto-configuration.
-
--
+ .. note::
+ The M flag is the 1-bit Managed Address Configuration flag for Router
+ Advisement. When set, Dynamic Host Configuration Protocol (DHCPv6) is
+ available for address configuration in addition to any IPs set by
+ using stateless address auto-configuration.
- Use the System VM template exclusively designed to support IPv6.
+- Use the System VM template exclusively designed to support IPv6.
Download the System VM template from
- `http://cloudstack.apt-get.eu/systemvm/ <http://cloudstack.apt-get.eu/systemvm/>`__.
-
--
+ `http://cloudstack.apt-get.eu/systemvm/
+ <http://cloudstack.apt-get.eu/systemvm/>`__.
- The concept of Default Network applies to IPv6 networks. However,
+- The concept of Default Network applies to IPv6 networks. However,
unlike IPv4 CloudStack does not control the routing information of
IPv6 in shared network; the choice of Default Network will not affect
the routing in the user VM.
--
-
- In a multiple shared network, the default route is set by the rack
+- In a multiple shared network, the default route is set by the rack
router, rather than the DHCP server, which is out of CloudStack
control. Therefore, in order for the user VM to get only the default
route from the default NIC, modify the configuration of the user VM,
@@ -88,22 +88,18 @@ Consider the following:
auto-configure ``/proc/sys/net/ipv6/conf/interface`` with received
data.
+
Limitations of IPv6 in CloudStack
---------------------------------
The following are not yet supported:
-#.
-
- Security groups
+#. Security groups
-#.
+#. Userdata and metadata
- Userdata and metadata
+#. Passwords
-#.
-
- Passwords
Guest VM Configuration for DHCPv6
---------------------------------
@@ -111,114 +107,93 @@ Guest VM Configuration for DHCPv6
For the guest VMs to get IPv6 address, run dhclient command manually on
each of the VMs. Use DUID-LL to set up dhclient.
-.. note:: The IPv6 address is lost when a VM is stopped and started. Therefore,
-use the same procedure to get an IPv6 address when a VM is stopped and
-started.
-
-#.
+.. note::
+ The IPv6 address is lost when a VM is stopped and started. Therefore,
+ use the same procedure to get an IPv6 address when a VM is stopped and
+ started.
- Set up dhclient by using DUID-LL.
+#. Set up dhclient by using DUID-LL.
Perform the following for DHCP Client 4.2 and above:
- #.
-
- Run the following command on the selected VM to get the dhcpv6
+ #. Run the following command on the selected VM to get the dhcpv6
offer from VR:
.. sourcecode:: bash
- dhclient -6 -D LL <dev>
+ dhclient -6 -D LL <dev>
Perform the following for DHCP Client 4.1:
- #.
-
- Open the following to the dhclient configuration file:
+ #. Open the following to the dhclient configuration file:
.. sourcecode:: bash
- vi /etc/dhcp/dhclient.conf
-
- #.
+ vi /etc/dhcp/dhclient.conf
- Add the following to the dhclient configuration file:
+ #. Add the following to the dhclient configuration file:
.. sourcecode:: bash
- send dhcp6.client-id = concat(00:03:00, hardware);
-
-#.
+ send dhcp6.client-id = concat(00:03:00, hardware);
- Get IPv6 address from DHCP server as part of the system or network
+#. Get IPv6 address from DHCP server as part of the system or network
restart.
Based on the operating systems, perform the following:
On CentOS 6.2:
- #.
-
- Open the Ethernet interface configuration file:
+ #. Open the Ethernet interface configuration file:
.. sourcecode:: bash
- vi /etc/sysconfig/network-scripts/ifcfg-eth0
+ vi /etc/sysconfig/network-scripts/ifcfg-eth0
The ``ifcfg-eth0`` file controls the first NIC in a system.
- #.
-
- Make the necessary configuration changes, as given below:
+ #. Make the necessary configuration changes, as given below:
.. sourcecode:: bash
- DEVICE=eth0
- HWADDR=06:A0:F0:00:00:38
- NM_CONTROLLED=no
- ONBOOT=yes
- BOOTPROTO=dhcp6
- TYPE=Ethernet
- USERCTL=no
- PEERDNS=yes
- IPV6INIT=yes
- DHCPV6C=yes
-
- #.
+ DEVICE=eth0
+ HWADDR=06:A0:F0:00:00:38
+ NM_CONTROLLED=no
+ ONBOOT=yes
+ BOOTPROTO=dhcp6
+ TYPE=Ethernet
+ USERCTL=no
+ PEERDNS=yes
+ IPV6INIT=yes
+ DHCPV6C=yes
- Open the following:
+ #. Open the following:
.. sourcecode:: bash
- vi /etc/sysconfig/network
+ vi /etc/sysconfig/network
- #.
-
- Make the necessary configuration changes, as given below:
+ #. Make the necessary configuration changes, as given below:
.. sourcecode:: bash
- NETWORKING=yes
- HOSTNAME=centos62mgmt.lab.vmops.com
- NETWORKING_IPV6=yes
- IPV6_AUTOCONF=no
+ NETWORKING=yes
+ HOSTNAME=centos62mgmt.lab.vmops.com
+ NETWORKING_IPV6=yes
+ IPV6_AUTOCONF=no
On Ubuntu 12.10
- #.
-
- Open the following:
+ #. Open the following:
.. sourcecode:: bash
- etc/network/interfaces:
-
- #.
+ etc/network/interfaces:
- Make the necessary configuration changes, as given below:
+ #. Make the necessary configuration changes, as given below:
.. sourcecode:: bash
- iface eth0 inet6 dhcp
- autoconf 0
- accept_ra 1
+ iface eth0 inet6 dhcp
+ autoconf 0
+ accept_ra 1
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/e55976f3/rtd/source/networking/midonet.rst
----------------------------------------------------------------------
diff --git a/rtd/source/networking/midonet.rst b/rtd/source/networking/midonet.rst
index 73d7ab2..a82fa44 100644
--- a/rtd/source/networking/midonet.rst
+++ b/rtd/source/networking/midonet.rst
@@ -1,3 +1,19 @@
+.. 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.
+
+
The MidoNet Plugin
==================
@@ -9,11 +25,13 @@ networking solution as a provider for CloudStack networks and services. For
more information on MidoNet and how it works, see
http://www.midokura.com/midonet/.
+
Features of the MidoNet Plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. note:: In CloudStack 4.2.0 only the KVM hypervisor is supported for use in
- combination with MidoNet.
+.. note::
+ In CloudStack 4.2.0 only the KVM hypervisor is supported for use in
+ combination with MidoNet.
In CloudStack release 4.2.0 this plugin supports several services in the
Advanced Isolated network mode.
@@ -39,6 +57,7 @@ supported in the 4.2.0 release:
The plugin has been tested with MidoNet version 12.12. (Caddo).
+
Using the MidoNet Plugin
------------------------
@@ -50,11 +69,11 @@ the MidoNet Agent, and the MidoNet API server must be available. Please
consult the MidoNet User Guide for more information. The following
section describes the CloudStack side setup.
-1. CloudStack needs to have at least one physical network with the
+#. CloudStack needs to have at least one physical network with the
isolation method set to "MIDO". This network should be enabled for
the Guest and Public traffic types.
-2. Next, we need to set the following CloudStack settings under "Global
+#. Next, we need to set the following CloudStack settings under "Global
Settings" in the UI:
+-----------------------------+------------------------------------------------------------------------+--------------------------------------------+
@@ -67,33 +86,35 @@ section describes the CloudStack side setup.
Table: CloudStack settings
-3. We also want MidoNet to take care of public traffic, so in
+#. We also want MidoNet to take care of public traffic, so in
*componentContext.xml* we need to replace this line:
::
- <bean id="PublicNetworkGuru" class="com.cloud.network.guru.PublicNetworkGuru">
+ <bean id="PublicNetworkGuru" class="com.cloud.network.guru.PublicNetworkGuru">
With this:
::
- <bean id="PublicNetworkGuru" class="com.cloud.network.guru.MidoNetPublicNetworkGuru">
+ <bean id="PublicNetworkGuru" class="com.cloud.network.guru.MidoNetPublicNetworkGuru">
-.. note:: On the compute host, MidoNet takes advantage of per-traffic type VIF
- driver support in CloudStack KVM.
+.. note::
+ On the compute host, MidoNet takes advantage of per-traffic type VIF
+ driver support in CloudStack KVM.
- In agent.properties, we set the following to make MidoNet take care
- of Guest and Public traffic:
+ In agent.properties, we set the following to make MidoNet take care
+ of Guest and Public traffic:
- ::
+ ::
+
+ libvirt.vif.driver.Guest=com.cloud.network.resource.MidoNetVifDriver
+ libvirt.vif.driver.Public=com.cloud.network.resource.MidoNetVifDriver
- libvirt.vif.driver.Guest=com.cloud.network.resource.MidoNetVifDriver
- libvirt.vif.driver.Public=com.cloud.network.resource.MidoNetVifDriver
+ This is explained further in MidoNet User Guide.
- This is explained further in MidoNet User Guide.
Enabling the MidoNet service provider via the UI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -103,21 +124,22 @@ needs to be enabled on the physical network.
The steps to enable via the UI are as follows:
-1. In the left navbar, click Infrastructure
+#. In the left navbar, click Infrastructure
-2. In Zones, click View All
+#. In Zones, click View All
-3. Click the name of the Zone on which you are setting up MidoNet
+#. Click the name of the Zone on which you are setting up MidoNet
-4. Click the Physical Network tab
+#. Click the Physical Network tab
-5. Click the Name of the Network on which you are setting up MidoNet
+#. Click the Name of the Network on which you are setting up MidoNet
-6. Click Configure on the Network Service Providers box
+#. Click Configure on the Network Service Providers box
-7. Click on the name MidoNet
+#. Click on the name MidoNet
+
+#. Click the Enable Provider button in the Network tab
-8. Click the Enable Provider button in the Network tab
Enabling the MidoNet service provider via the API
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -136,6 +158,7 @@ To enable via the API, use the following API calls:
- state = "Enabled"
+
Revision History
----------------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/e55976f3/rtd/source/networking/nicira-plugin.rst
----------------------------------------------------------------------
diff --git a/rtd/source/networking/nicira-plugin.rst b/rtd/source/networking/nicira-plugin.rst
index b644f16..cbff59c 100644
--- a/rtd/source/networking/nicira-plugin.rst
+++ b/rtd/source/networking/nicira-plugin.rst
@@ -1,3 +1,19 @@
+.. 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.
+
+
The Nicira NVP Plugin
=====================
@@ -9,6 +25,7 @@ implementations in CloudStack. With the plugin an exisiting Nicira NVP
setup can be used by CloudStack to implement isolated guest networks and
to provide additional services like routing and NAT.
+
Features of the Nicira NVP Plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -29,8 +46,9 @@ the Nicira NVP Plugin.
Table: Supported Services
-.. note:: The Virtual Networking service was originally called 'Connectivity'
- in CloudStack 4.0
+.. note::
+ The Virtual Networking service was originally called 'Connectivity'
+ in CloudStack 4.0
The following hypervisors are supported by the Nicira NVP Plugin.
@@ -44,8 +62,10 @@ The following hypervisors are supported by the Nicira NVP Plugin.
Table: Supported Hypervisors
-.. note:: Please refer to the Nicira NVP configuration guide on how to prepare
- the hypervisors for Nicira NVP integration.
+.. note::
+ Please refer to the Nicira NVP configuration guide on how to prepare
+ the hypervisors for Nicira NVP integration.
+
Configuring the Nicira NVP Plugin
---------------------------------
@@ -71,8 +91,10 @@ Make sure you have the following information ready:
services.
-.. note:: The gateway service uuid is optional and is used for Layer 3
- services only (SourceNat, StaticNat and PortForwarding)
+.. note::
+ The gateway service uuid is optional and is used for Layer 3
+ services only (SourceNat, StaticNat and PortForwarding)
+
Zone Configuration
~~~~~~~~~~~~~~~~~~
@@ -81,14 +103,16 @@ CloudStack needs to have at least one physical network with the isolation
method set to "STT". This network should be enabled for the Guest
traffic type.
-.. note:: The Guest traffic type should be configured with the traffic label
- that matches the name of the Integration Bridge on the hypervisor.
- See the Nicira NVP User Guide for more details on how to set this up
- in XenServer or KVM.
+.. note::
+ The Guest traffic type should be configured with the traffic label
+ that matches the name of the Integration Bridge on the hypervisor.
+ See the Nicira NVP User Guide for more details on how to set this up
+ in XenServer or KVM.
.. figure:: /_static/images/nvp-physical-network-stt.png
- :align: center
- :alt: a screenshot of a physical network with the STT isolation type
+ :align: center
+ :alt: a screenshot of a physical network with the STT isolation type
+
Enabling the service provider
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -98,13 +122,15 @@ Service Providers" configuration of the physical network with the STT
isolation type. Navigate to the Nicira NVP provider and press the
"Enable Provider" button.
-.. note:: CloudStack 4.0 does not have the UI interface to configure the
- Nicira NVP plugin. Configuration needs to be done using the API
- directly.
+.. note::
+ CloudStack 4.0 does not have the UI interface to configure the
+ Nicira NVP plugin. Configuration needs to be done using the API
+ directly.
.. figure:: /_static/images/nvp-physical-network-stt.png
- :align: center
- :alt: a screenshot of an enabled Nicira NVP provider
+ :align: center
+ :alt: a screenshot of an enabled Nicira NVP provider
+
Device Management
~~~~~~~~~~~~~~~~~
@@ -116,8 +142,9 @@ network. Press the "Add NVP Controller" button on the provider panel and
enter the configuration details.
.. figure:: /_static/images/nvp-physical-network-stt.png
- :align: center
- :alt: a screenshot of the device configuration popup.
+ :align: center
+ :alt: a screenshot of the device configuration popup.
+
Network Offerings
~~~~~~~~~~~~~~~~~
@@ -155,12 +182,13 @@ Table: Isolated network offering with regular services from the Virtual
Router.
.. figure:: /_static/images/nvp-physical-network-stt.png
- :align: center
- :alt: a screenshot of a network offering.
+ :align: center
+ :alt: a screenshot of a network offering.
-.. note:: The tag in the network offering should be set to the name of the
- physical network with the NVP provider.
+.. note::
+ The tag in the network offering should be set to the name of the
+ physical network with the NVP provider.
Isolated network with network services. The virtual router is still
required to provide network services like dns and dhcp.
@@ -185,6 +213,7 @@ required to provide network services like dns and dhcp.
Table: Isolated network offering with network services
+
Using the Nicira NVP plugin with VPC
------------------------------------
@@ -201,6 +230,7 @@ Router
It is not possible to connect a private gateway using a Nicira NVP
Logical Switch
+
VPC Offering with Nicira NVP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -221,13 +251,15 @@ to the 'vpc\_offering\_service\_map' with service 'Connectivity' and
provider 'NiciraNvp'
.. figure:: /_static/images/nvp-physical-network-stt.png
- :align: center
- :alt: a screenshot of the mysql table.
+ :align: center
+ :alt: a screenshot of the mysql table.
-.. note:: When creating a new VPC offering please note that the UI does not
- allow you to select a VPC offering yet. The VPC needs to be created
- using the API with the offering UUID.
+.. note::
+ When creating a new VPC offering please note that the UI does not
+ allow you to select a VPC offering yet. The VPC needs to be created
+ using the API with the offering UUID.
+
VPC Network Offerings
~~~~~~~~~~~~~~~~~~~~~
@@ -267,6 +299,7 @@ with the loadbalancing service enabled and one without loadbalancing.
Table: VPC Network Offering with Loadbalancing
+
Troubleshooting the Nicira NVP Plugin
-------------------------------------
@@ -284,9 +317,11 @@ network on the NVP Controller.
The Nics that are connected to one of the Logical Switches will have
their Logical Switch Port UUID listed in the nicira\_nvp\_nic\_map table
-.. note:: All devices created on the NVP Controller will have a tag set to
- domain-account of the owner of the network, this string can be used
- to search for items in the NVP Controller.
+.. note::
+ All devices created on the NVP Controller will have a tag set to
+ domain-account of the owner of the network, this string can be used
+ to search for items in the NVP Controller.
+
Database tables
~~~~~~~~~~~~~~~
@@ -332,7 +367,9 @@ Table: external\_nicira\_nvp\_devices
Table: nicira\_nvp\_router\_map
-.. note:: nicira\_nvp\_router\_map is only available in CloudStack 4.1 and above
+.. note::
+ nicira\_nvp\_router\_map is only available in CloudStack 4.1 and above
+
Revision History
----------------
@@ -341,6 +378,7 @@ Revision History
for 4.0.0-incubating version of the NVP Plugin 1-0 Wed May 22 2013 Hugo
Trippaers hugo@apache.org Documentation updated for CloudStack 4.1.0
+
.. | nvp-physical-network-stt.png: a screenshot of a physical network with the STT isolation type | image:: ./images/nvp-physical-network-stt.png
.. | nvp-physical-network-stt.png: a screenshot of an enabled Nicira NVP provider | image:: ./images/nvp-enable-provider.png
.. | nvp-physical-network-stt.png: a screenshot of the device configuration popup. | image:: ./images/nvp-add-controller.png
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/e55976f3/rtd/source/networking/ovs-plugin.rst
----------------------------------------------------------------------
diff --git a/rtd/source/networking/ovs-plugin.rst b/rtd/source/networking/ovs-plugin.rst
index 495b304..90892b5 100644
--- a/rtd/source/networking/ovs-plugin.rst
+++ b/rtd/source/networking/ovs-plugin.rst
@@ -1,3 +1,19 @@
+.. 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.
+
+
The OVS Plugin
==============
@@ -5,8 +21,10 @@ Introduction to the OVS Plugin
------------------------------
The OVS plugin is the native SDN
-implementations in CloudStack, using GRE isolation method. The plugin can be used by CloudStack to implement isolated guest networks and
-to provide additional services like NAT, port forwarding and load balancing.
+implementations in CloudStack, using GRE isolation method. The plugin can be
+used by CloudStack to implement isolated guest networks and to provide
+additional services like NAT, port forwarding and load balancing.
+
Features of the OVS Plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -28,8 +46,9 @@ the OVS Plugin.
Table: Supported Services
-.. note:: The Virtual Networking service was originally called 'Connectivity'
- in CloudStack 4.0
+.. note::
+ The Virtual Networking service was originally called 'Connectivity'
+ in CloudStack 4.0
The following hypervisors are supported by the OVS Plugin.
@@ -50,12 +69,20 @@ Configuring the OVS Plugin
Prerequisites
~~~~~~~~~~~~~
-Before enabling the OVS plugin the hypervisor needs to be install OpenvSwitch. Default, XenServer has already installed OpenvSwitch. However, you must install OpenvSwitch manually on KVM. CentOS 6.4 and OpenvSwitch 1.10 are recommended.
+Before enabling the OVS plugin the hypervisor needs to be install OpenvSwitch.
+Default, XenServer has already installed OpenvSwitch. However, you must
+install OpenvSwitch manually on KVM. CentOS 6.4 and OpenvSwitch 1.10 are
+recommended.
KVM hypervisor:
-- CentOS 6.4 is recommended.
-- To make sure that the native bridge module will not interfere with openvSwitch the bridge module should be added to the blacklist. See the modprobe documentation for your distribution on where to find the blacklist. Make sure the module is not loaded either by rebooting or executing rmmod bridge before executing next steps.
+- CentOS 6.4 is recommended.
+
+- To make sure that the native bridge module will not interfere with
+ openvSwitch the bridge module should be added to the blacklist. See the
+ modprobe documentation for your distribution on where to find the blacklist.
+ Make sure the module is not loaded either by rebooting or executing rmmod
+ bridge before executing next steps.
Zone Configuration
@@ -66,76 +93,82 @@ method set to “GRE”. This network should be enabled for the Guest
traffic type.
.. note::
- With KVM, the traffic type should be configured with the traffic label
- that matches the name of the Integration Bridge on the hypervisor. For example, you should set the traffic label as following:
- - Management & Storage traffic: cloudbr0
- - Guest & Public traffic: cloudbr1
- See KVM networking configuration guide for more detail.
+ With KVM, the traffic type should be configured with the traffic label
+ that matches the name of the Integration Bridge on the hypervisor. For
+ example, you should set the traffic label as following:
+
+ - Management & Storage traffic: cloudbr0
+
+ - Guest & Public traffic: cloudbr1
+ See KVM networking configuration guide for more detail.
.. figure:: /_static/images/ovs-physical-network-gre.png
- :align: center
- :alt: a screenshot of a physical network with the GRE isolation type
+ :align: center
+ :alt: a screenshot of a physical network with the GRE isolation type
+
Agent Configuration
~~~~~~~~~~~~~~~~~~~
-.. note:: Only for KVM hypervisor
-
-* Configure network interfaces:
-
-::
-
- /etc/sysconfig/network-scripts/ifcfg-eth0
- DEVICE=eth0
- BOOTPROTO=none
- IPV6INIT=no
- NM_CONTROLLED=no
- ONBOOT=yes
- TYPE=OVSPort
- DEVICETYPE=ovs
- OVS_BRIDGE=cloudbr0
-
- /etc/sysconfig/network-scripts/ifcfg-eth1
- DEVICE=eth1
- BOOTPROTO=none
- IPV6INIT=no
- NM_CONTROLLED=no
- ONBOOT=yes
- TYPE=OVSPort
- DEVICETYPE=ovs
- OVS_BRIDGE=cloudbr1
-
- /etc/sysconfig/network-scripts/ifcfg-cloudbr0
- DEVICE=cloudbr0
- ONBOOT=yes
- DEVICETYPE=ovs
- TYPE=OVSBridge
- BOOTPROTO=static
- IPADDR=172.16.10.10
- GATEWAY=172.16.10.1
- NETMASK=255.255.255.0
- HOTPLUG=no
-
- /etc/sysconfig/network-scripts/ifcfg-cloudbr1
- DEVICE=cloudbr1
- ONBOOT=yes
- DEVICETYPE=ovs
- TYPE=OVSBridge
- BOOTPROTO=none
- HOTPLUG=no
-
- /etc/sysconfig/network
- NETWORKING=yes
- HOSTNAME=testkvm1
- GATEWAY=172.10.10.1
-
-* Edit /etc/cloudstack/agent/agent.properties
-
-::
-
- network.bridge.type=openvswitch
- libvirt.vif.driver=com.cloud.hypervisor.kvm.resource.OvsVifDriver
+.. note::
+ Only for KVM hypervisor
+
+- Configure network interfaces:
+
+ ::
+
+ /etc/sysconfig/network-scripts/ifcfg-eth0
+ DEVICE=eth0
+ BOOTPROTO=none
+ IPV6INIT=no
+ NM_CONTROLLED=no
+ ONBOOT=yes
+ TYPE=OVSPort
+ DEVICETYPE=ovs
+ OVS_BRIDGE=cloudbr0
+
+ /etc/sysconfig/network-scripts/ifcfg-eth1
+ DEVICE=eth1
+ BOOTPROTO=none
+ IPV6INIT=no
+ NM_CONTROLLED=no
+ ONBOOT=yes
+ TYPE=OVSPort
+ DEVICETYPE=ovs
+ OVS_BRIDGE=cloudbr1
+
+ /etc/sysconfig/network-scripts/ifcfg-cloudbr0
+ DEVICE=cloudbr0
+ ONBOOT=yes
+ DEVICETYPE=ovs
+ TYPE=OVSBridge
+ BOOTPROTO=static
+ IPADDR=172.16.10.10
+ GATEWAY=172.16.10.1
+ NETMASK=255.255.255.0
+ HOTPLUG=no
+
+ /etc/sysconfig/network-scripts/ifcfg-cloudbr1
+ DEVICE=cloudbr1
+ ONBOOT=yes
+ DEVICETYPE=ovs
+ TYPE=OVSBridge
+ BOOTPROTO=none
+ HOTPLUG=no
+
+ /etc/sysconfig/network
+ NETWORKING=yes
+ HOSTNAME=testkvm1
+ GATEWAY=172.10.10.1
+
+- Edit /etc/cloudstack/agent/agent.properties
+
+ ::
+
+ network.bridge.type=openvswitch
+ libvirt.vif.driver=com.cloud.hypervisor.kvm.resource.OvsVifDriver
+
Enabling the service provider
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -146,8 +179,9 @@ isolation type. Navigate to the OVS provider and press the
"Enable Provider" button.
.. figure:: /_static/images/ovs-physical-network-gre-enable.png
- :align: center
- :alt: a screenshot of an enabled OVS provider
+ :align: center
+ :alt: a screenshot of an enabled OVS provider
+
Network Offerings
~~~~~~~~~~~~~~~~~
@@ -168,29 +202,30 @@ OVS plugin.
+----------------------+-----------------+
| Firewall | VirtualRouter |
+----------------------+-----------------+
-| Load Balancer | OVS |
+| Load Balancer | OVS |
+----------------------+-----------------+
| User Data | VirtualRouter |
+----------------------+-----------------+
| Source NAT | VirtualRouter |
+----------------------+-----------------+
-| Static NAT | OVS |
+| Static NAT | OVS |
+----------------------+-----------------+
-| Post Forwarding | OVS |
+| Post Forwarding | OVS |
+----------------------+-----------------+
-| Virtual Networking | OVS |
+| Virtual Networking | OVS |
+----------------------+-----------------+
Table: Isolated network offering with regular services from the Virtual
Router.
.. figure:: /_static/images/ovs-network-offering.png
- :align: center
- :alt: a screenshot of a network offering.
+ :align: center
+ :alt: a screenshot of a network offering.
-.. note:: The tag in the network offering should be set to the name of the
- physical network with the OVS provider.
+.. note::
+ The tag in the network offering should be set to the name of the
+ physical network with the OVS provider.
Isolated network with network services. The virtual router is still
required to provide network services like dns and dhcp.
@@ -206,22 +241,24 @@ required to provide network services like dns and dhcp.
+----------------------+-----------------+
| Source NAT | VirtualRouter |
+----------------------+-----------------+
-| Static NAT | OVS |
+| Static NAT | OVS |
+----------------------+-----------------+
-| Post Forwarding | OVS |
+| Post Forwarding | OVS |
+----------------------+-----------------+
-| Load Balancing | OVS |
+| Load Balancing | OVS |
+----------------------+-----------------+
-| Virtual Networking | OVS |
+| Virtual Networking | OVS |
+----------------------+-----------------+
Table: Isolated network offering with network services
+
Using the OVS plugin with VPC
-----------------------------
OVS plugin does not work with VPC at that time
+
Revision History
----------------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/e55976f3/rtd/source/networking/vxlan.rst
----------------------------------------------------------------------
diff --git a/rtd/source/networking/vxlan.rst b/rtd/source/networking/vxlan.rst
index 24520a3..d3b54a8 100644
--- a/rtd/source/networking/vxlan.rst
+++ b/rtd/source/networking/vxlan.rst
@@ -1,3 +1,19 @@
+.. 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.
+
+
The VXLAN Plugin
================
@@ -21,6 +37,7 @@ The following table lists the requirements for the hypervisor.
Table: Hypervisor Requirement for VXLAN
+
Linux Distributions that meet the requirements
----------------------------------------------
@@ -39,6 +56,7 @@ The following table lists distributions which meet requirements.
Table: List of Linux distributions which meet the hypervisor
requirements
+
Check the capability of your system
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -46,13 +64,13 @@ To check the capability of your system, execute the following commands.
::
- $ sudo modprobe vxlan && echo $?
- # Confirm the output is "0".
- # If it's non-0 value or error message, your kernel doesn't have VXLAN kernel module.
+ $ sudo modprobe vxlan && echo $?
+ # Confirm the output is "0".
+ # If it's non-0 value or error message, your kernel doesn't have VXLAN kernel module.
- $ ip link add type vxlan help
- # Confirm the output is usage of the command and that it's for VXLAN.
- # If it's not, your iproute2 utility doesn't support VXLAN.
+ $ ip link add type vxlan help
+ # Confirm the output is usage of the command and that it's for VXLAN.
+ # If it's not, your iproute2 utility doesn't support VXLAN.
Advanced: Build kernel and iproute2
@@ -62,54 +80,55 @@ Even if your system doesn't support VXLAN, you can compile the kernel
and iproute2 by yourself. The following procedure is an example for
CentOS 6.4.
+
Build kernel
^^^^^^^^^^^^
::
- $ sudo yum groupinstall "Development Tools"
- $ sudo yum install ncurses-devel hmaccalc zlib-devel binutils-devel elfutils-libelf-devel bc
-
- $ KERNEL_VERSION=3.10.4
- # Declare the kernel version you want to build.
-
- $ wget https://www.kernel.org/pub/linux/kernel/v3.x/linux-${KERNEL_VERSION}.tar.xz
- $ tar xvf linux-${KERNEL_VERSION}.tar.xz
- $ cd linux-${KERNEL_VERSION}
- $ cp /boot/config-`uname -r` .config
- $ make oldconfig
- # You may keep hitting enter and choose the default.
-
- $ make menuconfig
- # Dig into "Device Drivers" -> "Network device support",
- # then select "Virtual eXtensible Local Area Network (VXLAN)" and hit space.
- # Make sure it indicates "<M>" (build as module), then Save and Exit.
-
- # You may also want to check "IPv4 NAT" and its child nodes in "IP: Netfilter Configuration"
- # and "IPv6 NAT" and its child nodes in "IPv6: Netfilter Configuration".
- # In 3.10.4, you can find the options in
- # "Networking support" -> "Networking options"
- # -> "Network packet filtering framework (Netfilter)".
-
- $ make # -j N
- # You may use -j N option to make the build process parallel and faster,
- # generally N = 1 + (cores your machine have).
-
- $ sudo make modules_install
- $ sudo make install
- # You would get an error like "ERROR: modinfo: could not find module XXXX" here.
- # This happens mainly due to config structure changes between kernel versions.
- # You can ignore this error, until you find you need the kernel module.
- # If you feel uneasy, you can go back to make menuconfig,
- # find module XXXX by using '/' key, enable the module, build and install the kernel again.
-
- $ sudo vi /etc/grub.conf
- # Make sure the new kernel isn't set as the default and the timeout is long enough,
- # so you can select the new kernel during boot process.
- # It's not a good idea to set the new kernel as the default until you confirm the kernel works fine.
-
- $ sudo reboot
- # Select the new kernel during the boot process.
+ $ sudo yum groupinstall "Development Tools"
+ $ sudo yum install ncurses-devel hmaccalc zlib-devel binutils-devel elfutils-libelf-devel bc
+
+ $ KERNEL_VERSION=3.10.4
+ # Declare the kernel version you want to build.
+
+ $ wget https://www.kernel.org/pub/linux/kernel/v3.x/linux-${KERNEL_VERSION}.tar.xz
+ $ tar xvf linux-${KERNEL_VERSION}.tar.xz
+ $ cd linux-${KERNEL_VERSION}
+ $ cp /boot/config-`uname -r` .config
+ $ make oldconfig
+ # You may keep hitting enter and choose the default.
+
+ $ make menuconfig
+ # Dig into "Device Drivers" -> "Network device support",
+ # then select "Virtual eXtensible Local Area Network (VXLAN)" and hit space.
+ # Make sure it indicates "<M>" (build as module), then Save and Exit.
+
+ # You may also want to check "IPv4 NAT" and its child nodes in "IP: Netfilter Configuration"
+ # and "IPv6 NAT" and its child nodes in "IPv6: Netfilter Configuration".
+ # In 3.10.4, you can find the options in
+ # "Networking support" -> "Networking options"
+ # -> "Network packet filtering framework (Netfilter)".
+
+ $ make # -j N
+ # You may use -j N option to make the build process parallel and faster,
+ # generally N = 1 + (cores your machine have).
+
+ $ sudo make modules_install
+ $ sudo make install
+ # You would get an error like "ERROR: modinfo: could not find module XXXX" here.
+ # This happens mainly due to config structure changes between kernel versions.
+ # You can ignore this error, until you find you need the kernel module.
+ # If you feel uneasy, you can go back to make menuconfig,
+ # find module XXXX by using '/' key, enable the module, build and install the kernel again.
+
+ $ sudo vi /etc/grub.conf
+ # Make sure the new kernel isn't set as the default and the timeout is long enough,
+ # so you can select the new kernel during boot process.
+ # It's not a good idea to set the new kernel as the default until you confirm the kernel works fine.
+
+ $ sudo reboot
+ # Select the new kernel during the boot process.
Build iproute2
@@ -117,22 +136,23 @@ Build iproute2
::
- $ sudo yum install db4-devel
+ $ sudo yum install db4-devel
- $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/shemminger/iproute2.git
- $ cd iproute2
- $ git tag
- # Find the version that matches the kernel.
- # If you built kernel 3.10.4 as above, it would be v3.10.0.
+ $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/shemminger/iproute2.git
+ $ cd iproute2
+ $ git tag
+ # Find the version that matches the kernel.
+ # If you built kernel 3.10.4 as above, it would be v3.10.0.
- $ git checkout v3.10.0
- $ ./configure
- $ make # -j N
- $ sudo make install
+ $ git checkout v3.10.0
+ $ ./configure
+ $ make # -j N
+ $ sudo make install
.. note:: Please use rebuild kernel and tools at your own risk.
+
Configure PRODUCT to use VXLAN Plugin
-------------------------------------
@@ -146,6 +166,7 @@ In addition to "KVM Hypervisor Host Installation" in "PRODUCT
Installation Guide", you have to configure the following item on the
host.
+
Create bridge interface with IPv4 address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -165,6 +186,7 @@ this way.
Let ``cloudbr1`` be the bridge interface for the instances' private
network.
+
Configure in RHEL or CentOS
'''''''''''''''''''''''''''
@@ -172,35 +194,33 @@ When you configured the ``cloudbr1`` interface as below,
::
- $ sudo vi /etc/sysconfig/network-scripts/ifcfg-cloudbr1
-
+ $ sudo vi /etc/sysconfig/network-scripts/ifcfg-cloudbr1
::
- DEVICE=cloudbr1
- TYPE=Bridge
- ONBOOT=yes
- BOOTPROTO=none
- IPV6INIT=no
- IPV6_AUTOCONF=no
- DELAY=5
- STP=yes
-
+ DEVICE=cloudbr1
+ TYPE=Bridge
+ ONBOOT=yes
+ BOOTPROTO=none
+ IPV6INIT=no
+ IPV6_AUTOCONF=no
+ DELAY=5
+ STP=yes
you would change the configuration similar to below.
::
- DEVICE=cloudbr1
- TYPE=Bridge
- ONBOOT=yes
- BOOTPROTO=static
- IPADDR=192.0.2.X
- NETMASK=255.255.255.0
- IPV6INIT=no
- IPV6_AUTOCONF=no
- DELAY=5
- STP=yes
+ DEVICE=cloudbr1
+ TYPE=Bridge
+ ONBOOT=yes
+ BOOTPROTO=static
+ IPADDR=192.0.2.X
+ NETMASK=255.255.255.0
+ IPV6INIT=no
+ IPV6_AUTOCONF=no
+ DELAY=5
+ STP=yes
Configure in Ubuntu
@@ -210,72 +230,71 @@ When you configured ``cloudbr1`` as below,
::
- $ sudo vi /etc/network/interfaces
+ $ sudo vi /etc/network/interfaces
::
- auto lo
- iface lo inet loopback
-
- # The primary network interface
- auto eth0.100
- iface eth0.100 inet static
- address 192.168.42.11
- netmask 255.255.255.240
- gateway 192.168.42.1
- dns-nameservers 8.8.8.8 8.8.4.4
- dns-domain lab.example.org
-
- # Public network
- auto cloudbr0
- iface cloudbr0 inet manual
- bridge_ports eth0.200
- bridge_fd 5
- bridge_stp off
- bridge_maxwait 1
-
- # Private network
- auto cloudbr1
- iface cloudbr1 inet manual
- bridge_ports eth0.300
- bridge_fd 5
- bridge_stp off
- bridge_maxwait 1
-
+ auto lo
+ iface lo inet loopback
+
+ # The primary network interface
+ auto eth0.100
+ iface eth0.100 inet static
+ address 192.168.42.11
+ netmask 255.255.255.240
+ gateway 192.168.42.1
+ dns-nameservers 8.8.8.8 8.8.4.4
+ dns-domain lab.example.org
+
+ # Public network
+ auto cloudbr0
+ iface cloudbr0 inet manual
+ bridge_ports eth0.200
+ bridge_fd 5
+ bridge_stp off
+ bridge_maxwait 1
+
+ # Private network
+ auto cloudbr1
+ iface cloudbr1 inet manual
+ bridge_ports eth0.300
+ bridge_fd 5
+ bridge_stp off
+ bridge_maxwait 1
you would change the configuration similar to below.
::
- auto lo
- iface lo inet loopback
-
- # The primary network interface
- auto eth0.100
- iface eth0.100 inet static
- address 192.168.42.11
- netmask 255.255.255.240
- gateway 192.168.42.1
- dns-nameservers 8.8.8.8 8.8.4.4
- dns-domain lab.example.org
-
- # Public network
- auto cloudbr0
- iface cloudbr0 inet manual
- bridge_ports eth0.200
- bridge_fd 5
- bridge_stp off
- bridge_maxwait 1
-
- # Private network
- auto cloudbr1
- iface cloudbr1 inet static
- addres 192.0.2.X
- netmask 255.255.255.0
- bridge_ports eth0.300
- bridge_fd 5
- bridge_stp off
- bridge_maxwait 1
+ auto lo
+ iface lo inet loopback
+
+ # The primary network interface
+ auto eth0.100
+ iface eth0.100 inet static
+ address 192.168.42.11
+ netmask 255.255.255.240
+ gateway 192.168.42.1
+ dns-nameservers 8.8.8.8 8.8.4.4
+ dns-domain lab.example.org
+
+ # Public network
+ auto cloudbr0
+ iface cloudbr0 inet manual
+ bridge_ports eth0.200
+ bridge_fd 5
+ bridge_stp off
+ bridge_maxwait 1
+
+ # Private network
+ auto cloudbr1
+ iface cloudbr1 inet static
+ addres 192.0.2.X
+ netmask 255.255.255.0
+ bridge_ports eth0.300
+ bridge_fd 5
+ bridge_stp off
+ bridge_maxwait 1
Configure iptables to pass XVLAN packets
@@ -284,6 +303,7 @@ Configure iptables to pass XVLAN packets
Since VXLAN uses UDP packet to forward encapsulated the L2 frames,
UDP/8472 port must be opened.
+
Configure in RHEL or CentOS
'''''''''''''''''''''''''''
@@ -292,7 +312,7 @@ extra ports by executing the following iptable commands:
::
- $ sudo iptables -I INPUT -p udp -m udp --dport 8472 -j ACCEPT
+ $ sudo iptables -I INPUT -p udp -m udp --dport 8472 -j ACCEPT
These iptable settings are not persistent accross reboots, we have to
@@ -300,7 +320,7 @@ save them first.
::
- $ sudo iptables-save > /etc/sysconfig/iptables
+ $ sudo iptables-save > /etc/sysconfig/iptables
With this configuration you should be able to restart the network,
@@ -308,11 +328,14 @@ although a reboot is recommended to see if everything works properly.
::
- $ sudo service network restart
- $ sudo reboot
+ $ sudo service network restart
+ $ sudo reboot
-.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the machine in case you made a configuration error and the network stops functioning!
+.. warning::
+ Make sure you have an alternative way like IPMI or ILO to reach the machine
+ in case you made a configuration error and the network stops functioning!
+
Configure in Ubuntu
'''''''''''''''''''
@@ -324,21 +347,24 @@ To open the required ports, execute the following commands:
::
- $ sudo ufw allow proto udp from any to any port 8472
+ $ sudo ufw allow proto udp from any to any port 8472
-
-.. note:: By default UFW is not enabled on Ubuntu. Executing these commands with the firewall disabled does not enable the firewall.
+.. note::
+ By default UFW is not enabled on Ubuntu. Executing these commands with the
+ firewall disabled does not enable the firewall.
With this configuration you should be able to restart the network,
although a reboot is recommended to see if everything works properly.
::
- $ sudo service networking restart
- $ sudo reboot
+ $ sudo service networking restart
+ $ sudo reboot
+.. warning::
+ Make sure you have an alternative way like IPMI or ILO to reach the machine
+ in case you made a configuration error and the network stops functioning!
-.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the machine in case you made a configuration error and the network stops functioning!
Setup zone using VXLAN
~~~~~~~~~~~~~~~~~~~~~~
@@ -349,6 +375,7 @@ is not required to add a network element nor to reconfigure the network
offering. The only thing you have to do is configure the physical
network to use VXLAN as the isolation method for Guest Network.
+
Configure the physical network
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -363,6 +390,7 @@ Guest Network traffic label should be the name of the physical interface
or the name of the bridge interface and the bridge interface and they
should have an IPv4 address. See ? for details.
+
Configure the guest traffic
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -371,6 +399,6 @@ Configure the guest traffic
Specify a range of VNIs you would like to use for carrying guest network
traffic.
-.. warning:: VNI must be unique per zone and no duplicate VNIs can exist in the zone. Exercise care when designing your VNI allocation policy.
-
-
+.. warning::
+ VNI must be unique per zone and no duplicate VNIs can exist in the zone.
+ Exercise care when designing your VNI allocation policy.