Update release notes and installation instructions 19/10719/2
authorJustin-chi <chigang@huawei.com>
Thu, 25 Feb 2016 07:44:09 +0000 (15:44 +0800)
committerJustin-chi <chigang@huawei.com>
Thu, 25 Feb 2016 08:30:55 +0000 (16:30 +0800)
Final update for Brahmaputra 1.0 release
Removal faq from Brahmaputra 1.0
Update ODL version

Change-Id: I82b39ff09b934b6527fb539d2b1efd74ea62b533
Signed-off-by: Justin-chi <chigang@huawei.com>
docs/FAQ/index.rst
docs/configguide/installerconfig.rst
docs/configguide/references.rst
docs/release-notes/release-notes.rst

index dfe8de3..f12a327 100644 (file)
@@ -10,7 +10,3 @@ Contents:
 .. toctree::
    :numbered:
    :maxdepth: 4
-
-   how-to-build-customized-iso.rst
-   how-to-deploy-without-internet-access.rst
-   how-to-integrate-plugins.rst
index 932356c..e4611ee 100644 (file)
@@ -29,8 +29,12 @@ Retrieving the installation ISO image
 -------------------------------------
 
 First of all, The installation ISO is needed for deploying your OPNFV
-environment, it included packages of Compass,OpenStack,OpenDaylight,ONOS
-and so on. the iso can be retrieved via OPNFV artifacts repository:
+environment, it included packages of Compass, OpenStack, OpenDaylight, ONOS
+and so on.
+
+The stable release ISO can be retrieved via `OPNFV software download page <https://www.opnfv.org/software/>`_
+
+The daily build ISO can be retrieved via OPNFV artifacts repository:
 
 http://artifacts.opnfv.org/
 
@@ -53,13 +57,18 @@ To retrieve the repository of Compass4nfv on Jumphost use the following command:
 
 - git clone https://gerrit.opnfv.org/gerrit/compass4nfv
 
+To get stable/brahmaputra release, you can use the following command:
+
+- git checkout brahmaputra.1.0
+
 NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY.
 
-If you don't have a Linux foundation user id, get your own by the url:
+If you don't have a Linux foundation user id, get it first by the url:
 
 https://wiki.opnfv.org/developer/getting_started
 
-Set the branch to the corresponding deployment scripts:
+If you want to use a daily release ISO, please checkout the corresponding sha1 to
+get the deployment scripts:
 
 E.g.
 Git sha1 in file "opnfv-2016-01-16_15-03-18.properties" is
index 0f317dd..467bf08 100644 (file)
@@ -36,5 +36,3 @@ Compass
 
 `Compass Home Page <http://www.syscompass.org/>`_
 
-:Authors: Justin Chi (HUAWEI)
-
index 9c4267a..5b277db 100644 (file)
@@ -18,9 +18,8 @@ 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.
+Please carefully follow the Installation Instructions to deploy OPNFV using Compass4nfv
+installer.
 
 Release Data
 ============
@@ -48,27 +47,16 @@ Deliverables
 Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 
- - 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.
+ - Compass4nfv/Brahmaputra.1.0 ISO, please get it from `OPNFV software download page <https://www.opnfv.org/software/>`_
 
 .. _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>`_
+ - OPNFV(Brahmaputra) Compass4nfv installation instructions
 
- - `FAQ <http://artifacts.opnfv.org/compass4nfv/brahmaputra/docs/Brahmaputra_FAQ/index.html>`_
+ - OPNFV(Brahmaputra) Compass4nfv Release Notes
 
 Version change
 --------------
@@ -82,11 +70,11 @@ upstream components supported with this release.
 
  - Ubuntu 14.04.3
 
- - Openstack Liberty
+ - Openstack (Liberty release)
 
- - Opendaylight
+ - Opendaylight (Beryllium rc1 release)
 
- - ONOS Emu
+ - ONOS (Emu release)
 
 Document version change
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -109,7 +97,7 @@ Feature additions
 | JIRA: COMPASS-307                    | Integration OpenDaylight Beryllium      |
 |                                      |                                         |
 +--------------------------------------+-----------------------------------------+
-| JIRA:                                |                                         |
+|                                      |                                         |
 |                                      |                                         |
 +--------------------------------------+-----------------------------------------+
 
@@ -154,14 +142,13 @@ See JIRA: <link>
 
 Test Result
 ===========
-Brahmaputra test result using <Compass4nfv> as deployment tool.
+The Brahmaputra release with the Compass4nfv deployment toolchain has undergone QA test
+runs with the following results:
 
  - `Functest test result <http://artifacts.opnfv.org/functest/docs/results/overview.html>`_
+ - `Yardstick test result <http://testresults.opnfv.org/grafana/>`_
 
 References
 ==========
 For more information on the OPNFV Brahmaputra release, please visit
 http://www.opnfv.org/brahmaputra
-
-:Authors: Justin Chi (HUAWEI)
-:Version: 0.0.1