From 5765c5a1b1459c815c2b871b00c36f8fcc75095d Mon Sep 17 00:00:00 2001 From: Serg Melikyan Date: Tue, 28 Feb 2017 17:01:03 -0800 Subject: Update documentation for Danube Change-Id: I535eb87bfa980cffc8e091b896b505884ed12d32 Signed-off-by: Serg Melikyan --- docs/release/release-notes/index.rst | 15 ++ docs/release/release-notes/release-notes.rst | 223 +++++++++++++++++++++++++++ 2 files changed, 238 insertions(+) create mode 100644 docs/release/release-notes/index.rst create mode 100644 docs/release/release-notes/release-notes.rst (limited to 'docs/release/release-notes') diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 000000000..9cdc01ef0 --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,15 @@ +.. 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 + +.. _fuel-release-notes-label: + +***************************** +Release notes for Fuel\@OPNFV +***************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + release-notes.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 000000000..465d0881a --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,223 @@ +.. 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 Danube release of +OPNFV when using Fuel as a deployment tool. + +=============== +Important Notes +=============== + +These notes provides release information for the use of Fuel as deployment +tool for the Danube release of OPNFV. + +The goal of the Danube release and this Fuel-based deployment process is +to establish a lab ready platform accelerating further development +of the OPNFV infrastructure. + +Carefully follow the installation-instructions provided in *Reference 13*. + +======= +Summary +======= + +For Danube, the typical use of Fuel as an OpenStack installer is +supplemented with OPNFV unique components such as: + +- `OpenDaylight `_ +- `Service Function Chaining `_ +- `SDN distributed routing and VPN `_ +- `NFV Hypervisors-KVM `_ +- `Open vSwitch for NFV `_ +- `VSPERF `_ +- `Promise `_ +- `Parser `_ +- `Doctor `_ + +As well as OPNFV-unique configurations of the Hardware and Software stack. + +This Danube artifact provides Fuel as the deployment stage tool in the +OPNFV CI pipeline including: + +- Documentation built by Jenkins + + - overall OPNFV documentation + + - this document (release notes) + + - installation instructions + + - build-instructions + +- The Danube Fuel installer image (.iso) built by Jenkins + +- Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM) + +- Automated validation of the Danube deployment + +============ +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | fuel | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | danube.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube 1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | March 27 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Danube alignment to Released | +| | Fuel 10.0 baseline + features and | +| | bug-fixes for the following | +| | feaures: | +| | - NFV Hypervisors-KVM | +| | - Open vSwitch for NFV | +| | - OpenDaylight | +| | - SDN distributed routing and VPN | +| | - Service function chaining | +| | - Promise | +| | - Parser | +| | - Doctor | +| | - Tacker | ++--------------------------------------+--------------------------------------+ + +Version Change +============== + +Module Version Changes +---------------------- +This is the Danube 1.0 release. +It is based on following upstream versions: + +- Fuel 10.0 Base Release + +- OpenStack Newton Release + +- OpenDaylight + +Document Changes +---------------- +This is the Danube 1.0 release. +It comes with the following documentation: + +- Installation instructions + +- Build instructions + +- Release notes (This document) + +Reason for Version +================== + +Feature Additions +----------------- + +**JIRA TICKETS:** + + +Bug Corrections +--------------- + +**JIRA TICKETS:** + +`Danube 1.0 bug fixes `_ + +(Also See respective Integrated feature project's bug tracking) + +Deliverables +============ + +Software Deliverables +--------------------- + +Fuel-based installer iso file found in `OPNFV Downloads `. + +Documentation Deliverables +-------------------------- + +- Installation instructions + +- Build instructions + +- Release notes(This document) + +========================================= +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +================== + +- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades + +- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade + +- **Storage:** Ceph is the only supported storage configuration + +- **Max number of networks:** 65k + + +Known Issues +============ + +**JIRA TICKETS:** + +`Known issues `_ + +(Also See respective Integrated feature project's bug tracking) + +Workarounds +=========== + +**JIRA TICKETS:** + +`Workarounds `_ + +(Also See respective Integrated feature project's bug tracking) + +============ +Test Results +============ +The Danube 1.0 release with the Fuel deployment tool has undergone QA test +runs, see separate test results. + +========== +References +========== +For more information on the OPNFV Danube 1.0 release, please see: + +OPNFV +===== + +1) `OPNFV Home Page `_ +2) `OPNFV Documentation - and Software Downloads `_ + +OpenStack +========= + +3) `OpenStack Newton Release Artifacts `_ + +4) `OpenStack Documentation `_ + +OpenDaylight +============ + +5) `OpenDaylight Artifacts `_ + +Fuel +==== + +6) `The Fuel OpenStack Project `_ +7) `Fuel Documentation `_ + -- cgit 1.2.3-korg