diff options
author | Qingyu Wang <qingyuwang33@gmail.com> | 2016-11-21 15:52:31 -0800 |
---|---|---|
committer | Maxwell Li <liyuenan@huawei.com> | 2017-02-22 01:53:56 +0000 |
commit | 45ebd77015ceef9420fbd0985eb5fe85dd96e107 (patch) | |
tree | ccd330f809f1859045774ddc6c57a139c7428e09 /docs/release/release-notes | |
parent | 849d0b1ae242f5b10163b45e285d4ee661519752 (diff) |
Installation and release documentations update
JIRA: DOCS-165
update document for Danube release according to new doc guide;
https://wiki.opnfv.org/display/DOC/Documentation+Guide
add network topology for virtual and bm deployment;
add a section for network_cfg.yaml configuration;
add feature section, listing supported openstack version and features
update installation for deployment and expansion.
Change-Id: If43d94554bebc78bbd56cdf889c8c34dda926218
Signed-off-by: Qingyu <qingyuwang33@gmail.com>
Signed-off-by: Justin <chigang@huawei.com>
Diffstat (limited to 'docs/release/release-notes')
-rw-r--r-- | docs/release/release-notes/index.rst | 13 | ||||
-rw-r--r-- | docs/release/release-notes/release-notes.rst | 155 |
2 files changed, 168 insertions, 0 deletions
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 00000000..20358bc7 --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 + +========================= +Compass4nfv Release Notes +========================= + +.. toctree:: + :numbered: + :maxdepth: 3 + + 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 00000000..e44e6744 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,155 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) + +Release Note for the Danube release of OPNFV when using Compass4nfv as a deployment tool. + +Abstract +======== + +This document describes release notes of OPNFV when using Compass4nfv as a +deployment tool covering it's features, limitations and required system resources. + +Introduction +============ + +Compass4nfv is an OPNFV installer project based on open source project Compass, +which provides automated deployment and management of OpenStack and other distributed systems. +Please carefully follow the Installation Instructions to deploy OPNFV using Compass4nfv +installer. + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | Compass4nfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | Compass4nfv/Danube.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | March 27 2017 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | OPNFV Danube release | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ + + - Compass4nfv/Danube.1.0 ISO, please get it from `OPNFV software download page <https://www.opnfv.org/software/>`_ + +.. _document-label: + +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + - OPNFV(Danube) Compass4nfv installation instructions + + - OPNFV(Danube) Compass4nfv Release Notes + +Version change +-------------- +.. This section describes the changes made since the last version of this document. + +Module version change +~~~~~~~~~~~~~~~~~~~~~ + +This is the Danube release of compass4nfv as a deployment toolchain in OPNFV, the following +upstream components supported with this release. + + - Ubuntu 16.04/Centos 7.3 + + - Openstack (Newton release) + + - Opendaylight (Boron SR2 release) + + - ONOS (J-bird release/later release) + +Document version change +~~~~~~~~~~~~~~~~~~~~~~~ + +Adjusted the document structure, and you can see document at `OPNFV(Danube) Compass4nfv installation instructions <http://artifacts.opnfv.org/compass4nfv/docs/configguide/index.html>`_. + +Reason for new version +---------------------- + +Feature additions +~~~~~~~~~~~~~~~~~ + ++--------------------------------------+-----------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+-----------------------------------------+ +| | | +| | | ++--------------------------------------+-----------------------------------------+ + + +Bug corrections +~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | ++--------------------------------------+--------------------------------------+ + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +------------------ + +**Max number of blades:** 1 Jumphost, 3 Controllers, 20 Compute blades + +**Min number of blades:** 1 Jumphost, 1 Controller, 1 Compute blade + +**Storage:** Ceph is the only supported storage configuration + +**Min Jumphost requirements:** At least 16GB of RAM, 16 core CPU + +Known issues +------------ + ++---------------+----------------------------------------------+ +| **Scenario** | **Issue** | ++---------------+----------------------------------------------+ +| | | ++---------------+----------------------------------------------+ +| | | ++---------------+----------------------------------------------+ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ + +Workarounds +----------- + + +Test Result +=========== +The Danube release with the Compass4nfv deployment toolchain has undergone QA test +runs with the following results: + + |