.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Open Platform for NFV Project, Inc. and its contributors

========
Abstract
========

This document compiles the release notes for the Euphrates release of
OPNFV when using Apex/Joid as a deployment tool.

===============
Important Notes
===============

These notes provides release information for the use of Apex/Joid as deployment
tool for the Euphrates release of OPNFV.

The goal of the Euphrates release and this Joid/Apex-based deployment process is
to establish a lab ready platform accelerating further development
of the OPNFV infrastructure.

Carefully follow the installation-instructions.

=======
Summary
=======

For Euphrates, OVN4NFV is supported with APEX and JOID installers.

This Euphrates artifact provides Apex/Joid as the deployment stage tool in the
OPNFV CI pipeline including:

- Documentation built by Jenkins

  - overall OPNFV documentation

  - this document (release notes)

  - installation instructions

- Automated validation of the Euphrates deployment.

============
Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | ovn4nfv                              |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | opnfv-5.0.0                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Euphrates 5.1                        |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | December 15 2017                     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Bug fixes                            |
+--------------------------------------+--------------------------------------+


Deliverables
============

Software Deliverables
---------------------

- `Apex based installation <https://git.opnfv.org/apex>`_

- `Joid based installation <https://git.opnfv.org/joid>`_

Documentation Deliverables
--------------------------

- `Installation instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/ovn4nfv/docs/development/openstack-networking-ovn.html#install-configuration>`_

- Release notes (This document)

- `User guide and Testing notes <http://docs.opnfv.org/en/stable-euphrates/submodules/ovn4nfv/docs/testing/testing-notes.html>`_


==========
References
==========
For more information, please see:

OPNFV
=====

1) `OPNFV Home Page <http://www.opnfv.org>`_
2) `OPNFV Documentation <http://docs.opnfv.org>`_
3) `OPNFV Software Downloads <https://www.opnfv.org/software/download>`_
4) `OVN4NFV Project <>`_

OpenStack
=========

1) `networking-ovn Project <https://docs.openstack.org/networking-ovn/latest>`_
2) `OVN with K8S <https://github.com/openvswitch/ovn-kubernetes>`_
3) `OVN Architecture <http://openvswitch.org/support/dist-docs/ovn-architecture.7.html>`_