Merge "Adds apex owned scenario release notes" into stable/danube

14 files changed, 472 insertions, 0 deletions

diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst
new file mode 100644
index 00000000..1902f8d9
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst
@@ -0,0 +1,15 @@
+.. _os-nosdn-nofeature-ha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+==============================================
+os-nosdn-nofeature-ha overview and description
+==============================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   os-nosdn-nofeature-ha.rst
diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst
new file mode 100644
index 00000000..9956f290
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst
@@ -0,0 +1,47 @@
+.. 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 Danube 1.0 of
+deployment with no 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 without any NFV features or SDN controller 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.
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by using the os-nosdn-nofeature-ha.yaml deploy
+settings file.
+
+Limitations, Issues and Workarounds
+===================================
+
+None
+
+References
+==========
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/release/scenarios/os-nosdn-nofeature-noha/index.rst b/docs/release/scenarios/os-nosdn-nofeature-noha/index.rst
new file mode 100644
index 00000000..8c0e65ed
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-nofeature-noha/index.rst
@@ -0,0 +1,15 @@
+.. _os-nosdn-nofeature-noha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+================================================
+os-nosdn-nofeature-noha overview and description
+================================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   os-nosdn-nofeature-noha.rst
diff --git a/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst
new file mode 100644
index 00000000..6c5c0535
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst
@@ -0,0 +1,44 @@
+.. 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 Danube 1.0 of
+deployment with no 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 without any NFV features or SDN controller 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.
+
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by using the os-nosdn-nofeature-noha.yaml deploy
+settings file.
+
+Limitations, Issues and Workarounds
+===================================
+
+None
+
+References
+==========
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/release/scenarios/os-nosdn-performance-ha/index.rst b/docs/release/scenarios/os-nosdn-performance-ha/index.rst
new file mode 100644
index 00000000..e0dbca7f
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-performance-ha/index.rst
@@ -0,0 +1,15 @@
+.. _os-nosdn-performance-ha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+================================================
+os-nosdn-performance-ha overview and description
+================================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   os-nosdn-performance-ha.rst
diff --git a/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst b/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst
new file mode 100644
index 00000000..8f941286
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst
@@ -0,0 +1,58 @@
+.. 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 Danube 1.0 of
+deployment with no SDN controller and performance options enabled.
+
+.. contents::
+   :depth: 3
+   :local:
+
+============
+Introduction
+============
+
+This scenario is used primarily to demonstrate the performance settings and
+capabilities in Apex. This scenario will  deploy a Newton OpenStack
+deployment without any NFV features or SDN controller 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.
+
+The main purpose of this scenario is to serve as an example to show how to
+set optional performance settings in an Apex deploy settings file.
+
+Scenario usage overview
+=======================
+
+The performance options listed in os-nosdn-performance-ha.yaml give an example
+of the different options a user can set in any deploy settings file.  Some
+of these performance options are actually required for other scenarios which
+rely on DPDK.  Options under the nova section like 'libvirtpin' allow a
+user to choose which core to pin nova instances to on the overcloud compute
+node.  Options under 'kernel' allow a user to set kernel specific arguments
+at boot, which include options like hugepages, isolcpus, enabling iommu, etc.
+
+
+Limitations, Issues and Workarounds
+===================================
+
+* `APEX-389 <https://jira.opnfv.org/browse/APEX-389>`_:
+   Compute kernel parameters are applied to all nodes
+
+References
+==========
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/release/scenarios/os-odl_l3-csit-noha/index.rst b/docs/release/scenarios/os-odl_l3-csit-noha/index.rst
new file mode 100644
index 00000000..29483b0f
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-csit-noha/index.rst
@@ -0,0 +1,15 @@
+.. _os-odl_l3-csit-noha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+============================================
+os-odl_l3-csit-noha overview and description
+============================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   os-odl_l3-csit-noha.rst
diff --git a/docs/release/scenarios/os-odl_l3-csit-noha/os-odl_l3-csit-noha.rst b/docs/release/scenarios/os-odl_l3-csit-noha/os-odl_l3-csit-noha.rst
new file mode 100644
index 00000000..7511a558
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-csit-noha/os-odl_l3-csit-noha.rst
@@ -0,0 +1,58 @@
+.. 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 Danube 1.0 of
+deployment with the OpenDaylight SDN controller and only CSIT relevant
+features enabled.
+
+.. contents::
+   :depth: 3
+   :local:
+
+============
+Introduction
+============
+
+This scenario is used primarily to validate and deploy a minimum Newton
+OpenStack + OpenDaylight deployment with only required OpenStack services.
+
+Scenario components and composition
+===================================
+
+This scenario is composed of only required OpenStack services enabled by
+default, including Nova, Neutron, Glance, and Keystone. OpenDaylight is also
+enabled.  File storage is used as the backend to Glance.
+
+The purpose of this file is to deploy a minimum OpenStack setup that will
+still be able to exercise OpenDaylight.  The use case for this scenario is
+to be able to test OpenDaylight quickly in an environment with low
+CPU/Memory requirements.
+
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by using the os-odl_l3-csit-noha.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 Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/release/scenarios/os-odl_l3-nofeature-ha/index.rst b/docs/release/scenarios/os-odl_l3-nofeature-ha/index.rst
new file mode 100644
index 00000000..7d02fff4
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-nofeature-ha/index.rst
@@ -0,0 +1,15 @@
+.. _os-odl_l3-nofeature-ha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+===============================================
+os-odl_l3-nofeature-ha overview and description
+===============================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   os-odl_l3-nofeature-ha.rst
diff --git a/docs/release/scenarios/os-odl_l3-nofeature-ha/os-odl_l3-nofeature-ha.rst b/docs/release/scenarios/os-odl_l3-nofeature-ha/os-odl_l3-nofeature-ha.rst
new file mode 100644
index 00000000..69df973c
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-nofeature-ha/os-odl_l3-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 Danube 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 acrosss 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_l3-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 Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/release/scenarios/os-odl_l3-nofeature-noha/index.rst b/docs/release/scenarios/os-odl_l3-nofeature-noha/index.rst
new file mode 100644
index 00000000..182174e3
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-nofeature-noha/index.rst
@@ -0,0 +1,15 @@
+.. _os-odl_l3-nofeature-noha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+=================================================
+os-odl_l3-nofeature-noha overview and description
+=================================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   os-odl_l3-nofeature-noha.rst
diff --git a/docs/release/scenarios/os-odl_l3-nofeature-noha/os-odl_l3-nofeature-noha.rst b/docs/release/scenarios/os-odl_l3-nofeature-noha/os-odl_l3-nofeature-noha.rst
new file mode 100644
index 00000000..7b4ebbee
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-nofeature-noha/os-odl_l3-nofeature-noha.rst
@@ -0,0 +1,55 @@
+.. 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 Danube 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.
+
+Only a single controller is deployed in this scenario, which also includes
+the OpenDaylight service on it.
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by using the os-odl_l3-nofeature-noha.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 Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/release/scenarios/os-ovn-nofeature-noha/index.rst b/docs/release/scenarios/os-ovn-nofeature-noha/index.rst
new file mode 100644
index 00000000..74545044
--- /dev/null
+++ b/docs/release/scenarios/os-ovn-nofeature-noha/index.rst
@@ -0,0 +1,15 @@
+.. _os-ovn-nofeature-noha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+==============================================
+os-ovn-nofeature-noha overview and description
+==============================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   os-ovn-nofeature-noha.rst
diff --git a/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst b/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst
new file mode 100644
index 00000000..24de23bb
--- /dev/null
+++ b/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst
@@ -0,0 +1,44 @@
+.. 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 Danube 1.0 of
+deployment with the OVN 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 the OVN SDN controller, 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.
+
+Scenario usage overview
+=======================
+
+Simply deploy this scenario by using the os-ovn-nofeature-noha.yaml deploy
+settings file.
+
+Limitations, Issues and Workarounds
+===================================
+
+* `APEX-430 <https://jira.opnfv.org/browse/APEX-430>`_:
+   OVN HA functionality is not available.
+
+References
+==========
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
+