Add documentation for SRIOV NIC agent (previously missing)

Co-Authored-By: Moshe Levi <moshele@mellanox.com>
Change-Id: I86abeb42d01b0541a4537b774833a104c6732310

diff --git a/doc/source/devref/l2_agents.rst b/doc/source/devref/l2_agents.rst
index 83786dabe028b5867141c4df46bfd10f8ee56b3e..daa3b2a00477c31d84af955165e3414c461ee495 100644 (file)
--- a/doc/source/devref/l2_agents.rst
+++ b/doc/source/devref/l2_agents.rst
@@ -5,3 +5,4 @@ L2 Agent Networking
 
    openvswitch_agent
    linuxbridge_agent
+   sriov_nic_agent

diff --git a/doc/source/devref/sriov_nic_agent.rst b/doc/source/devref/sriov_nic_agent.rst
new file mode 100644 (file)
index 0000000..a316877
--- /dev/null
+++ b/doc/source/devref/sriov_nic_agent.rst
@@ -0,0 +1,27 @@
+======================================
+L2 Networking with SR-IOV enabled NICs
+======================================
+SR-IOV (Single Root I/O Virtualization) is a specification that allows
+a PCIe device to appear to be multiple separate physical PCIe devices.
+SR-IOV works by introducing the idea of physical functions (PFs) and virtual functions (VFs).
+Physical functions (PFs) are full-featured PCIe functions.
+Virtual functions (VFs) are “lightweight” functions that lack configuration resources.
+
+SR-IOV supports VLANs for L2 network isolation, other networking technologies
+such as VXLAN/GRE may be supported in the future.
+
+SR-IOV NIC agent manages configuration of SR-IOV Virtual Functions that connect
+VM instances running on the compute node to the public network.
+
+In most common deployments, there are compute and a network nodes.
+Compute node can support VM connectivity via SR-IOV enabled NIC. SR-IOV NIC Agent manages
+Virtual Functions admin state. In the future it will manage additional settings, such as
+quality of service, rate limit settings, spoofcheck and more.
+Network node will be usually deployed with either Open vSwitch or Linux Bridge to support network node functionality.
+
+
+Further Reading
+---------------
+
+* `Nir Yechiel - SR-IOV Networking – Part I: Understanding the Basics <http://redhatstackblog.redhat.com/2015/03/05/red-hat-enterprise-linux-openstack-platform-6-sr-iov-networking-part-i-understanding-the-basics/>`_
+* `SR-IOV Passthrough For Networking <https://wiki.openstack.org/wiki/SR-IOV-Passthrough-For-Networking/>`_