doc fixes

- update docs uild dir in .gitignore

- fix filename for user guide
  https://wiki.opnfv.org/documentation/userguide

Change-Id: I1ea7e1e4189ecdc509bfaa12b36d5d771d64f700
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

1 files changed, 186 insertions, 0 deletions

diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst
new file mode 100644
index 0000000..d37fadb
--- /dev/null
+++ b/docs/userguide/featureusage.rst
@@ -0,0 +1,186 @@
+.. 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)
+
+=========================================
+Using IPv6 Feature of Brahmaputra Release
+=========================================
+
+This section provides the users with gap analysis regarding IPv6 feature requirements with
+OpenStack Kilo Official Release and Open Daylight Lithium 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.
+
+*************************************
+IPv6 Gap Analysis with OpenStack Kilo
+*************************************
+
+This section provides users with IPv6 gap analysis regarding feature requirement with
+OpenStack Neutron in Kilo 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 Kilo Official Release.
+
+.. table::
+  :class: longtable
+
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+  |Use Case / Requirement                                     |Supported in Kilo Neutron|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 in Kilo to allow easier setup of the      |
+  |                                                           |1. Yes                   |upstream gateway, without the user forced to create an IPv6 subnet  |
+  |1. Both VLAN and overlay (e.g. GRE, VXLAN) subnet attached |                         |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)                   |
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+  |Full support for IPv6 matching (i.e., IPv6, ICMPv6, TCP,   |Yes                      |                                                                    |
+  |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.                           |                         |                                                                    |
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+  |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 rough 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.            |                         |                                                                    |
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+  |Support for IPv6 Prefix Delegation.                        |**Roadmap**              |Some partial support is available in Liberty release                |
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+  |Distributed Virtual Routing (DVR) support for IPv6         |**No**                   |Blueprint proposed upstream, pending discussion.                    |
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+  |IPv6 First-Hop Security, IPv6 ND spoofing.                 |**Roadmap**              |Supported in Liberty release                                        |
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+  |IPv6 support in Neutron Layer3 High Availability           |Yes                      |                                                                    |
+  |(keepalived+VRRP).                                         |                         |                                                                    |
+  +-----------------------------------------------------------+-------------------------+--------------------------------------------------------------------+
+
+********************************************
+IPv6 Gap Analysis with Open Daylight Lithium
+********************************************
+
+This section provides users with IPv6 gap analysis regarding feature requirement with
+Open Daylight Lithium 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 Lithium Official Release.
+
+.. table::
+  :class: longtable
+
+  +-------------------------------------------------------------+------------------------+--------------------------------------------------------------------------------+
+  |Use Case / Requirement                                       |Supported in ODL Lithium|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 Lithium 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 Lithium release only supports IPv4 Router.             |
+  |                                                             |                        |Support for IPv6 Router is planned in later releases using ``Routing Manager``. |
+  |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)                            |                        |**Note**: In Lithium SR3 release, we have the following `issue                  |
+  |                                                             |                        |<http://lists.opendaylight.org/pipermail/ovsdb-dev/2015-November/002288.html>`_,|
+  |                                                             |                        |which is fixed `upstream <http://git.opendaylight.org/gerrit/#/c/30253/4>`_     |
+  |                                                             |                        |and `back-ported <http://git.opendaylight.org/gerrit/#/c/30474>`_ to            |
+  |                                                             |                        |``stable/lithium`` branch on December 15th, 2015.                               |
+  +-------------------------------------------------------------+------------------------+--------------------------------------------------------------------------------+
+  |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, is it compatible |Yes                     |                                                                                |
+  |with IPv6.                                                   |                        |                                                                                |
+  +-------------------------------------------------------------+------------------------+--------------------------------------------------------------------------------+
+  |Full support for IPv6 matching (i.e., IPv6, ICMPv6, TCP, UDP)|**No**                  |Security Groups for IPv6 are currently not supported.                           |
+  |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                                      |**No**                  |ODL currently assumes a single tenant to network mapping and does not           |
+  |                                                             |                        |support shared networks among tenants.                                          |
+  +-------------------------------------------------------------+------------------------+--------------------------------------------------------------------------------+
+  |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.                                               |
+  +-------------------------------------------------------------+------------------------+--------------------------------------------------------------------------------+
+