diff options
author | ChristopherPrice <christopher.price@ericsson.com> | 2016-02-22 21:26:30 +0100 |
---|---|---|
committer | Justin chi <chigang@huawei.com> | 2016-02-23 09:37:38 +0000 |
commit | 3eab3cd722870e6c02ee1337d3536dc68f89b13e (patch) | |
tree | 9abe519e5c9301c25796adda5e58d99d66705832 /docs/release-notes/release-notes.rst | |
parent | 8906fd0b7886fac22cc85839992634cf9f020a23 (diff) |
Adding aligned structure and segmenting the configguide.
Also set heading levels for readability and added missing licence headers.
Copied the header where I copied content, so please be mindful and inform me if you disagree.
Removal parts of userguide duplicated with configguide. Take the others into faq.rst
Removal duplicated references in installerconfig.
Removal redundant png files.
Release notes update for Brahmaputra release.
Change-Id: I6e1a101107752f4bc7b6e3bbaea0738690d07af8
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Signed-off-by: Justin-chi <chigang@huawei.com>
Diffstat (limited to 'docs/release-notes/release-notes.rst')
-rw-r--r-- | docs/release-notes/release-notes.rst | 80 |
1 files changed, 57 insertions, 23 deletions
diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst index df055d5f..9c4267a4 100644 --- a/docs/release-notes/release-notes.rst +++ b/docs/release-notes/release-notes.rst @@ -7,18 +7,17 @@ Release Note for the Brahmaputra release of OPNFV when using Compass4nfv as a de ============================================================================================= -.. toctree:: - :maxdepth: 2 - Abstract ======== This document describes release notes of OPNFV when using Compass4nfv as a -deployment tool. +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. Provide a brief introduction of how this release is used in OPNFV release using <XYZ> as a deployment tool Be sure to reference your installation-instructions. @@ -27,19 +26,19 @@ Release Data ============ +--------------------------------------+--------------------------------------+ -| **Project** | | +| **Project** | Compass4nfv | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | | +| **Repo/tag** | Compass4nfv/Brahmaputra.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | | +| **Release designation** | Brahmaputra.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | | +| **Release date** | 2016.2.25 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | +| **Purpose of the delivery** | OPNFV Brahmaputra release | | | | +--------------------------------------+--------------------------------------+ @@ -48,11 +47,28 @@ Deliverables Software deliverables ~~~~~~~~~~~~~~~~~~~~~ -<XYZ>-based installer iso file <iso file version> + + - Deployment Script + + It is a part of Compass4nfv repository, the entry of deployment sctripts is "compass4nfv/deploy.sh", + to retrieve the repository of Compass4nfv by following command: + + git clone https://gerrit.opnfv.org/gerrit/compass4nfv + + - `Compass4nfv ISO link <http://artifacts.opnfv.org/compass4nfv/brahmaputra/opnfv-2016-02-17_14-01-01.iso>`_ + +.. This link will be updated at final release. + +.. _document-label: Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- + + - `Installation Instructions <http://artifacts.opnfv.org/compass4nfv/brahmaputra/docs/Brahmaputra_installation-instructions/index.html>`_ + + - `Release Notes <http://artifacts.opnfv.org/compass4nfv/brahmaputra/docs/Brahmaputra_release-notes/index.html>`_ + + - `FAQ <http://artifacts.opnfv.org/compass4nfv/brahmaputra/docs/Brahmaputra_FAQ/index.html>`_ Version change -------------- @@ -61,25 +77,42 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ +This is the first release of compass4nfv as a deployment toolchain in OPNFV, the following +upstream components supported with this release. + + - Ubuntu 14.04.3 + + - Openstack Liberty + + - Opendaylight + + - ONOS Emu + Document version change ~~~~~~~~~~~~~~~~~~~~~~~ +None due to first release, and you can see document :ref:`document-label`. + Reason for new version ---------------------- Feature additions ~~~~~~~~~~~~~~~~~ -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ ++--------------------------------------+-----------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+-----------------------------------------+ +| JIRA: COMPASS-34 | Support OpenStack Liberty deployment | +| | | ++--------------------------------------+-----------------------------------------+ +| JIRA: COMPASS-307 | Integration OpenDaylight Beryllium | +| | | ++--------------------------------------+-----------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+-----------------------------------------+ + Bug corrections ~~~~~~~~~~~~~~~ @@ -121,8 +154,9 @@ See JIRA: <link> Test Result =========== -Brahmaputra test result using <XYZ> as deployment tool. -<link> +Brahmaputra test result using <Compass4nfv> as deployment tool. + + - `Functest test result <http://artifacts.opnfv.org/functest/docs/results/overview.html>`_ References ========== |