summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTim Rozet <trozet@redhat.com>2017-08-28 12:56:19 -0400
committerTim Rozet <trozet@redhat.com>2017-08-29 10:21:30 -0400
commit42fb04545173f39d112c3d754bc0e6a4b0ced779 (patch)
tree1e8a787156036c41898111ae870d389dd8c0bfe3 /docs
parent614d9d9b9f242a7a55fb3963395f4a5fe3edb8fe (diff)
Updates preliminary docs for Euphrates
Change-Id: I4e3e78e60756824c1294ab067a325311bc2ac8f2 Signed-off-by: Tim Rozet <trozet@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/release/release-notes/release-notes.rst48
-rw-r--r--docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst6
-rw-r--r--docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst6
-rw-r--r--docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst6
-rw-r--r--docs/release/scenarios/os-odl-csit-noha/index.rst (renamed from docs/release/scenarios/os-odl_l3-nofeature-ha/index.rst)10
-rw-r--r--docs/release/scenarios/os-odl-csit-noha/os-odl-csit-noha.rst (renamed from docs/release/scenarios/os-odl_l3-csit-noha/os-odl_l3-csit-noha.rst)8
-rw-r--r--docs/release/scenarios/os-odl-nofeature-ha/index.rst (renamed from docs/release/scenarios/os-odl_l3-csit-noha/index.rst)6
-rw-r--r--docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst (renamed from docs/release/scenarios/os-odl_l3-nofeature-ha/os-odl_l3-nofeature-ha.rst)10
-rw-r--r--docs/release/scenarios/os-odl-nofeature-noha/index.rst (renamed from docs/release/scenarios/os-odl_l3-nofeature-noha/index.rst)10
-rw-r--r--docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst (renamed from docs/release/scenarios/os-odl_l3-nofeature-noha/os-odl_l3-nofeature-noha.rst)8
-rw-r--r--docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst6
11 files changed, 63 insertions, 61 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 753ef81..a4d653e 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -1,6 +1,6 @@
-========================================================================
-OPNFV Release Notes for the Danube release of OPNFV Apex deployment tool
-========================================================================
+===========================================================================
+OPNFV Release Notes for the Euphrates release of OPNFV Apex deployment tool
+===========================================================================
.. contents:: Table of Contents
@@ -10,7 +10,7 @@ OPNFV Release Notes for the Danube release of OPNFV Apex deployment tool
Abstract
========
-This document provides the release notes for Danube release with the Apex
+This document provides the release notes for Euphrates release with the Apex
deployment toolchain.
License
@@ -28,6 +28,8 @@ Version History
| **Date** | **Ver.** | **Authors** | **Comment** |
| | | | |
+-------------+-----------+-----------------+----------------------+
+| 2017-08-28 | 5.0 | Tim Rozet | Updates for Euphrates|
++-------------+-----------+-----------------+----------------------+
| 2017-03-30 | 4.0 | Tim Rozet | Updates for Danube |
+-------------+-----------+-----------------+----------------------+
| 2016-09-20 | 2.1.0 | Tim Rozet | More updates for |
@@ -42,7 +44,7 @@ Version History
Important Notes
===============
-This is the OPNFV Danube release that implements the deploy stage of the
+This is the OPNFV Euphrates release that implements the deploy stage of the
OPNFV CI pipeline via Apex.
Apex is based on RDO's Triple-O installation tool chain.
@@ -54,14 +56,14 @@ deploy OPNFV using Apex installer.
Summary
=======
-Danube release with the Apex deployment toolchain will establish an OPNFV
+Euphrates 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 Newton 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
on every controller unless deploying with one the HA FD.IO scenarios. Ceph
storage is used as Cinder backend, and is the only supported storage for
-Danube. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
+Euphrates. 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
@@ -71,7 +73,7 @@ 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 Danube release with the Apex deployment toolchain
+- Jenkins deploys a Euphrates release with the Apex deployment toolchain
bare metal, which includes 3 control+network nodes, and 2 compute nodes.
Release Data
@@ -81,16 +83,16 @@ Release Data
| **Project** | apex |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | apex/danube.1.0 |
+| **Repo/tag** | apex/euphrates.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | danube.1.0 |
+| **Release designation** | 5.0.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2017-03-31 |
+| **Release date** | 2017-09-17 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Danube release |
+| **Purpose of the delivery** | OPNFV Euphrates release |
| | |
+--------------------------------------+--------------------------------------+
@@ -99,7 +101,7 @@ Version change
Module version changes
~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of the Danube release with the Apex
+This is the first tracked version of the Euphrates release with the Apex
deployment toolchain. It is based on following upstream versions:
- OpenStack (Newton release)
@@ -111,13 +113,13 @@ deployment toolchain. It is based on following upstream versions:
Document Version Changes
~~~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of Danube release with the Apex
+This is the first tracked version of Euphrates release with the Apex
deployment toolchain.
The following documentation is provided with this release:
-- OPNFV Installation instructions for the Danube release with the Apex
+- OPNFV Installation instructions for the Euphrates release with the Apex
deployment toolchain - ver. 1.0.0
-- OPNFV Release Notes for the Danube release with the Apex deployment
+- OPNFV Release Notes for the Euphrates release with the Apex deployment
toolchain - ver. 1.0.0 (this document)
Feature Additions
@@ -248,10 +250,10 @@ Software Deliverables
Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- OPNFV Installation instructions for the Danube release with the Apex
- deployment toolchain - ver. 4.0
-- OPNFV Release Notes for the Danube release with the Apex deployment
- toolchain - ver. 4.0 (this document)
+- OPNFV Installation instructions for the Euphrates release with the Apex
+ deployment toolchain - ver. 5.0
+- OPNFV Release Notes for the Euphrates release with the Apex deployment
+ toolchain - ver. 5.0 (this document)
Known Limitations, Issues and Workarounds
=========================================
@@ -333,10 +335,10 @@ Apex installer.
References
==========
-For more information on the OPNFV Danube release, please see:
+For more information on the OPNFV Euphrates release, please see:
-http://wiki.opnfv.org/releases/Danube
+http://wiki.opnfv.org/releases/Euphrates
:Authors: Tim Rozet (trozet@redhat.com)
:Authors: Dan Radez (dradez@redhat.com)
-:Version: 4.0
+:Version: 5.0
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
index 9956f29..4d8870b 100644
--- 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
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Danube 1.0 of
+This document provides scenario level details for Euphrates 1.0 of
deployment with no SDN controller and no extra features enabled.
.. contents::
@@ -42,6 +42,6 @@ None
References
==========
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
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
index 6c5c053..33a855d 100644
--- 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
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Danube 1.0 of
+This document provides scenario level details for Euphrates 1.0 of
deployment with no SDN controller and no extra features enabled.
.. contents::
@@ -39,6 +39,6 @@ None
References
==========
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
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
index 8f94128..1319f42 100644
--- 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
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Danube 1.0 of
+This document provides scenario level details for Euphrates 1.0 of
deployment with no SDN controller and performance options enabled.
.. contents::
@@ -53,6 +53,6 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
diff --git a/docs/release/scenarios/os-odl_l3-nofeature-ha/index.rst b/docs/release/scenarios/os-odl-csit-noha/index.rst
index 7d02fff..51cf903 100644
--- a/docs/release/scenarios/os-odl_l3-nofeature-ha/index.rst
+++ b/docs/release/scenarios/os-odl-csit-noha/index.rst
@@ -1,15 +1,15 @@
-.. _os-odl_l3-nofeature-ha:
+.. _os-odl-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-nofeature-ha overview and description
-===============================================
+=========================================
+os-odl-csit-noha overview and description
+=========================================
.. toctree::
:numbered:
:maxdepth: 4
- os-odl_l3-nofeature-ha.rst
+ os-odl-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-csit-noha/os-odl-csit-noha.rst
index 7511a55..331d3b1 100644
--- a/docs/release/scenarios/os-odl_l3-csit-noha/os-odl_l3-csit-noha.rst
+++ b/docs/release/scenarios/os-odl-csit-noha/os-odl-csit-noha.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Danube 1.0 of
+This document provides scenario level details for Euphrates 1.0 of
deployment with the OpenDaylight SDN controller and only CSIT relevant
features enabled.
@@ -33,7 +33,7 @@ CPU/Memory requirements.
Scenario usage overview
=======================
-Simply deploy this scenario by using the os-odl_l3-csit-noha.yaml deploy
+Simply deploy this scenario by using the os-odl-csit-noha.yaml deploy
settings file.
Limitations, Issues and Workarounds
@@ -53,6 +53,6 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
diff --git a/docs/release/scenarios/os-odl_l3-csit-noha/index.rst b/docs/release/scenarios/os-odl-nofeature-ha/index.rst
index 29483b0..4c6a443 100644
--- a/docs/release/scenarios/os-odl_l3-csit-noha/index.rst
+++ b/docs/release/scenarios/os-odl-nofeature-ha/index.rst
@@ -1,15 +1,15 @@
-.. _os-odl_l3-csit-noha:
+.. _os-odl-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-csit-noha overview and description
+os-odl-nofeature-ha overview and description
============================================
.. toctree::
:numbered:
:maxdepth: 4
- os-odl_l3-csit-noha.rst
+ os-odl-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-nofeature-ha/os-odl-nofeature-ha.rst
index 69df973..1036f77 100644
--- a/docs/release/scenarios/os-odl_l3-nofeature-ha/os-odl_l3-nofeature-ha.rst
+++ b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Danube 1.0 of
+This document provides scenario level details for Euphrates 1.0 of
deployment with the OpenDaylight SDN controller and no extra features enabled.
.. contents::
@@ -30,13 +30,13 @@ 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
+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_l3-nofeature-ha.yaml deploy
+Simply deploy this scenario by using the os-odl-nofeature-ha.yaml deploy
settings file.
Limitations, Issues and Workarounds
@@ -56,6 +56,6 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
diff --git a/docs/release/scenarios/os-odl_l3-nofeature-noha/index.rst b/docs/release/scenarios/os-odl-nofeature-noha/index.rst
index 182174e..c3576b6 100644
--- a/docs/release/scenarios/os-odl_l3-nofeature-noha/index.rst
+++ b/docs/release/scenarios/os-odl-nofeature-noha/index.rst
@@ -1,15 +1,15 @@
-.. _os-odl_l3-nofeature-noha:
+.. _os-odl-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
-=================================================
+==============================================
+os-odl-nofeature-noha overview and description
+==============================================
.. toctree::
:numbered:
:maxdepth: 4
- os-odl_l3-nofeature-noha.rst
+ os-odl-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-nofeature-noha/os-odl-nofeature-noha.rst
index 7b4ebbe..490cfbd 100644
--- a/docs/release/scenarios/os-odl_l3-nofeature-noha/os-odl_l3-nofeature-noha.rst
+++ b/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Danube 1.0 of
+This document provides scenario level details for Euphrates 1.0 of
deployment with the OpenDaylight SDN controller and no extra features enabled.
.. contents::
@@ -30,7 +30,7 @@ the OpenDaylight service on it.
Scenario usage overview
=======================
-Simply deploy this scenario by using the os-odl_l3-nofeature-noha.yaml deploy
+Simply deploy this scenario by using the os-odl-nofeature-noha.yaml deploy
settings file.
Limitations, Issues and Workarounds
@@ -50,6 +50,6 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
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
index 24de23b..c0f96ab 100644
--- 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
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Danube 1.0 of
+This document provides scenario level details for Euphrates 1.0 of
deployment with the OVN SDN controller and no extra features enabled.
.. contents::
@@ -39,6 +39,6 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Danube release, please visit
-http://www.opnfv.org/danube
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates