Repository: cloudstack-docs Updated Branches: refs/heads/master 58ec1d009 -> bcf67dd6f
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/release-notes/en-US/fallback.xml ---------------------------------------------------------------------- diff --git a/release-notes/en-US/fallback.xml b/release-notes/en-US/fallback.xml deleted file mode 100644 index 28ad3ef..0000000 --- a/release-notes/en-US/fallback.xml +++ /dev/null @@ -1,24 +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="fallback"> - <title>Fallback</title> - <para>to-do</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/release-notes/en-US/feedback.xml ---------------------------------------------------------------------- diff --git a/release-notes/en-US/feedback.xml b/release-notes/en-US/feedback.xml deleted file mode 100644 index 4b06c9f..0000000 --- a/release-notes/en-US/feedback.xml +++ /dev/null @@ -1,24 +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="feedback"> - <title>Feedback</title> - <para>to-do</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/release-notes/publican.cfg ---------------------------------------------------------------------- diff --git a/release-notes/publican.cfg b/release-notes/publican.cfg deleted file mode 100644 index b6af406..0000000 --- a/release-notes/publican.cfg +++ /dev/null @@ -1,27 +0,0 @@ -# Publican configuration file for CloudStack 4.0 Release Notes -# Config::Simple 4.58 -# Tue May 29 00:57:27 2012 -# -# 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. - -xml_lang: en-US -type: Book -docname: Release_Notes -brand: cloudstack -chunk_first: 0 -chunk_section_depth: 0 -toc_section_depth: 1 http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/Author_Group.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/Author_Group.xml b/vxlan/en-US/Author_Group.xml deleted file mode 100644 index 1184c50..0000000 --- a/vxlan/en-US/Author_Group.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Runbook.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. ---> - - -<authorgroup> - <author> - <firstname>Apache</firstname> - <surname>CloudStack</surname> - </author> -</authorgroup> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/Book_Info.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/Book_Info.xml b/vxlan/en-US/Book_Info.xml deleted file mode 100644 index e063e23..0000000 --- a/vxlan/en-US/Book_Info.xml +++ /dev/null @@ -1,47 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<bookinfo id="book-release-notes-3.0.4"> - <title>&PRODUCT; Guide</title> - <subtitle>Revised August 9, 2012 10:48 pm Pacific</subtitle> - <productname>Apache CloudStack</productname> - <productnumber>4.3.0</productnumber> - <edition>1</edition> - <pubsnumber></pubsnumber> - <abstract> - <para> - Complete technical documentation of &PRODUCT;. - </para> - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" /> - </imageobject> - </inlinemediaobject> - </corpauthor> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</bookinfo> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/CloudStack_VXLAN_Guide.ent ---------------------------------------------------------------------- diff --git a/vxlan/en-US/CloudStack_VXLAN_Guide.ent b/vxlan/en-US/CloudStack_VXLAN_Guide.ent deleted file mode 100644 index f31c407..0000000 --- a/vxlan/en-US/CloudStack_VXLAN_Guide.ent +++ /dev/null @@ -1,22 +0,0 @@ -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<!ENTITY PRODUCT "CloudStack"> -<!ENTITY BOOKID "Technical Documentation"> -<!ENTITY YEAR "2013"> -<!ENTITY HOLDER "Apache Software Foundation"> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/CloudStack_VXLAN_Guide.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/CloudStack_VXLAN_Guide.xml b/vxlan/en-US/CloudStack_VXLAN_Guide.xml deleted file mode 100644 index d7886c8..0000000 --- a/vxlan/en-US/CloudStack_VXLAN_Guide.xml +++ /dev/null @@ -1,53 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod"> -%xinclude; -]> - -<!-- 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. ---> - -<book> - <bookinfo id="cloudstack_plugin_vxlan"> - <title>&PRODUCT; Plugin Guide for the VXLAN Plugin</title> - <productname>Apache CloudStack</productname> - <productnumber>4.3.0</productnumber> - <edition>0</edition> - <pubsnumber></pubsnumber> - <abstract> - <para> - Plugin Guide for the VXLAN Plugin. - </para> - </abstract> - <corpauthor> - <inlinemediaobject> - <imageobject> - <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" /> - </imageobject> - </inlinemediaobject> - </corpauthor> - <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </bookinfo> - <xi:include href="plugin-vxlan-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="plugin-vxlan-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="plugin-vxlan-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="plugin-vxlan-revision-history.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</book> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/images/vxlan-physicalnetwork.png ---------------------------------------------------------------------- diff --git a/vxlan/en-US/images/vxlan-physicalnetwork.png b/vxlan/en-US/images/vxlan-physicalnetwork.png deleted file mode 100644 index eb06fcd..0000000 Binary files a/vxlan/en-US/images/vxlan-physicalnetwork.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/images/vxlan-trafficlabel.png ---------------------------------------------------------------------- diff --git a/vxlan/en-US/images/vxlan-trafficlabel.png b/vxlan/en-US/images/vxlan-trafficlabel.png deleted file mode 100644 index 916e944..0000000 Binary files a/vxlan/en-US/images/vxlan-trafficlabel.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/images/vxlan-vniconfig.png ---------------------------------------------------------------------- diff --git a/vxlan/en-US/images/vxlan-vniconfig.png b/vxlan/en-US/images/vxlan-vniconfig.png deleted file mode 100644 index c7372a0..0000000 Binary files a/vxlan/en-US/images/vxlan-vniconfig.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-about.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-about.xml b/vxlan/en-US/plugin-vxlan-about.xml deleted file mode 100644 index 5cf0c34..0000000 --- a/vxlan/en-US/plugin-vxlan-about.xml +++ /dev/null @@ -1,27 +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; -<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod"> -%xinclude; -]> -<!-- 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="About-the-VXLAN-Plugin" > - <title>The VXLAN Plugin</title> - <xi:include href="plugin-vxlan-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="plugin-vxlan-features.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-config-hypervisor.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-config-hypervisor.xml b/vxlan/en-US/plugin-vxlan-config-hypervisor.xml deleted file mode 100644 index d441c8b..0000000 --- a/vxlan/en-US/plugin-vxlan-config-hypervisor.xml +++ /dev/null @@ -1,204 +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; -<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod"> -%xinclude; -]> -<!-- 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="plugin-vxlan-config-hypervisor"> - <title>Configure hypervisor</title> - <section id="plugin-vxlan-config-hypervisor-kvm"> - <title>Configure hypervisor: KVM</title> - <para> - In addition to "KVM Hypervisor Host Installation" in "&PRODUCT; Installation Guide", you have to configure the following item on the host. - </para> - <section id="plugin-vxlan-config-hypervisor-kvm-bridge"> - <title>Create bridge interface with IPv4 address</title> - <para> - This plugin requires an IPv4 address on the KVM host to terminate and originate VXLAN traffic. - The address should be assinged to a physical interface or a bridge interface bound to a physical interface. - Both a private address or a public address are fine for the purpose. - It is not required to be in the same subnet for all hypervisors in a zone, but they should be able to reach each other via IP multicast with UDP/8472 port. - A name of a physical interface or a name of a bridge interface bound to a physical interface can be used as a traffic label. - Physical interface name fits for almost all cases, but if physical interface name differs per host, you may use a bridge to set a same name. - If you would like to use a bridge name as a traffic label, you may create a bridge in this way. - </para> - <para> - Let <parameter>cloudbr1</parameter> be the bridge interface for the instances' private network. - </para> - <section id="plugin-vxlan-config-hypervisor-kvm-bridge-rhel"> - <title>Configure in RHEL or CentOS</title> - <para> - When you configured the <parameter>cloudbr1</parameter> interface as below, - </para> - <programlisting language="Bash">$ sudo vi /etc/sysconfig/network-scripts/ifcfg-cloudbr1 - </programlisting> - <programlisting language="Bash">DEVICE=cloudbr1 -TYPE=Bridge -ONBOOT=yes -BOOTPROTO=none -IPV6INIT=no -IPV6_AUTOCONF=no -DELAY=5 -STP=yes - </programlisting> - <para> - you would change the configuration similar to below. - </para> - <programlisting language="Bash">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 - </programlisting> - - </section> - <section id="plugin-vxlan-config-hypervisor-kvm-bridge-ubuntu"> - <title>Configure in Ubuntu</title> - <para> - When you configured <parameter>cloudbr1</parameter> as below, - </para> - <programlisting language="Bash">$ sudo vi /etc/network/interfaces - </programlisting> - <programlisting language="Bash">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 - </programlisting> - <para> - you would change the configuration similar to below. - </para> - <programlisting language="Bash">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 - </programlisting> - </section> - </section> - <section id="plugin-vxlan-config-hypervisor-kvm-iptables"> - <title>Configure iptables to pass XVLAN packets</title> - <para> - Since VXLAN uses UDP packet to forward encapsulated the L2 frames, UDP/8472 port must be opened. - </para> - <section id="plugin-vxlan-config-hypervisor-kvm-iptables-rhel"> - <title>Configure in RHEL or CentOS</title> - <para> - RHEL and CentOS use iptables for firewalling the system, you can open extra ports by executing the following iptable commands: - </para> - <programlisting language="Bash">$ sudo iptables -I INPUT -p udp -m udp --dport 8472 -j ACCEPT - </programlisting> - <para> - These iptable settings are not persistent accross reboots, we have to save them first. - </para> - <programlisting language="Bash">$ sudo iptables-save > /etc/sysconfig/iptables - </programlisting> - <para> - With this configuration you should be able to restart the network, although a reboot is recommended to see if everything works properly. - </para> - <programlisting language="Bash">$ sudo service network restart - $ sudo reboot - </programlisting> - <warning> - <para> - 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! - </para> - </warning> - </section> - <section id="plugin-vxlan-config-hypervisor-kvm-iptables-ubuntu"> - <title>Configure in Ubuntu</title> - <para> - The default firewall under Ubuntu is UFW (Uncomplicated FireWall), which is a Python wrapper around iptables. - </para> - <para> - To open the required ports, execute the following commands: - </para> - <programlisting language="Bash">$ sudo ufw allow proto udp from any to any port 8472 - </programlisting> - <note> - <para> - By default UFW is not enabled on Ubuntu. Executing these commands with the firewall disabled does not enable the firewall. - </para> - </note> - <para> - With this configuration you should be able to restart the network, although a reboot is recommended to see if everything works properly. - </para> - <programlisting language="Bash">$ sudo service networking restart -$ sudo reboot - </programlisting> - <warning> - <para> - 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! - </para> - </warning> - </section> - </section> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-config-management.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-config-management.xml b/vxlan/en-US/plugin-vxlan-config-management.xml deleted file mode 100644 index d8ba907..0000000 --- a/vxlan/en-US/plugin-vxlan-config-management.xml +++ /dev/null @@ -1,76 +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; -<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod"> -%xinclude; -]> -<!-- 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="plugin-vxlan-config-management"> - <title>Setup zone using VXLAN</title> - <para> - In almost all parts of zone setup, you can just follow the advanced zone setup istruction in "&PRODUCT; Installation Guide" to use this plugin. - It 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. - </para> - <section id="plugin-vxlan-config-management-physical-network"> - <title>Configure the physical network</title> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vxlan-physicalnetwork.png"/> - </imageobject> - <textobject> - <phrase>vxlan-physicalnetowkr.png: physicalnetwork configuration for VXLAN</phrase> - </textobject> - </mediaobject> - <para> - CloudStack needs to have one physical network for Guest Traffic with the isolation method set to "VXLAN". - </para> - - <mediaobject> - <imageobject> - <imagedata fileref="./images/vxlan-trafficlabel.png"/> - </imageobject> - <textobject> - <phrase>vxlan-trafficlabel.png: traffic label configuration for VXLAN</phrase> - </textobject> - </mediaobject> - <para> - 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 <xref linkend="plugin-vxlan-config-hypervisor-kvm-bridge"/> for details. - </para> - </section> - <section id="plugin-vxlan-config-management-guest-traffic"> - <title>Configure the guest traffic</title> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vxlan-vniconfig.png"/> - </imageobject> - <textobject> - <phrase>vxlan-vniconfig.png: VNI configuration</phrase> - </textobject> - </mediaobject> - <para> - Specify a range of VNIs you would like to use for carrying guest network traffic. - </para> - <warning> - <para> - VNI must be unique per zone and no duplicate VNIs can exist in the zone. Exercise care when designing your VNI allocation policy. - </para> - </warning> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-configuration.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-configuration.xml b/vxlan/en-US/plugin-vxlan-configuration.xml deleted file mode 100644 index 03daf0d..0000000 --- a/vxlan/en-US/plugin-vxlan-configuration.xml +++ /dev/null @@ -1,27 +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; -<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod"> -%xinclude; -]> -<!-- 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="How-to-configure-VXLAN-Plugin" > - <title>Configure &PRODUCT; to use VXLAN Plugin</title> - <xi:include href="plugin-vxlan-config-hypervisor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - <xi:include href="plugin-vxlan-config-management.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-features.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-features.xml b/vxlan/en-US/plugin-vxlan-features.xml deleted file mode 100644 index ba177e7..0000000 --- a/vxlan/en-US/plugin-vxlan-features.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; -<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod"> -%xinclude; -]> -<!-- 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="Features-of-the-VXLAN-Plugin"> - <title>Features of the VXLAN Plugin</title> - - <para> - In &PRODUCT; release 4.X.0 this plugin supports Advanced Isolated network mode. - This plugin enables more than 4096 isolated guest networks in a Zone, with almost the same usability as VLAN isolation. - </para> - - <para> - By the nature of VXLAN's MAC-in-IP encapsulation, the MAC addresses of VMs are encapsulated and concealed in the MAC addresses of Hypervisors. - So, the physical switch no longer needs to learn the MAC addresses of the individual VMs. - Thus, the required MAC address table size of the physical switch would be greatly reduced. - </para> - - <para> - This plugin doesn't provide network services. - With this plugin, network services ( VPN, Source NAT, Static NAT, Port Forwarding, Firewall, and Load Balancing ) are provided by the Virtual Router. - </para> - -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-introduction.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-introduction.xml b/vxlan/en-US/plugin-vxlan-introduction.xml deleted file mode 100644 index dc67f3a..0000000 --- a/vxlan/en-US/plugin-vxlan-introduction.xml +++ /dev/null @@ -1,26 +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; -<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod"> -%xinclude; -]> -<!-- 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="Introduction-to-the-VXLAN-Plugin"> - <title>Introduction to the VXLAN Plugin</title> - <para>The VXLAN plugin adds VXLAN as one of the guest network isolation methods in &PRODUCT;.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-requirements.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-requirements.xml b/vxlan/en-US/plugin-vxlan-requirements.xml deleted file mode 100644 index 129e46a..0000000 --- a/vxlan/en-US/plugin-vxlan-requirements.xml +++ /dev/null @@ -1,190 +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="vxlan-requirements"> - <title>System Requirements for VXLAN</title> - <section id="vxlan-table-of-requirement"> - <title>System Requirements for VXLAN</title> - <para>In &PRODUCT; 4.X.0, this plugin only supports the KVM hypervisor with the standard linux bridge.</para> - - <para>The following table lists the requirements for the hypervisor.</para> - <table> - <title>Hypervisor Requirement for VXLAN</title> - <tgroup cols="3"> - <thead> - <row> - <entry>Item</entry> - <entry>Requirement</entry> - <entry>Note</entry> - </row> - </thead> - <tbody> - <row> - <entry>Hypervisor</entry> - <entry>KVM</entry> - <entry>OvsVifDriver is not supported by this plugin in &PRODUCT; 4.X, use BridgeVifDriver (default).</entry> - </row> - <row> - <entry>Linux kernel</entry> - <entry>version >= 3.7, VXLAN kernel module enabled</entry> - <entry>It is recommended to use kernel >=3.9, since Linux kernel categorizes the VXLAN driver as experimental <3.9.</entry> - </row> - <row> - <entry>iproute2</entry> - <entry>matches kernel version</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - - <section id="vxlan-req-distribution"> - <title>Linux Distributions that meet the requirements</title> - <para> - The following table lists distributions which meet requirements. - </para> - <table> - <title>List of Linux distributions which meet the hypervisor requirements</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Distribution</entry> - <entry>Release Version</entry> - <entry>Kernel Version (Date confirmed)</entry> - <entry>Note</entry> - </row> - </thead> - <tbody> - <row> - <entry>Ubuntu</entry> - <entry>13.04</entry> - <entry>3.8.0 (2013/07/23)</entry> - <entry></entry> - </row> - <row> - <entry>Fedora</entry> - <entry>>= 17</entry> - <entry>3.9.10 (2013/07/23)</entry> - <entry>Latest kernel packages are available in "update" repository.</entry> - </row> - <row> - <entry>CentOS</entry> - <entry>>= 6.5</entry> - <entry>2.6.32-431.3.1.el6.x86_64 (2014/01/21)</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - <section id="vxlan-confirm"> - <title>Check the capability of your system</title> - <para> - To check the capability of your system, execute the following commands. - </para> - <programlisting language="Bash"> -$ 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. - </programlisting> - </section> - <section id="vxlan-req-build"> - <title>Advanced: Build kernel and iproute2</title> - <para> - 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. - </para> - <section id="vxlan-build-kernel"> - <title>Build kernel</title> - <programlisting language="Bash">$ 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. - </programlisting> - </section> - <section id="vxlan-build-iproute2"> - <title>Build iproute2</title> - <programlisting>$ 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 checkout v3.10.0 -$ ./configure -$ make # -j N -$ sudo make install - </programlisting> - <note> - <para>Please use rebuild kernel and tools at your own risk.</para> - </note> - </section> - </section> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/en-US/plugin-vxlan-revision-history.xml ---------------------------------------------------------------------- diff --git a/vxlan/en-US/plugin-vxlan-revision-history.xml b/vxlan/en-US/plugin-vxlan-revision-history.xml deleted file mode 100644 index 7c45a54..0000000 --- a/vxlan/en-US/plugin-vxlan-revision-history.xml +++ /dev/null @@ -1,72 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<appendix id="plugin-vxlan-revision-history"> - <title>Revision History</title> - <simpara> - <revhistory> - <revision> - <revnumber>0-2</revnumber> - <date>January 21 2014</date> - <author> - <firstname>Yoshikazu</firstname> - <surname>Nojima</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Add a section to describe VNI allocation matter. Add a description that explain a physical interface name can be used for traffic label.</member> - </simplelist> - </revdescription> - </revision> <revision> - <revnumber>0-1</revnumber> - <date>October 3 2013</date> - <author> - <firstname>Yoshikazu</firstname> - <surname>Nojima</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Initial revision</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>0-0</revnumber> - <date>August 2 2013</date> - <author> - <firstname>Toshiaki</firstname> - <surname>Hatano</surname> - <email/> - </author> - <revdescription> - <simplelist> - <member>Draft</member> - </simplelist> - </revdescription> - </revision> - </revhistory> - </simpara> -</appendix> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/bcf67dd6/vxlan/publican.cfg ---------------------------------------------------------------------- diff --git a/vxlan/publican.cfg b/vxlan/publican.cfg deleted file mode 100644 index f46b8a1..0000000 --- a/vxlan/publican.cfg +++ /dev/null @@ -1,28 +0,0 @@ -# Publican configuration file for CloudStack Complete Documentation Set -# Contains all technical docs except release notes -# Config::Simple 4.58 -# Tue May 29 00:57:27 2012 -# -# 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. - -xml_lang: en-US -type: Book -docname: CloudStack_VXLAN_Guide -brand: cloudstack -chunk_first: 1 -chunk_section_depth: 1 -condition: install
