Split Gap Analysis into 2 files

One for OpenStack Newton, and the other for ODL Boron.

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

3 files changed, 230 insertions, 216 deletions

diff --git a/docs/release/userguide/gap-odl-boron.rst b/docs/release/userguide/gap-odl-boron.rst
new file mode 100644
index 0000000..a6599e6
--- /dev/null
+++ b/docs/release/userguide/gap-odl-boron.rst
@@ -0,0 +1,82 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Bin Hu (AT&T) and Sridhar Gaddam (RedHat)
+
+==========================================
+IPv6 Gap Analysis with Open Daylight Boron
+==========================================
+
+This section provides users with IPv6 gap analysis regarding feature requirement with
+Open Daylight Boron Official Release. The following table lists the use cases / feature
+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                                                         |
+  |                                                  +----------------------+------------------------+                                                              |
+  |                                                  |     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**                |Yes                     |                                                              |
+  |                                                  |                      |                        |                                                              |
+  |1. Communication between VMs on same network      |                      |                        |                                                              |
+  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
+  |IPv6 Router support in ODL:                       |**No**                |Yes                     |                                                              |
+  |                                                  |                      |                        |                                                              |
+  |2. Communication between VMs on different         |                      |                        |                                                              |
+  |   networks connected to the same router          |                      |                        |                                                              |
+  |   (east-west)                                    |                      |                        |                                                              |
+  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
+  |IPv6 Router support in ODL:                       |**No**                |**Work in Progress**    |Work in 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**           |Yes                     |Security Groups for IPv6 is supported in the new NetVirt.     |
+  |TCP, UDP) 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.               |
+  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
+  |VxLAN Tunnels with IPv6 Endpoints                 |**No**                |**Work in Progress**    |The necessary patches are under review to support this use    |
+  |                                                  |                      |                        |case for OVS 2.6 or higher version.                           |
+  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
+
diff --git a/docs/release/userguide/gap-os-newton.rst b/docs/release/userguide/gap-os-newton.rst
new file mode 100644
index 0000000..2c075c5
--- /dev/null
+++ b/docs/release/userguide/gap-os-newton.rst
@@ -0,0 +1,139 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Bin Hu (AT&T) and Sridhar Gaddam (RedHat)
+
+=======================================
+IPv6 Gap Analysis with OpenStack Newton
+=======================================
+
+This section provides users with IPv6 gap analysis regarding feature requirement with
+OpenStack Neutron in Newton Official Release. The following table lists the use cases / feature
+requirements of VIM-agnostic IPv6 functionality, including infrastructure layer and VNF
+(VM) layer, and its gap analysis with OpenStack Neutron in Newton Official Release.
+
+.. table::
+  :class: longtable
+
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Use Case / Requirement                                     |Supported in Newton|Notes                                                               |
+  +===========================================================+===================+====================================================================+
+  |All topologies work in a multi-tenant environment          |Yes                |The IPv6 design is following the Neutron tenant networks model;     |
+  |                                                           |                   |dnsmasq is being used inside DHCP network namespaces, while radvd   |
+  |                                                           |                   |is being used inside Neutron routers namespaces to provide full     |
+  |                                                           |                   |isolation between tenants. Tenant isolation can be based on VLANs,  |
+  |                                                           |                   |GRE, or VXLAN encapsulation. In case of overlays, the transport     |
+  |                                                           |                   |network (and VTEPs) must be IPv4 based as of today.                 |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |IPv6 VM to VM only                                         |Yes                |It is possible to assign IPv6-only addresses to VMs. Both switching |
+  |                                                           |                   |(within VMs on the same tenant network) as well as east/west routing|
+  |                                                           |                   |(between different networks of the same tenant) are supported.      |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |IPv6 external L2 VLAN directly attached to a VM            |Yes                |IPv6 provider network model; RA messages from upstream (external)   |
+  |                                                           |                   |router are forwarded into the VMs                                   |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |IPv6 subnet routed via L3 agent to an external IPv6 network|                   |Configuration is enhanced since Kilo to allow easier setup of the   |
+  |                                                           |1. Yes             |upstream gateway, without the user being forced to create an IPv6   |
+  |1. Both VLAN and overlay (e.g. GRE, VXLAN) subnet attached |                   |subnet for the external network.                                    |
+  |   to VMs;                                                 |                   |                                                                    |
+  |2. Must be able to support multiple L3 agents for a given  |2. Yes             |                                                                    |
+  |   external network to support scaling (neutron scheduler  |                   |                                                                    |
+  |   to assign vRouters to the L3 agents)                    |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Ability for a NIC to support both IPv4 and IPv6 (dual      |                   |Dual-stack is supported in Neutron with the addition of             |
+  |stack) address.                                            |                   |``Multiple IPv6 Prefixes`` Blueprint                                |
+  |                                                           |                   |                                                                    |
+  |1. VM with a single interface associated with a network,   |1. Yes             |                                                                    |
+  |   which is then associated with two subnets.              |                   |                                                                    |
+  |2. VM with two different interfaces associated with two    |2. Yes             |                                                                    |
+  |   different networks and two different subnets.           |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Support IPv6 Address assignment modes.                     |1. Yes             |                                                                    |
+  |                                                           |                   |                                                                    |
+  |1. SLAAC                                                   |2. Yes             |                                                                    |
+  |2. DHCPv6 Stateless                                        |                   |                                                                    |
+  |3. DHCPv6 Stateful                                         |3. Yes             |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Ability to create a port on an IPv6 DHCPv6 Stateful subnet |Yes                |                                                                    |
+  |and assign a specific IPv6 address to the port and have it |                   |                                                                    |
+  |taken out of the DHCP address pool.                        |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Ability to create a port with fixed_ip for a               |**No**             |The following patch disables this operation:                        |
+  |SLAAC/DHCPv6-Stateless Subnet.                             |                   |https://review.openstack.org/#/c/129144/                            |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Support for private IPv6 to external IPv6 floating IP;     |**Rejected**       |Blueprint proposed in upstream and got rejected. General expectation|
+  |Ability to specify floating IPs via Neutron API (REST and  |                   |is to avoid NAT with IPv6 by assigning GUA to tenant VMs. See       |
+  |CLI) as well as via Horizon, including combination of      |                   |https://review.openstack.org/#/c/139731/ for discussion.            |
+  |IPv6/IPv4 and IPv4/IPv6 floating IPs if implemented.       |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Provide IPv6/IPv4 feature parity in support for            |**To-Do**          |The L3 configuration should be transparent for the SR-IOV           |
+  |pass-through capabilities (e.g., SR-IOV).                  |                   |implementation. SR-IOV networking support introduced in Juno based  |
+  |                                                           |                   |on the ``sriovnicswitch`` ML2 driver is expected to work with IPv4  |
+  |                                                           |                   |and IPv6 enabled VMs. We need to verify if it works or not.         |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Additional IPv6 extensions, for example: IPSEC, IPv6       |**No**             |It does not appear to be considered yet (lack of clear requirements)|
+  |Anycast, Multicast                                         |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |VM access to the meta-data server to obtain user data, SSH |**No**             |This is currently not supported. Config-drive or dual-stack IPv4 /  |
+  |keys, etc. using cloud-init with IPv6 only interfaces.     |                   |IPv6 can be used as a workaround (so that the IPv4 network is used  |
+  |                                                           |                   |to obtain connectivity with the metadata service). The following    |
+  |                                                           |                   |blog `How to Use Config-Drive for Metadata with IPv6 Network        |
+  |                                                           |                   |<http://superuser.openstack.org/articles/deploying-ipv6-only-tenants|
+  |                                                           |                   |-with-openstack/>`_ provides a neat summary on how to use           |
+  |                                                           |                   |config-drive for metadata with IPv6 network.                        |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Full support for IPv6 matching (i.e., IPv6, ICMPv6, TCP,   |Yes                |Both IPTables firewall driver and OVS firewall driver support IPv6  |
+  |UDP) in security groups. Ability to control and manage all |                   |Security Group API.                                                 |
+  |IPv6 security group capabilities via Neutron/Nova API (REST|                   |                                                                    |
+  |and CLI) as well as via Horizon.                           |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |During network/subnet/router create, there should be an    |Yes                |Two new Subnet attributes were introduced to control IPv6 address   |
+  |option to allow user to specify the type of address        |                   |assignment options:                                                 |
+  |management they would like. This includes all options      |                   |                                                                    |
+  |including those low priority if implemented (e.g., toggle  |                   |* ``ipv6-ra-mode``: to determine who sends Router Advertisements;   |
+  |on/off router and address prefix advertisements); It must  |                   |                                                                    |
+  |be supported via Neutron API (REST and CLI) as well as via |                   |* ``ipv6-address-mode``: to determine how VM obtains IPv6 address,  |
+  |Horizon                                                    |                   |  default gateway, and/or optional information.                     |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Security groups anti-spoofing: Prevent VM from using a     |Yes                |                                                                    |
+  |source IPv6/MAC address which is not assigned to the VM    |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Protect tenant and provider network from rogue RAs         |Yes                |When using a tenant network, Neutron is going to automatically      |
+  |                                                           |                   |handle the filter rules to allow connectivity of RAs to the VMs only|
+  |                                                           |                   |from the Neutron router port; with provider networks, users are     |
+  |                                                           |                   |required to specify the LLA of the upstream router during the subnet|
+  |                                                           |                   |creation, or otherwise manually edit the security-groups rules to   |
+  |                                                           |                   |allow incoming traffic from this specific address.                  |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Support the ability to assign multiple IPv6 addresses to   |Yes                |                                                                    |
+  |an interface; both for Neutron router interfaces and VM    |                   |                                                                    |
+  |interfaces.                                                |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Ability for a VM to support a mix of multiple IPv4 and IPv6|Yes                |                                                                    |
+  |networks, including multiples of the same type.            |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |IPv6 Support in "Allowed Address Pairs" Extension          |Yes                |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Support for IPv6 Prefix Delegation.                        |Yes                |Partial support in Newton                                           |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |Distributed Virtual Routing (DVR) support for IPv6         |**No**             |In Newton DVR implementation, IPv6 works. But all the IPv6 ingress/ |
+  |                                                           |                   |egress traffic is routed via the centralized controller node, i.e.  |
+  |                                                           |                   |similar to SNAT traffic.                                            |
+  |                                                           |                   |A fully distributed IPv6 router is not yet supported in Neutron.    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |VPNaaS                                                     |Yes                |VPNaaS supports IPv6. But this feature is not extensively tested.   |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |FWaaS                                                      |Yes                |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |BGP Dynamic Routing Support for IPv6 Prefixes              |Yes                |BGP Dynamic Routing supports peering via IPv6 and advertising IPv6  |
+  |                                                           |                   |prefixes.                                                           |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |VxLAN Tunnels with IPv6 endpoints.                         |Yes                |Neutron ML2/OVS supports configuring local_ip with IPv6 address so  |
+  |                                                           |                   |that VxLAN tunnels are established with IPv6 addresses. This        |
+  |                                                           |                   |feature requires OVS 2.6 or higher version.                         |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |IPv6 First-Hop Security, IPv6 ND spoofing                  |Yes                |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+  |IPv6 support in Neutron Layer3 High Availability           |Yes                |                                                                    |
+  |(keepalived+VRRP).                                         |                   |                                                                    |
+  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
+
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
index 72434da..403dad7 100644
--- a/docs/release/userguide/index.rst
+++ b/docs/release/userguide/index.rst
@@ -8,227 +8,20 @@
 Using IPv6 Feature of Danube Release
 ====================================
 
