Updates preliminary docs for Euphrates

[apex.git] / docs / release / scenarios / os-odl-nofeature-ha / os-odl-nofeature-ha.rst

diff --git a/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst
new file mode 100644 (file)
index 0000000..1036f77
--- /dev/null
+++ b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst
@@ -0,0 +1,61 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+This document provides scenario level details for Euphrates 1.0 of
+deployment with the OpenDaylight SDN controller and no extra features enabled.
+
+.. contents::
+   :depth: 3
+   :local:
+
+============
+Introduction
+============
+
+This scenario is used primarily to validate and deploy a Newton OpenStack
+deployment with OpenDaylight, and without any NFV features enabled.
+
+Scenario components and composition
+===================================
+
+This scenario is composed of common OpenStack services enabled by default,
+including Nova, Neutron, Glance, Cinder, Keystone, Horizon.  Optionally and
+by default, Tacker and Congress services are also enabled.  Ceph is used as
+the backend storage to Cinder on all deployed nodes.
+
+All services are in HA, meaning that there are multiple cloned instances of
+each service, and they are balanced by HA Proxy using a Virtual IP Address
+per service.
+
+OpenDaylight is also enabled in HA, and forms a cluster.  Neutron
+communicates with a Virtual IP Address for OpenDaylight which is load
+balanced across the OpenDaylight cluster.  Every Open vSwitch node is
+connected to every OpenDaylight for High Availability.
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by using the os-odl-nofeature-ha.yaml deploy
+settings file.
+
+Limitations, Issues and Workarounds
+===================================
+
+* `APEX-112 <https://jira.opnfv.org/browse/APEX-112>`_:
+   ODL routes local subnet traffic to GW
+* `APEX-149 <https://jira.opnfv.org/browse/APEX-149>`_:
+   OpenFlow rules are populated very slowly
+* `APEX-268 <https://jira.opnfv.org/browse/APEX-268>`_:
+   VMs with multiple floating IPs can only access via first NIC
+* `APEX-384 <https://jira.opnfv.org/browse/APEX-384>`_:
+   Not including odl_version in deploy settings causes error
+* `APEX-422 <https://jira.opnfv.org/browse/APEX-422>`_:
+   First nova instance DHCP request fails
+
+References
+==========
+
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
+