summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/installationprocedure/architecture.rst87
-rw-r--r--docs/installationprocedure/baremetal.rst14
-rw-r--r--docs/installationprocedure/references.rst2
-rw-r--r--docs/installationprocedure/requirements.rst15
-rw-r--r--docs/installationprocedure/virtualinstall.rst2
-rw-r--r--docs/release-notes/release-notes.rst247
-rw-r--r--docs/releasenotes/index.rst (renamed from docs/release-notes/index.rst)0
-rw-r--r--docs/releasenotes/release-notes.rst384
8 files changed, 477 insertions, 274 deletions
diff --git a/docs/installationprocedure/architecture.rst b/docs/installationprocedure/architecture.rst
index c63da27c..c2b38d00 100644
--- a/docs/installationprocedure/architecture.rst
+++ b/docs/installationprocedure/architecture.rst
@@ -23,6 +23,64 @@ The overcloud is OPNFV. Configuration will be passed into undercloud and
the undercloud will use OpenStack's orchestration component, named Heat, to
execute a deployment that will provision the target OPNFV nodes.
+Apex High Availability Architecture
+===================================
+
+Undercloud
+----------
+
+The undercloud is not Highly Available. End users do not depend on the
+underloud. It is only for management purposes.
+
+Overcloud
+---------
+
+Apex will deploy three control nodes in an HA deployment. Each of these nodes
+will run the following services:
+
+- Stateless OpenStack services
+- MariaDB / Galera
+- RabbitMQ
+- OpenDaylight
+- HA Proxy
+- Pacemaker & VIPs
+
+Stateless OpenStack services
+ All running statesless OpenStack services are load balanced by HA Proxy.
+ Pacemaker monitors the services and ensures that they are running.
+
+Stateful OpenStack services
+ All running stateful OpenStack services are load balanced by HA Proxy.
+ They are monitored by pacemaker in an active/passive failover configuration.
+
+MariaDB / Galera
+ The MariaDB database is replicated across the control nodes using Galera.
+ Pacemaker is responsible for a proper start up of the Galera cluster. HA
+ Proxy provides and active/passive failover methodology to connections to the
+ database.
+
+RabbitMQ
+ The message bus is managed by Pacemaker to ensure proper start up and
+ establishment of clustering across cluster members.
+
+OpenDaylight
+ OpenDaylight is currently installed on all three control nodes but only
+ started on the first control node. OpenDaylight's HA capabilities are not yet
+ mature enough to be enabled.
+
+HA Proxy
+ HA Proxy is monitored by Pacemaker to ensure it is running across all nodes
+ and available to balance connections.
+
+Pacemaker & VIPs
+ Pacemaker has relationships and restraints setup to ensure proper service
+ start up order and Virtual IPs associated with specific services are running
+ on the proper host.
+
+VM Migration is configured and VMs can be evacuated as needed or as invoked
+by tools such as heat as part of a monitored stack deployment in the overcloud.
+
+
OPNFV Scenario Architecture
===========================
@@ -47,31 +105,32 @@ the installer as a (-d) deploy setting. Read further in the Apex documentation
to learn more about invoking the deploy command. Below is quick reference
matrix for OPNFV scenarios supported in Apex. Please refer to the respective
OPNFV Docs documentation for each scenario in order to see a full scenario
-description. The following scenarios correspond to a supported <Scenario>.yaml
-deploy settings file:
+description. Also, please refer to release-notes for information about known
+issues per scenario. The following scenarios correspond to a supported
+<Scenario>.yaml deploy settings file:
+-------------------------+------------+-----------------+
-| **Scenario** | **Owner** | **Known Issues**|
+| **Scenario** | **Owner** | **Supported** |
+-------------------------+------------+-----------------+
-| os-nosdn-nofeature-ha | Apex | |
+| os-nosdn-nofeature-ha | Apex | Yes |
+-------------------------+------------+-----------------+
-| os-nosdn-nofeature-noha | Apex | |
+| os-nosdn-nofeature-noha | Apex | Yes |
+-------------------------+------------+-----------------+
-| os-nosdn-ovs-noha | OVS for NFV| |
+| os-nosdn-ovs-noha | OVS for NFV| Yes |
+-------------------------+------------+-----------------+
-| os-nosdn-fdio-noha | FDS | |
+| os-nosdn-fdio-noha | FDS | Yes |
+-------------------------+------------+-----------------+
-| os-odl_l2-nofeature-ha | Apex | |
+| os-odl_l2-nofeature-ha | Apex | Yes |
+-------------------------+------------+-----------------+
-| os-odl_l3-nofeature-ha | Apex | APEX-112 |
+| os-odl_l3-nofeature-ha | Apex | Yes |
+-------------------------+------------+-----------------+
-| os-odl_l2-sfc-noha | SFC | |
+| os-odl_l2-sfc-noha | SFC | Yes |
+-------------------------+------------+-----------------+
-| os-odl_l2-bgpvpn-noha | SDNVPN | |
+| os-odl_l2-bgpvpn-ha | SDNVPN | No |
+-------------------------+------------+-----------------+
-| os-odl_l2-fdio-noha | FDS | |
+| os-odl_l2-fdio-noha | FDS | Yes |
+-------------------------+------------+-----------------+
-| os-onos-nofeature-ha | ONOSFW | |
+| os-onos-nofeature-ha | ONOSFW | Yes |
+-------------------------+------------+-----------------+
-| os-onos-sfc-ha | ONOSFW | |
+| os-onos-sfc-ha | ONOSFW | Yes |
+-------------------------+------------+-----------------+
diff --git a/docs/installationprocedure/baremetal.rst b/docs/installationprocedure/baremetal.rst
index 8507b445..2de6e8a8 100644
--- a/docs/installationprocedure/baremetal.rst
+++ b/docs/installationprocedure/baremetal.rst
@@ -137,6 +137,12 @@ Install Bare Metal Jumphost
no longer carry them and they will not need special handling for
installation.
+ Python 3.4 is also required and it needs to be installed if you are using
+ the Centos 7 base image:
+
+ ``sudo yum install epel-release``
+ ``sudo yum install python34``
+
To install these RPMs download them to the local disk on your CentOS 7
install and pass the file names directly to yum:
``sudo yum install python34-markupsafe-<version>.rpm
@@ -199,7 +205,8 @@ Edit the 2 settings files in /etc/opnfv-apex/. These files have comments to
help you customize them.
1. deploy_settings.yaml
- This file includes basic configuration options deployment.
+ This file includes basic configuration options deployment, and also documents
+ all available options.
Alternatively, there are pre-built deploy_settings files available in
(``/etc/opnfv-apex/``). These files are named with the naming convention
os-sdn_controller-enabled_feature-[no]ha.yaml. These files can be used in
@@ -223,11 +230,10 @@ You are now ready to deploy OPNFV using Apex!
Follow the steps below to execute:
1. Execute opnfv-deploy
- ``sudo opnfv-deploy [ --flat ] -n network_settings.yaml
+ ``sudo opnfv-deploy -n network_settings.yaml
-i inventory.yaml -d deploy_settings.yaml``
If you need more information about the options that can be passed to
- opnfv-deploy use ``opnfv-deploy --help`` --flat collapses all networks to a
- single nic, only uses the admin network from the network settings file. -n
+ opnfv-deploy use ``opnfv-deploy --help``. -n
network_settings.yaml allows you to customize your networking topology.
2. Wait while deployment is executed.
diff --git a/docs/installationprocedure/references.rst b/docs/installationprocedure/references.rst
index 5ff2a542..a63a8421 100644
--- a/docs/installationprocedure/references.rst
+++ b/docs/installationprocedure/references.rst
@@ -18,6 +18,8 @@ OPNFV
`OPNFV Apex project page <https://wiki.opnfv.org/apex>`_
+`OPNFV Apex release notes <http://artifacts.opnfv.org/apex/colorado/docs/releasenotes/release-notes.html#references>`_
+
OpenStack
---------
diff --git a/docs/installationprocedure/requirements.rst b/docs/installationprocedure/requirements.rst
index d54d584b..1b3fe87d 100644
--- a/docs/installationprocedure/requirements.rst
+++ b/docs/installationprocedure/requirements.rst
@@ -46,14 +46,13 @@ Network requirements include:
deployment. The External network is where public internet access would
reside if available.
-\* *These networks can be combined with each other or all combined on the
- Control Plane network.*
-\* *Non-External networks will be consolidated to the Control Plane network
- if not specifically configured.*
-\*\* *Internal API network, by default, is collapsed with provisioning in IPv4
- deployments, this is not possible with the current lack of PXE boot
- support and therefore the API network is required to be its own
- network in an IPv6 deployment.*
+\*These networks can be combined with each other or all combined on the
+Control Plane network.
+
+\*\*Internal API network, by default, is collapsed with provisioning in IPv4
+deployments, this is not possible with the current lack of PXE boot
+support and therefore the API network is required to be its own
+network in an IPv6 deployment.
Bare Metal Node Requirements
----------------------------
diff --git a/docs/installationprocedure/virtualinstall.rst b/docs/installationprocedure/virtualinstall.rst
index 01971893..d2c81abe 100644
--- a/docs/installationprocedure/virtualinstall.rst
+++ b/docs/installationprocedure/virtualinstall.rst
@@ -49,7 +49,7 @@ environment will deploy with the following architecture:
Follow the steps below to execute:
1. ``sudo opnfv-deploy -v [ --virtual-computes n ]
- [ --virtual-cpus n ] [ --virtual-ram n ] [ --flat ]
+ [ --virtual-cpus n ] [ --virtual-ram n ]
-n network_settings.yaml -i inventory.yaml -d deploy_settings.yaml``
2. It will take approximately 45 minutes to an hour to stand up undercloud,
diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst
deleted file mode 100644
index 080d2043..00000000
--- a/docs/release-notes/release-notes.rst
+++ /dev/null
@@ -1,247 +0,0 @@
-==========================================================================
-OPNFV Release Notes for the Colorado release of OPNFV Apex deployment tool
-==========================================================================
-
-
-.. contents:: Table of Contents
- :backlinks: none
-
-
-Abstract
-========
-
-This document provides the release notes for Colorado release with the Apex
-deployment toolchain.
-
-License
-=======
-
-All Apex and "common" entities are protected by the Apache License
-( http://www.apache.org/licenses/ )
-
-
-Version history
-===============
-
-
-+-------------+-----------+-----------------+----------------------+
-| **Date** | **Ver.** | **Authors** | **Comment** |
-| | | | |
-+-------------+-----------+-----------------+----------------------+
-| 2016-08-11 | 2.0.0 | Dan Radez | Updates for Colorado |
-+-------------+-----------+-----------------+----------------------+
-| 2015-09-17 | 1.0.0 | Dan Radez | Rewritten for |
-| | | | RDO Manager update |
-+-------------+-----------+-----------------+----------------------+
-
-Important notes
-===============
-
-This is the OPNFV Colorado release that implements the deploy stage of the
-OPNFV CI pipeline via Apex.
-
-Apex is based on RDO's Triple-O installation tool chain.
-More information at http://rdoproject.org
-
-Carefully follow the installation-instructions which guide a user on how to
-deploy OPNFV using Apex installer.
-
-Summary
-=======
-
-Colorado release with the Apex deployment toolchain will establish an OPNFV
-target system on a Pharos compliant lab infrastructure. The current definition
-of an OPNFV target system is and OpenStack Liberty combined with OpenDaylight
-Beryllium. The system is deployed with OpenStack High Availability (HA) for
-most OpenStack services. OpenDaylight is deployed in non-HA form as HA support
-is not availble for OpenDaylight at the time of the Colorado release. Ceph
-storage is used as Cinder backend, and is the only supported storage for
-Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
-node.
-
-- Documentation is built by Jenkins
-- .iso image is built by Jenkins
-- .rpm packages are built by Jenkins
-- Jenkins deploys a Colorado release with the Apex deployment toolchain
- baremetal, which includes 3 control+network nodes, and 2 compute nodes.
-
-Release Data
-============
-
-+--------------------------------------+--------------------------------------+
-| **Project** | apex |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Repo/tag** | apex/colorado.1.0 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release designation** | colorado.1.0 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release date** | 2016-09-14 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Colorado release |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Version change
---------------
-
-Module version changes
-~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of the Colorado release with the Apex
-deployment toolchain. It is based on following upstream versions:
-
-- OpenStack (Mitaka release)
-
-- OpenDaylight (Beryllium release)
-
-- CentOS 7
-
-Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-This is the first tracked version of Colorado release with the Apex
-deployment toolchain.
-The following documentation is provided with this release:
-
-- OPNFV Installation instructions for the Colorado release with the Apex
- deployment toolchain - ver. 1.0.0
-- OPNFV Release Notes for the Colorado release with the Apex deployment
- toolchain - ver. 1.0.0 (this document)
-
-Feature additions
-~~~~~~~~~~~~~~~~~
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-32 | Build.sh integration of RDO Manager |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-6 | Deploy.sh integration of RDO Manager |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-34 | Migrate and update Release |
-| | Documentation for Colorado |
-+--------------------------------------+--------------------------------------+
-
-Bug corrections
-~~~~~~~~~~~~~~~
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Deliverables
-------------
-
-Software deliverables
-~~~~~~~~~~~~~~~~~~~~~
-Apex .iso file
-Apex overcloud .rpm (opnfv-apex)
-Apex undercloud .rpm (opnfv-apex-undercloud)
-Apex common .rpm (opnfv-apex-common)
-build.sh - Builds the above artifacts
-opnfv-deploy - Automatically deploys Target OPNFV System
-opnfv-clean - Automatically resets a Target OPNFV Deployment
-
-Documentation deliverables
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-- OPNFV Installation instructions for the Colorado release with the Apex
- deployment toolchain - ver. 1.0.0
-- OPNFV Release Notes for the Colorado release with the Apex deployment
- toolchain - ver. 1.0.0 (this document)
-
-Known Limitations, Issues and Workarounds
-=========================================
-
-System Limitations
-------------------
-
-**Max number of blades:** 1 Apex undercloud, 3 Controllers, 20 Compute blades
-
-**Min number of blades:** 1 Apex undercloud, 1 Controller, 1 Compute blade
-
-**Storage:** Ceph is the only supported storage configuration.
-
-**Min master requirements:** At least 16GB of RAM
-
-
-Known issues
-------------
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-89 | Deploy Ceph OSDs on the compute |
-| | nodes also |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-27 | OpenContrail Support |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-30 | Support for VLAN tagged network |
-| | deployment architecture |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-100 | DNS1 and DNS2 not handled in |
-| | nic bridging |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-47 | Integrate Tacker as part of SFC |
-| | Experimental Feature |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-84 | --flat option no longer working |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-51 | Integrate SDNVPN as a deploy option |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-99 | Syntax error when |
-| | running opnfv-deploy |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-86 | Compute node count configurable |
-| | for virtual deployments |
-+--------------------------------------+--------------------------------------+
-| JIRA: APEX-141 | Adding VSPERF support |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Workarounds
------------
-**-**
-
-
-Test Result
-===========
-
-The Colorado release with the Apex deployment toolchain has undergone QA
-test runs with the following results:
-
-+--------------------------------------+--------------------------------------+
-| **TEST-SUITE** | **Results:** |
-| | |
-+--------------------------------------+--------------------------------------+
-| **-** | **-** |
-+--------------------------------------+--------------------------------------+
-
-
-References
-==========
-
-For more information on the OPNFV Colorado release, please see:
-
-http://wiki.opnfv.org/releases/Colorado
-
-:Authors: Tim Rozet (trozet@redhat.com)
-:Authors: Dan Radez (dradez@redhat.com)
-:Version: 1.0.0
diff --git a/docs/release-notes/index.rst b/docs/releasenotes/index.rst
index 1f723960..1f723960 100644
--- a/docs/release-notes/index.rst
+++ b/docs/releasenotes/index.rst
diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst
new file mode 100644
index 00000000..52b676ec
--- /dev/null
+++ b/docs/releasenotes/release-notes.rst
@@ -0,0 +1,384 @@
+==========================================================================
+OPNFV Release Notes for the Colorado release of OPNFV Apex deployment tool
+==========================================================================
+
+
+.. contents:: Table of Contents
+ :backlinks: none
+
+
+Abstract
+========
+
+This document provides the release notes for Colorado release with the Apex
+deployment toolchain.
+
+License
+=======
+
+All Apex and "common" entities are protected by the Apache License
+( http://www.apache.org/licenses/ )
+
+
+Version History
+===============
+
+
++-------------+-----------+-----------------+----------------------+
+| **Date** | **Ver.** | **Authors** | **Comment** |
+| | | | |
++-------------+-----------+-----------------+----------------------+
+| 2016-09-20 | 2.1.0 | Tim Rozet | More updates for |
+| | | | Colorado |
++-------------+-----------+-----------------+----------------------+
+| 2016-08-11 | 2.0.0 | Dan Radez | Updates for Colorado |
++-------------+-----------+-----------------+----------------------+
+| 2015-09-17 | 1.0.0 | Dan Radez | Rewritten for |
+| | | | RDO Manager update |
++-------------+-----------+-----------------+----------------------+
+
+Important Notes
+===============
+
+This is the OPNFV Colorado release that implements the deploy stage of the
+OPNFV CI pipeline via Apex.
+
+Apex is based on RDO's Triple-O installation tool chain.
+More information at http://rdoproject.org
+
+Carefully follow the installation-instructions which guide a user on how to
+deploy OPNFV using Apex installer.
+
+Summary
+=======
+
+Colorado release with the Apex deployment toolchain will establish an OPNFV
+target system on a Pharos compliant lab infrastructure. The current definition
+of an OPNFV target system is OpenStack Mitaka combined with an SDN
+controller, such as OpenDaylight. The system is deployed with OpenStack High
+Availability (HA) for most OpenStack services. SDN controllers are deployed
+only on the first controller (see HAIssues_ for known HA SDN issues). Ceph
+storage is used as Cinder backend, and is the only supported storage for
+Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
+node in an HA setup. Apex also supports non-HA deployments, which deploys a
+single controller and n number of compute nodes. Furthermore, Apex is
+capable of deploying scenarios in a bare metal or virtual fashion. Virtual
+deployments use multiple VMs on the jump host and internal networking to
+simulate the a bare metal deployment.
+
+- Documentation is built by Jenkins
+- .iso image is built by Jenkins
+- .rpm packages are built by Jenkins
+- Jenkins deploys a Colorado release with the Apex deployment toolchain
+ bare metal, which includes 3 control+network nodes, and 2 compute nodes.
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project** | apex |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/tag** | apex/colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | 2016-09-22 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | OPNFV Colorado release |
+| | |
++--------------------------------------+--------------------------------------+
+
+Version change
+--------------
+
+Module version changes
+~~~~~~~~~~~~~~~~~~~~~~
+This is the first tracked version of the Colorado release with the Apex
+deployment toolchain. It is based on following upstream versions:
+
+- OpenStack (Mitaka release)
+
+- OpenDaylight (Beryllium/Boron releases)
+
+- CentOS 7
+
+Document Version Changes
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is the first tracked version of Colorado release with the Apex
+deployment toolchain.
+The following documentation is provided with this release:
+
+- OPNFV Installation instructions for the Colorado release with the Apex
+ deployment toolchain - ver. 1.0.0
+- OPNFV Release Notes for the Colorado release with the Apex deployment
+ toolchain - ver. 1.0.0 (this document)
+
+Feature Additions
+~~~~~~~~~~~~~~~~~
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-107 | OpenDaylight HA - OVSDB Clustering |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-108 | Migrate to OpenStack Mitaka |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-30 | Support VLAN tagged deployments |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-105 | Enable Huge Page Configuration |
+| | Options |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-111 | Allow RAM to be specified for |
+| | Control/Compute in Virtual |
+| | Deployments |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-119 | Enable OVS DPDK as a deployment |
+| | Scenario in Apex |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-126 | Tacker Service deployed by Apex |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-135 | Congress Service deployed by Apex |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-127 | Nova Instance CPU Pinning |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-130 | IPv6 Underlay Deployment |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-133 | FDIO with Honeycomb Agent |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-141 | Integrate VSPERF into Apex |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-172 | Enable ONOS SFC |
++--------------------------------------+--------------------------------------+
+
+Bug Corrections
+~~~~~~~~~~~~~~~
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-180 | Baremetal deployment error: Failed to|
+| | mount root partition /dev/sda on |
+| | /mnt/rootfs |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-161 | Heat autoscaling stack creation fails|
+| | for non-admin users |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-198 | Missing NAT iptables rule for public |
+| | network in instack VM |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-147 | Installer doesn't generate/distribute|
+| | SSH keys between compute nodes |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-109 | ONOS routes local subnet traffic to |
+| | GW |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-146 | Swift service present in available |
+| | endpoints |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-160 | Enable force_metadata to support |
+| | subnets with VM as the router |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-114 | OpenDaylight GUI is not available |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-100 | DNS1 and DNS2 should be handled in |
+| | nic bridging |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-100 | DNS1 and DNS2 should be handled in |
+| | nic bridging |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-155 | NIC Metric value not used when |
+| | bridging NICs |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-136 | 2 network deployment fails |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-89 | Deploy Ceph OSDs on compute nodes |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-137 | added arping ass dependency for |
+| | ONOS deployments |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-121 | VM Storage deletion intermittently |
+| | fails |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-182 | Nova services not correctly deployed |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-153 | brbm bridge not created in jumphost |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+------------
+
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+- Apex .iso file
+- Apex overcloud .rpm (opnfv-apex) - For nosdn and OpenDaylight Scenarios
+- Apex overcloud onos .rpm (opnfv-apex-onos) - ONOS Scenarios
+- Apex overcloud ODL SFC .rpm (opnfv-apex-opendaylight-sfc) - ODL SFC Scenario
+- Apex undercloud .rpm (opnfv-apex-undercloud)
+- Apex common .rpm (opnfv-apex-common)
+- build.sh - Builds the above artifacts
+- opnfv-deploy - Automatically deploys Target OPNFV System
+- opnfv-clean - Automatically resets a Target OPNFV Deployment
+- opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight
+
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+- OPNFV Installation instructions for the Colorado release with the Apex
+ deployment toolchain - ver. 1.0.0
+- OPNFV Release Notes for the Colorado release with the Apex deployment
+ toolchain - ver. 1.0.0 (this document)
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+**Max number of blades:** 1 Apex undercloud, 3 Controllers, 20 Compute blades
+
+**Min number of blades:** 1 Apex undercloud, 1 Controller, 1 Compute blade
+
+**Storage:** Ceph is the only supported storage configuration.
+
+**Min master requirements:** At least 16GB of RAM for baremetal jumphost,
+24GB for virtual deployments (noHA).
+
+
+Known Issues
+------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-203 | Swift proxy enabled and fails in noha|
+| | deployments |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-215 | Keystone services not configured and |
+| | the error is silently ignored (VLAN |
+| | Deployments) |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-208 | Need ability to specify which NIC to |
+| | place VLAN on |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-254 | Add dynamic hugepages configuration |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-138 | Unclear error message when interface |
+| | set to dhcp |
++--------------------------------------+--------------------------------------+
+
+
+Workarounds
+-----------
+**-**
+
+Scenario specific release notes
+===============================
+
+Scenario os-odl_l3-nofeature known issues
+-----------------------------------------
+
+* `APEX-112 <https://jira.opnfv.org/browse/APEX-112>`_:
+ ODL routes local subnet traffic to GW
+
+Scenario os-odl_l2-nofeature known issues
+-----------------------------------------
+
+* `APEX-149 <https://jira.opnfv.org/browse/APEX-149>`_:
+ Openflow rules are populated very slowly
+
+Scenario os-odl_l2-bgpvpn known issues
+--------------------------------------
+
+* `APEX-278 <https://jira.opnfv.org/browse/APEX-278>`_:
+ Duplicate neutron config class declaration for SDNVPN
+
+Scenario os-onos-nofeatures/os-onos-sfc known issues
+----------------------------------------------------
+
+* `APEX-281 <https://jira.opnfv.org/browse/APEX-281>`_:
+ ONOS sometimes fails to provide addresses to instances
+
+Scenario os-odl_l2-sfc-noha known issues
+----------------------------------------
+
+* `APEX-275 <https://jira.opnfv.org/browse/APEX-275>`_:
+ Metadata fails in Boron
+
+Scenario os-nosdn-ovs known issues
+----------------------------------
+
+* `APEX-274 <https://jira.opnfv.org/browse/APEX-274>`_:
+ OVS DPDK scenario does not create vhost user ports
+
+Scenario os-odl_l2-fdio-noha known issues
+-----------------------------------------
+
+* `FDS-16 <https://jira.opnfv.org/browse/FDS-16>`_:
+ Security group configuration through nova leads
+ to vhostuser port connection issues
+* `FDS-62 <https://jira.opnfv.org/browse/FDS-62>`_:
+ APEX - Increase number of files MariaDB can open
+* `FDS-79 <https://jira.opnfv.org/browse/FDS-79>`_:
+ Sometimes (especially in bulk crete/delete operations
+ when multiple networks/ports are created within short time)
+ OpenDaylight doesn't accept creation requests
+* `FDS-80 <https://jira.opnfv.org/browse/FDS-80>`_:
+ After launching a VM it stayed forever in BUILD status.
+ Also further operation related to this VM (volume attachment etc.)
+ caused problems
+* `FDS-81 <https://jira.opnfv.org/browse/FDS-81>`_:
+ After functest finishes there are two bds on computes and
+ none on controller
+* `FDS-82 <https://jira.opnfv.org/browse/FDS-82>`_:
+ Nova list shows no vms but there are some on computes in paused state
+* `APEX-217 <https://jira.opnfv.org/browse/APEX-217>`_:
+ qemu not configured with correct group:user
+
+.. _HAIssues:
+
+General HA scenario known issues
+--------------------------------
+
+* `COPPER-22 <https://jira.opnfv.org/browse/COPPER-22>`_:
+ Congress service HA deployment is not yet supported/verified.
+* `APEX-276 <https://jira.opnfv.org/browse/APEX-276>`_:
+ ODL HA unstable and crashes frequently
+
+Test Result
+===========
+
+The Colorado release with the Apex deployment toolchain has undergone QA
+test runs with the following results:
+
++--------------------------------------+--------------------------------------+
+| **TEST-SUITE** | **Results:** |
+| | |
++--------------------------------------+--------------------------------------+
+| **-** | **-** |
++--------------------------------------+--------------------------------------+
+
+
+References
+==========
+
+For more information on the OPNFV Colorado release, please see:
+
+http://wiki.opnfv.org/releases/Colorado
+
+:Authors: Tim Rozet (trozet@redhat.com)
+:Authors: Dan Radez (dradez@redhat.com)
+:Version: 2.1.0