+:Abstract:
+
 This section provides the users with gap analysis regarding IPv6 feature requirements with
 OpenStack Newton Official Release and Open Daylight Boron Official Release. The gap analysis
 serves as feature specific user guides and references when as a user you may leverage the
 IPv6 feature in the platform and need to perform some IPv6 related operations.
 
-For more information, please find Neutron's IPv6 document for Newton Release [1]_.
-
-***************************************
-IPv6 Gap Analysis with OpenStack Newton
-***************************************
-
-This section provides users with IPv6 gap analysis regarding feature requirement with
-OpenStack Neutron in Newton Official Release. The following table lists the use cases / feature
-requirements of VIM-agnostic IPv6 functionality, including infrastructure layer and VNF
-(VM) layer, and its gap analysis with OpenStack Neutron in Newton Official Release.
-
-.. table::
-  :class: longtable
-
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Use Case / Requirement                                     |Supported in Newton|Notes                                                               |
-  +===========================================================+===================+====================================================================+
-  |All topologies work in a multi-tenant environment          |Yes                |The IPv6 design is following the Neutron tenant networks model;     |
-  |                                                           |                   |dnsmasq is being used inside DHCP network namespaces, while radvd   |
-  |                                                           |                   |is being used inside Neutron routers namespaces to provide full     |
-  |                                                           |                   |isolation between tenants. Tenant isolation can be based on VLANs,  |
-  |                                                           |                   |GRE, or VXLAN encapsulation. In case of overlays, the transport     |
-  |                                                           |                   |network (and VTEPs) must be IPv4 based as of today.                 |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |IPv6 VM to VM only                                         |Yes                |It is possible to assign IPv6-only addresses to VMs. Both switching |
-  |                                                           |                   |(within VMs on the same tenant network) as well as east/west routing|
-  |                                                           |                   |(between different networks of the same tenant) are supported.      |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |IPv6 external L2 VLAN directly attached to a VM            |Yes                |IPv6 provider network model; RA messages from upstream (external)   |
-  |                                                           |                   |router are forwarded into the VMs                                   |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |IPv6 subnet routed via L3 agent to an external IPv6 network|                   |Configuration is enhanced since Kilo to allow easier setup of the   |
-  |                                                           |1. Yes             |upstream gateway, without the user being forced to create an IPv6   |
-  |1. Both VLAN and overlay (e.g. GRE, VXLAN) subnet attached |                   |subnet for the external network.                                    |
-  |   to VMs;                                                 |                   |                                                                    |
-  |2. Must be able to support multiple L3 agents for a given  |2. Yes             |                                                                    |
-  |   external network to support scaling (neutron scheduler  |                   |                                                                    |
-  |   to assign vRouters to the L3 agents)                    |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Ability for a NIC to support both IPv4 and IPv6 (dual      |                   |Dual-stack is supported in Neutron with the addition of             |
-  |stack) address.                                            |                   |``Multiple IPv6 Prefixes`` Blueprint                                |
-  |                                                           |                   |                                                                    |
-  |1. VM with a single interface associated with a network,   |1. Yes             |                                                                    |
-  |   which is then associated with two subnets.              |                   |                                                                    |
-  |2. VM with two different interfaces associated with two    |2. Yes             |                                                                    |
-  |   different networks and two different subnets.           |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Support IPv6 Address assignment modes.                     |1. Yes             |                                                                    |
-  |                                                           |                   |                                                                    |
-  |1. SLAAC                                                   |2. Yes             |                                                                    |
-  |2. DHCPv6 Stateless                                        |                   |                                                                    |
-  |3. DHCPv6 Stateful                                         |3. Yes             |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Ability to create a port on an IPv6 DHCPv6 Stateful subnet |Yes                |                                                                    |
-  |and assign a specific IPv6 address to the port and have it |                   |                                                                    |
-  |taken out of the DHCP address pool.                        |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Ability to create a port with fixed_ip for a               |**No**             |The following patch disables this operation:                        |
-  |SLAAC/DHCPv6-Stateless Subnet.                             |                   |https://review.openstack.org/#/c/129144/                            |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Support for private IPv6 to external IPv6 floating IP;     |**Rejected**       |Blueprint proposed in upstream and got rejected. General expectation|
-  |Ability to specify floating IPs via Neutron API (REST and  |                   |is to avoid NAT with IPv6 by assigning GUA to tenant VMs. See       |
-  |CLI) as well as via Horizon, including combination of      |                   |https://review.openstack.org/#/c/139731/ for discussion.            |
-  |IPv6/IPv4 and IPv4/IPv6 floating IPs if implemented.       |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Provide IPv6/IPv4 feature parity in support for            |**To-Do**          |The L3 configuration should be transparent for the SR-IOV           |
-  |pass-through capabilities (e.g., SR-IOV).                  |                   |implementation. SR-IOV networking support introduced in Juno based  |
-  |                                                           |                   |on the ``sriovnicswitch`` ML2 driver is expected to work with IPv4  |
-  |                                                           |                   |and IPv6 enabled VMs. We need to verify if it works or not.         |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Additional IPv6 extensions, for example: IPSEC, IPv6       |**No**             |It does not appear to be considered yet (lack of clear requirements)|
-  |Anycast, Multicast                                         |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |VM access to the meta-data server to obtain user data, SSH |**No**             |This is currently not supported. Config-drive or dual-stack IPv4 /  |
-  |keys, etc. using cloud-init with IPv6 only interfaces.     |                   |IPv6 can be used as a workaround (so that the IPv4 network is used  |
-  |                                                           |                   |to obtain connectivity with the metadata service). The following    |
-  |                                                           |                   |blog [2]_ provides a neat summary on how to use config-drive for    |
-  |                                                           |                   |metadata with IPv6 network.                                         |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Full support for IPv6 matching (i.e., IPv6, ICMPv6, TCP,   |Yes                |Both IPTables firewall driver and OVS firewall driver support IPv6  |
-  |UDP) in security groups. Ability to control and manage all |                   |Security Group API.                                                 |
-  |IPv6 security group capabilities via Neutron/Nova API (REST|                   |                                                                    |
-  |and CLI) as well as via Horizon.                           |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |During network/subnet/router create, there should be an    |Yes                |Two new Subnet attributes were introduced to control IPv6 address   |
-  |option to allow user to specify the type of address        |                   |assignment options:                                                 |
-  |management they would like. This includes all options      |                   |                                                                    |
-  |including those low priority if implemented (e.g., toggle  |                   |* ``ipv6-ra-mode``: to determine who sends Router Advertisements;   |
-  |on/off router and address prefix advertisements); It must  |                   |                                                                    |
-  |be supported via Neutron API (REST and CLI) as well as via |                   |* ``ipv6-address-mode``: to determine how VM obtains IPv6 address,  |
-  |Horizon                                                    |                   |  default gateway, and/or optional information.                     |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Security groups anti-spoofing: Prevent VM from using a     |Yes                |                                                                    |
-  |source IPv6/MAC address which is not assigned to the VM    |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Protect tenant and provider network from rogue RAs         |Yes                |When using a tenant network, Neutron is going to automatically      |
-  |                                                           |                   |handle the filter rules to allow connectivity of RAs to the VMs only|
-  |                                                           |                   |from the Neutron router port; with provider networks, users are     |
-  |                                                           |                   |required to specify the LLA of the upstream router during the subnet|
-  |                                                           |                   |creation, or otherwise manually edit the security-groups rules to   |
-  |                                                           |                   |allow incoming traffic from this specific address.                  |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Support the ability to assign multiple IPv6 addresses to   |Yes                |                                                                    |
-  |an interface; both for Neutron router interfaces and VM    |                   |                                                                    |
-  |interfaces.                                                |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Ability for a VM to support a mix of multiple IPv4 and IPv6|Yes                |                                                                    |
-  |networks, including multiples of the same type.            |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |IPv6 Support in "Allowed Address Pairs" Extension          |Yes                |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Support for IPv6 Prefix Delegation.                        |Yes                |Partial support in Newton                                           |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |Distributed Virtual Routing (DVR) support for IPv6         |**No**             |In Newton DVR implementation, IPv6 works. But all the IPv6 ingress/ |
-  |                                                           |                   |egress traffic is routed via the centralized controller node, i.e.  |
-  |                                                           |                   |similar to SNAT traffic.                                            |
-  |                                                           |                   |A fully distributed IPv6 router is not yet supported in Neutron.    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |VPNaaS                                                     |Yes                |VPNaaS supports IPv6. But this feature is not extensively tested.   |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |FWaaS                                                      |Yes                |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |BGP Dynamic Routing Support for IPv6 Prefixes              |Yes                |BGP Dynamic Routing supports peering via IPv6 and advertising IPv6  |
-  |                                                           |                   |prefixes.                                                           |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |VxLAN Tunnels with IPv6 endpoints.                         |Yes                |Neutron ML2/OVS supports configuring local_ip with IPv6 address so  |
-  |                                                           |                   |that VxLAN tunnels are established with IPv6 addresses. This        |
-  |                                                           |                   |feature requires OVS 2.6 or higher version.                         |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |IPv6 First-Hop Security, IPv6 ND spoofing                  |Yes                |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-  |IPv6 support in Neutron Layer3 High Availability           |Yes                |                                                                    |
-  |(keepalived+VRRP).                                         |                   |                                                                    |
-  +-----------------------------------------------------------+-------------------+--------------------------------------------------------------------+
-
-******************************************
-IPv6 Gap Analysis with Open Daylight Boron
-******************************************
-
-This section provides users with IPv6 gap analysis regarding feature requirement with
-Open Daylight Boron Official Release. The following table lists the use cases / feature
-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                                                         |
-  |                                                  +----------------------+------------------------+                                                              |
-  |                                                  |     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**                |Yes                     |                                                              |
-  |                                                  |                      |                        |                                                              |
-  |1. Communication between VMs on same network      |                      |                        |                                                              |
-  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
-  |IPv6 Router support in ODL:                       |**No**                |Yes                     |                                                              |
-  |                                                  |                      |                        |                                                              |
-  |2. Communication between VMs on different         |                      |                        |                                                              |
-  |   networks connected to the same router          |                      |                        |                                                              |
-  |   (east-west)                                    |                      |                        |                                                              |
-  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
-  |IPv6 Router support in ODL:                       |**No**                |**Work in Progress**    |Work in 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**           |Yes                     |Security Groups for IPv6 is supported in the new NetVirt.     |
-  |TCP, UDP) 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.               |
-  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
-  |VxLAN Tunnels with IPv6 Endpoints                 |**No**                |**Work in Progress**    |The necessary patches are under review to support this use    |
-  |                                                  |                      |                        |case for OVS 2.6 or higher version.                           |
-  +--------------------------------------------------+----------------------+------------------------+--------------------------------------------------------------+
-
-References
+For more information, please find `Neutron's IPv6 document for Newton Release
+<http://docs.openstack.org/newton/networking-guide/config-ipv6.html>`_.
 
-.. [1] Neutron IPv6 Documentation for Newton Release: http://docs.openstack.org/newton/networking-guide/config-ipv6.html
+.. toctree::
+   :numbered:
+   :maxdepth: 4
 
-.. [2] How to Use Config-Drive for Metadata with IPv6 Network: http://superuser.openstack.org/articles/deploying-ipv6-only-tenants-with-openstack/
+   ./gap-os-newton.rst
+   ./gap-odl-boron.rst