Fix doc format

Change-Id: Idcc2ad76f10f50b66bff2f6df2eabda998f557b9
Signed-off-by: Bin Hu <bh526r@att.com>

diff --git a/docs/gapanalysis/gap-analysis-odl-boron.rst b/docs/gapanalysis/gap-analysis-odl-boron.rst
index 11b4a61..c416600 100644 (file)
--- a/docs/gapanalysis/gap-analysis-odl-boron.rst
+++ b/docs/gapanalysis/gap-analysis-odl-boron.rst
@@ -18,8 +18,8 @@ There are 2 options in Open Daylight Boron to provide Virtualized Networks:
 1 ``Old Netvirt``: netvirt implementation used in Open Daylight Beryllium Release
   identified by feature ``odl-ovsdb-openstack``
 
-2 ``New Netvirt``: netvirt implementation which will replace the Old Netvirt in the future
-  releases based on a more modular design. It is identified by feature
+2 ``New Netvirt``: netvirt implementation which will replace the Old Netvirt in the
+  future releases based on a more modular design. It is identified by feature
   ``odl-netvirt-openstack``
 
 .. table::
@@ -68,3 +68,4 @@ There are 2 options in Open Daylight Boron to provide Virtualized Networks:
   |ODL on an IPv6 only Infrastructure.               |**No**               |**Work in Progress**   |Deploying OpenStack with ODL on an IPv6 only infrastructure   |
   |                                                  |                     |                       |where the API endpoints are all IPv6 addresses.               |
   +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+

diff --git a/docs/proofread/index.rst b/docs/proofread/index.rst
index bc3e10f..12e7b91 100644 (file)
--- a/docs/proofread/index.rst
+++ b/docs/proofread/index.rst
@@ -135,47 +135,60 @@ Open Daylight Boron Official Release. The following table lists the use cases /
 requirements of VIM-agnostic IPv6 functionality, including infrastructure layer and VNF
 (VM) layer, and its gap analysis with Open Daylight Boron Official Release.
 
+**Open Daylight Boron Status**
+
+There are 2 options in Open Daylight Boron to provide Virtualized Networks:
+
+1 ``Old Netvirt``: netvirt implementation used in Open Daylight Beryllium Release
+  identified by feature ``odl-ovsdb-openstack``
+
+2 ``New Netvirt``: netvirt implementation which will replace the Old Netvirt in the
+  future releases based on a more modular design. It is identified by feature
+  ``odl-netvirt-openstack``
+
 .. table::
   :class: longtable
 
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |Use Case / Requirement                                       |Supported in ODL Boron|Notes                                                                     |
-  +=============================================================+======================+==========================================================================+
-  |REST API support for IPv6 subnet creation in ODL             |Yes                   |Yes, it is possible to create IPv6 subnets in ODL using Neutron REST API. |
-  |                                                             |                      |                                                                          |
-  |                                                             |                      |For a network which has both IPv4 and IPv6 subnets, ODL mechanism driver  |
-  |                                                             |                      |will send the port information which includes IPv4/v6 addresses to ODL    |
-  |                                                             |                      |Neutron northbound API. When port information is queried it displays IPv4 |
-  |                                                             |                      |and IPv6 addresses. However, in Boron release, ODL net-virt provider      |
-  |                                                             |                      |does not support IPv6 features (i.e., the actual functionality is missing |
-  |                                                             |                      |and would be available only in the later releases of ODL).                |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |IPv6 Router support in ODL                                   |**No**                |ODL net-virt provider in Boron release only supports IPv4 Router.         |
-  |                                                             |                      |                                                                          |
-  |1. Communication between VMs on same compute node            |                      |In the meantime, if IPv6 Routing is necessary, we can use ODL for L2      |
-  |2. Communication between VMs on different compute nodes      |                      |connectivity and Neutron L3 agent for IPv4/v6 routing.                    |
-  |   (east-west)                                               |                      |                                                                          |
-  |3. External routing (north-south)                            |                      |                                                                          |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |IPAM: Support for IPv6 Address assignment modes.             |**No**                |Although it is possible to create different types of IPv6 subnets in ODL, |
-  |                                                             |                      |ODL_L3 would have to implement the IPv6 Router that can send out Router   |
-  |1. SLAAC                                                     |                      |Advertisements based on the IPv6 addressing mode. Router Advertisement    |
-  |2. DHCPv6 Stateless                                          |                      |is also necessary for VMs to configure the default route.                 |
-  |3. DHCPv6 Stateful                                           |                      |                                                                          |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |When using ODL for L2 forwarding/tunneling, it is compatible |Yes                   |                                                                          |
-  |with IPv6.                                                   |                      |                                                                          |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |Full support for IPv6 matching (i.e., IPv6, ICMPv6, TCP, UDP)|**No**                |Security Groups for IPv6 is a work in progress.                           |
-  |in security groups. Ability to control and manage all IPv6   |                      |                                                                          |
-  |security group capabilities via Neutron/Nova API (REST and   |                      |                                                                          |
-  |CLI) as well as via Horizon.                                 |                      |                                                                          |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |Shared Networks support                                      |Yes                   |                                                                          |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |IPv6 external L2 VLAN directly attached to a VM.             |**ToDo**              |                                                                          |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-  |ODL on an IPv6 only Infrastructure.                          |**ToDo**              |Deploying OpenStack with ODL on an IPv6 only infrastructure where the API |
-  |                                                             |                      |endpoints are all IPv6 addresses.                                         |
-  +-------------------------------------------------------------+----------------------+--------------------------------------------------------------------------+
-
+  +--------------------------------------------------+---------------------------------------------+--------------------------------------------------------------+
+  |Use Case / Requirement                            |           Supported in ODL Boron            |Notes                                                         |
+  |                                                  +---------------------+-----------------------+                                                              |
+  |                                                  |     Old Netvirt     |      New Netvirt      |                                                              |
+  |                                                  |(odl-ovsdb-openstack)|(odl-netvirt-openstack)|                                                              |
+  +==================================================+=====================+=======================+==============================================================+
+  |REST API support for IPv6 subnet creation in ODL  |Yes                  |Yes                    |Yes, it is possible to create IPv6 subnets in ODL using       |
+  |                                                  |                     |                       |Neutron REST API.                                             |
+  |                                                  |                     |                       |                                                              |
+  |                                                  |                     |                       |For a network which has both IPv4 and IPv6 subnets, ODL       |
+  |                                                  |                     |                       |mechanism driver will send the port information which includes|
+  |                                                  |                     |                       |IPv4/v6 addresses to ODL Neutron northbound API. When port    |
+  |                                                  |                     |                       |information is queried it displays IPv4 and IPv6 addresses.   |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |IPv6 Router support in ODL                        |**No**               |**Partial**            |IPv6 Router support is work in progress in ODL.               |
+  |                                                  |                     |                       |                                                              |
+  |1. Communication between VMs on same compute node |                     |                       |Currently communication between VMs on the same network is    |
+  |2. Communication between VMs on different compute |                     |                       |supported, and the support for the other modes is work in     |
+  |   nodes (east-west)                              |                     |                       |progress.                                                     |
+  |3. External routing (north-south)                 |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |IPAM: Support for IPv6 Address assignment modes.  |**No**               |Yes                    |ODL IPv6 Router supports all the IPv6 Address assignment modes|
+  |                                                  |                     |                       |along with Neutron DHCP Agent.                                |
+  |1. SLAAC                                          |                     |                       |                                                              |
+  |2. DHCPv6 Stateless                               |                     |                       |                                                              |
+  |3. DHCPv6 Stateful                                |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |When using ODL for L2 forwarding/tunneling, it is |Yes                  |Yes                    |                                                              |
+  |compatible with IPv6.                             |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |Full support for IPv6 matching (i.e. IPv6, ICMPv6,|**Partial**          |**Partial**            |Security Groups for IPv6 is a work in progress, and some      |
+  |TCP, UDP) in security groups. Ability to control  |                     |                       |partial support is available.                                 |
+  |and manage all IPv6 security group capabilities   |                     |                       |                                                              |
+  |via Neutron/Nova API (REST and CLI) as well as via|                     |                       |                                                              |
+  |Horizon                                           |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |Shared Networks support                           |Yes                  |Yes                    |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |IPv6 external L2 VLAN directly attached to a VM.  |**ToDo**             |**ToDo**               |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |ODL on an IPv6 only Infrastructure.               |**No**               |**Work in Progress**   |Deploying OpenStack with ODL on an IPv6 only infrastructure   |
+  |                                                  |                     |                       |where the API endpoints are all IPv6 addresses.               |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+

diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst
index 4cc5278..12e7b91 100644 (file)
--- a/docs/userguide/featureusage.rst
+++ b/docs/userguide/featureusage.rst
@@ -142,51 +142,53 @@ There are 2 options in Open Daylight Boron to provide Virtualized Networks:
 1 ``Old Netvirt``: netvirt implementation used in Open Daylight Beryllium Release
   identified by feature ``odl-ovsdb-openstack``
 
-2 ``New Netvirt``: netvirt implementation which will replace the Old Netvirt in the future
-  releases based on a more modular design. It is identified by feature
+2 ``New Netvirt``: netvirt implementation which will replace the Old Netvirt in the
+  future releases based on a more modular design. It is identified by feature
   ``odl-netvirt-openstack``
 
 .. table::
   :class: longtable
 
-  +-------------------------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------+
-  |Use Case / Requirement                                       |           Supported in ODL Boron            |Notes                                                                     |
-  |                                                             +---------------------+-----------------------+                                                                          |
-  |                                                             |     Old Netvirt     |      New Netvirt      |                                                                          |
-  |                                                             |(odl-ovsdb-openstack)|(odl-netvirt-openstack)|                                                                          |
-  +=============================================================+=====================+=======================+==========================================================================+
-  |REST API support for IPv6 subnet creation in ODL             |Yes                  |Yes                    |Yes, it is possible to create IPv6 subnets in ODL using Neutron REST API. |
-  |                                                             |                     |                       |                                                                          |
-  |                                                             |                     |                       |For a network which has both IPv4 and IPv6 subnets, ODL mechanism driver  |
-  |                                                             |                     |                       |will send the port information which includes IPv4/v6 addresses to ODL    |
-  |                                                             |                     |                       |Neutron northbound API. When port information is queried it displays IPv4 |
-  |                                                             |                     |                       |and IPv6 addresses.                                                       |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
-  |IPv6 Router support in ODL                                   |**No**               |**Partial**            |IPv6 Router support is work in progress in ODL.                           |
-  |                                                             |                     |                       |                                                                          |
-  |1. Communication between VMs on same compute node            |                     |                       |Currently communication between VMs on the same network is supported, and |
-  |2. Communication between VMs on different compute nodes      |                     |                       |the support for the other modes is work in progress                       |
-  |   (east-west)                                               |                     |                       |                                                                          |
-  |3. External routing (north-south)                            |                     |                       |                                                                          |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
-  |IPAM: Support for IPv6 Address assignment modes.             |**No**               |Yes                    |ODL IPv6 Router supports all the IPv6 Address assignment modes along with |
-  |                                                             |                     |                       |Neutron DHCP Agent.                                                       |
-  |1. SLAAC                                                     |                     |                       |                                                                          |
-  |2. DHCPv6 Stateless                                          |                     |                       |                                                                          |
-  |3. DHCPv6 Stateful                                           |                     |                       |                                                                          |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
-  |When using ODL for L2 forwarding/tunneling, it is compatible |Yes                  |Yes                    |                                                                          |
-  |with IPv6.                                                   |                     |                       |                                                                          |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
-  |Full support for IPv6 matching (i.e., IPv6, ICMPv6, TCP, UDP)|**Partial**          |**Partial**            |Security Groups for IPv6 is a work in progress.                           |
-  |in security groups. Ability to control and manage all IPv6   |                     |                       |                                                                          |
-  |security group capabilities via Neutron/Nova API (REST and   |                     |                       |                                                                          |
-  |CLI) as well as via Horizon.                                 |                     |                       |                                                                          |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
-  |Shared Networks support                                      |Yes                  |Yes                    |                                                                          |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
-  |IPv6 external L2 VLAN directly attached to a VM.             |**ToDo**             |**ToDo**               |                                                                          |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
-  |ODL on an IPv6 only Infrastructure.                          |**No**               |**Work in Progress**   |Deploying OpenStack with ODL on an IPv6 only infrastructure where the API |
-  |                                                             |                     |                       |endpoints are all IPv6 addresses.                                         |
-  +-------------------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------------------+
+  +--------------------------------------------------+---------------------------------------------+--------------------------------------------------------------+
+  |Use Case / Requirement                            |           Supported in ODL Boron            |Notes                                                         |
+  |                                                  +---------------------+-----------------------+                                                              |
+  |                                                  |     Old Netvirt     |      New Netvirt      |                                                              |
+  |                                                  |(odl-ovsdb-openstack)|(odl-netvirt-openstack)|                                                              |
+  +==================================================+=====================+=======================+==============================================================+
+  |REST API support for IPv6 subnet creation in ODL  |Yes                  |Yes                    |Yes, it is possible to create IPv6 subnets in ODL using       |
+  |                                                  |                     |                       |Neutron REST API.                                             |
+  |                                                  |                     |                       |                                                              |
+  |                                                  |                     |                       |For a network which has both IPv4 and IPv6 subnets, ODL       |
+  |                                                  |                     |                       |mechanism driver will send the port information which includes|
+  |                                                  |                     |                       |IPv4/v6 addresses to ODL Neutron northbound API. When port    |
+  |                                                  |                     |                       |information is queried it displays IPv4 and IPv6 addresses.   |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |IPv6 Router support in ODL                        |**No**               |**Partial**            |IPv6 Router support is work in progress in ODL.               |
+  |                                                  |                     |                       |                                                              |
+  |1. Communication between VMs on same compute node |                     |                       |Currently communication between VMs on the same network is    |
+  |2. Communication between VMs on different compute |                     |                       |supported, and the support for the other modes is work in     |
+  |   nodes (east-west)                              |                     |                       |progress.                                                     |
+  |3. External routing (north-south)                 |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |IPAM: Support for IPv6 Address assignment modes.  |**No**               |Yes                    |ODL IPv6 Router supports all the IPv6 Address assignment modes|
+  |                                                  |                     |                       |along with Neutron DHCP Agent.                                |
+  |1. SLAAC                                          |                     |                       |                                                              |
+  |2. DHCPv6 Stateless                               |                     |                       |                                                              |
+  |3. DHCPv6 Stateful                                |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |When using ODL for L2 forwarding/tunneling, it is |Yes                  |Yes                    |                                                              |
+  |compatible with IPv6.                             |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |Full support for IPv6 matching (i.e. IPv6, ICMPv6,|**Partial**          |**Partial**            |Security Groups for IPv6 is a work in progress, and some      |
+  |TCP, UDP) in security groups. Ability to control  |                     |                       |partial support is available.                                 |
+  |and manage all IPv6 security group capabilities   |                     |                       |                                                              |
+  |via Neutron/Nova API (REST and CLI) as well as via|                     |                       |                                                              |
+  |Horizon                                           |                     |                       |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |Shared Networks support                           |Yes                  |Yes                    |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |IPv6 external L2 VLAN directly attached to a VM.  |**ToDo**             |**ToDo**               |                                                              |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+
+  |ODL on an IPv6 only Infrastructure.               |**No**               |**Work in Progress**   |Deploying OpenStack with ODL on an IPv6 only infrastructure   |
+  |                                                  |                     |                       |where the API endpoints are all IPv6 addresses.               |
+  +--------------------------------------------------+---------------------+-----------------------+--------------------------------------------------------------+