Global review of the NetReady requirements document

This patchset enables a global review of the entire NetReady
requirements document. Changes to the document shall be pushed
as new patches to this patchset.

Change-Id: I7cc9290c9260aad5b687253b02d60efbc8a64bb2
Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>

1 files changed, 54 insertions, 0 deletions

diff --git a/docs/requirements/use_cases/georedundancy_regions_insances.rst b/docs/requirements/use_cases/georedundancy_regions_insances.rst
new file mode 100644
index 0000000..e3faf2d
--- /dev/null
+++ b/docs/requirements/use_cases/georedundancy_regions_insances.rst
@@ -0,0 +1,54 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Connection between different OpenStack regions or cloud instances
+-----------------------------------------------------------------
+
+Description
+~~~~~~~~~~~
+There should be an API to manage the infrastructure networks between two
+OpenStack regions or instances.
+
+The following figure (:numref:`instances-architecture`) shows the architecture
+of the most relevant OpenStack components in multi instance OpenStack
+environment.
+
+.. figure:: images/instances-architecture.png
+    :name:  instances-architecture
+    :width: 50%
+
+The functionality behind the API depends on the underlying network providers (SDN
+controllers) and the networking setup.
+(For example OpenDaylight has an API to add new BGP neighbor.)
+
+OpenStack Neutron should provide an abstracted API for this functionality what
+calls the underlying SDN controllers API.
+
+Derived Requirements
+~~~~~~~~~~~~~~~~~~~~~
+- Possibility to define a remote and a local endpoint
+- As in case of cells the nova-api service is shared. It should be possible
+  to identify the cell in the API calls
+
+Northbound API / Workflow
++++++++++++++++++++++++++
+- An infrastructure network management API is needed
+- API call to define the remote and local infrastructure endpoints
+- When the endpoints are created Neutron is configured to use the new network.
+
+Data model objects
+++++++++++++++++++
+- local and remote endpoint objects (Most probably IP addresses with some
+additional properties).
+
+Current implementation
+~~~~~~~~~~~~~~~~~~~~~~
+  Current OpenStack implementation provides no way to set up the underlay
+  network connection.
+  OpenStack Tricircle project [TRICIRCLE]_
+  has plans to build up inter datacenter L2 and L3 networks.
+
+Gaps in the current solution
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  An infrastructure management API is missing from Neutron where the local and
+  remote endpoints of the underlay network could be configured.