Add contents section to FAQ and enable internal links in doc for pretty printing on GitHub.
Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodire...@intel.com> --- Reviewers can review the rendered form here https://github.com/bbodired/ovs/blob/master/FAQ.md FAQ.md | 52 +++++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/FAQ.md b/FAQ.md index 35e1cac..da63df1 100644 --- a/FAQ.md +++ b/FAQ.md @@ -3,8 +3,22 @@ Frequently Asked Questions Open vSwitch <http://openvswitch.org> -General -------- +## Contents + +1. [General](#general) +2. [Releases](#releases) +3. [Terminology](#terminology) +4. [Basic configuration](#configuration) +5. [Implementation Details](#implementation) +6. [Performance](#performance) +7. [Configuration Problems](#configproblems) +8. [Quality of Service(QOS)](#qos) +9. [VLANs](#vlans) +10. [VXLANs](#vxlans) +11. [Using OpenFlow (Manually or Via Controller)](#openflowusage) +12. [Development](#development) + +## <a name="overview"></a> 1. General ### Q: What is Open vSwitch? @@ -119,8 +133,7 @@ A: Starting in OVS 2.4, we switched the default ports to the appropriate man page. -Releases --------- +## <a name="releases"></a> 2. Releases ### Q: What does it mean for an Open vSwitch release to be LTS (long-term support)? @@ -353,8 +366,7 @@ A: Bridge compatibility was a feature of Open vSwitch 1.9 and earlier. the release. Be sure to start the ovs-brcompatd daemon. -Terminology ------------ +## <a name="terminology"></a> 3. Terminology ### Q: I thought Open vSwitch was a virtual Ethernet switch, but the documentation keeps talking about bridges. What's a bridge? @@ -367,8 +379,7 @@ A: In networking, the terms "bridge" and "switch" are synonyms. Open A: See the "VLAN" section below. -Basic Configuration -------------------- +## <a name="configuration"></a> 4. Basic configuration ### Q: How do I configure a port as an access port? @@ -575,9 +586,7 @@ A: First, why do you want to do this? Two connected bridges are not A: Open vSwitch does not support such a configuration. Bridges always have their local ports. - -Implementation Details ----------------------- +## <a name="implementation"></a> 5. Implementation Details ### Q: I hear OVS has a couple of kinds of flows. Can you tell me about them? @@ -668,8 +677,7 @@ A: No. There are several reasons: published in USENIX NSDI 2015. -Performance ------------ +## <a name="performance"></a> 6. Performance ### Q: I just upgraded and I see a performance drop. Why? @@ -689,8 +697,7 @@ A: The OVS kernel datapath may have been updated to a newer version than userspace. -Configuration Problems ----------------------- +## <a name="configproblems"></a> 7. Configuration Problems ### Q: I created a bridge and added my Ethernet port to it, using commands like these: @@ -1045,8 +1052,7 @@ A: The short answer is that this is a misuse of a "tap" device. Use type "system", the default, instead). -Quality of Service (QoS) ------------------------- +## <a name="qos"></a> 8. Quality of Service(QOS) ### Q: Does OVS support Quality of Service (QoS)? @@ -1202,9 +1208,7 @@ A: Since version 2.0, Open vSwitch has OpenFlow protocol support for vSwitch software switch (neither the kernel-based nor userspace switches). - -VLANs ------ +## <a name="vlans"></a> 9. VLANs ### Q: What's a VLAN? @@ -1477,8 +1481,7 @@ A: Open vSwitch implements Independent VLAN Learning (IVL) for for each VLANs. -VXLANs ------ +## <a name="vxlans"></a> 10. VXLANs ### Q: What's a VXLAN? @@ -1512,8 +1515,7 @@ A: By default, Open vSwitch will use the assigned IANA port for VXLAN, which options:dst_port=8472 -Using OpenFlow (Manually or Via Controller) -------------------------------------------- +## <a name="openflowusage"></a> 11. Using OpenFlow (Manually or Via Controller) ### Q: What versions of OpenFlow does Open vSwitch support? @@ -1573,7 +1575,7 @@ A: The following table lists the versions of OpenFlow supported by 1.5 is solidly implemented, Open vSwitch will enable those version by default. -### Q: Does Open vSwitch support MPLS? +## <a name="development"></a> 12. Development A: Before version 1.11, Open vSwitch did not support MPLS. That is, these versions can match on MPLS Ethernet types, but they cannot -- 2.4.11 _______________________________________________ dev mailing list dev@openvswitch.org http://openvswitch.org/mailman/listinfo/dev