diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/FAQ/index.rst | 4 | ||||
| -rw-r--r-- | docs/configguide/installerconfig.rst | 27 | ||||
| -rw-r--r-- | docs/configguide/references.rst | 2 | ||||
| -rw-r--r-- | docs/release-notes/release-notes.rst | 37 |
4 files changed, 31 insertions, 39 deletions
diff --git a/docs/FAQ/index.rst b/docs/FAQ/index.rst index dfe8de3e..f12a327f 100644 --- a/docs/FAQ/index.rst +++ b/docs/FAQ/index.rst @@ -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 diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst index 3d9269a4..e4611eec 100644 --- a/docs/configguide/installerconfig.rst +++ b/docs/configguide/installerconfig.rst @@ -17,8 +17,9 @@ nodes. The audience of this document is assumed to have good knowledge in networking and Unix/Linux administration. +------------- Preconditions -============= +------------- Before starting the installation of the Brahmaputra release of OPNFV, some planning must be done. @@ -28,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/ @@ -52,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 @@ -75,9 +85,9 @@ than or equal 3 servers, the Bare Metal deployment is recommended. The minimum n servers for Bare metal deployment is 3, 1 for JumpServer(Jumphost), 1 for controller, 1 for compute. - +------------------ Setup Requirements -================== +------------------ Jumphost Requirements --------------------- @@ -158,8 +168,9 @@ In order to execute a deployment, one must gather the following information: 3. MAC address of Control Plane / Provisioning interfaces of the Bare Metal nodes. +---------------------------------- Installation Guide (BM Deployment) -================================== +---------------------------------- Nodes Configuration (BM Deployment) ----------------------------------- diff --git a/docs/configguide/references.rst b/docs/configguide/references.rst index 0f317dd5..467bf08d 100644 --- a/docs/configguide/references.rst +++ b/docs/configguide/references.rst @@ -36,5 +36,3 @@ Compass `Compass Home Page <http://www.syscompass.org/>`_ -:Authors: Justin Chi (HUAWEI) - diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst index 9c4267a4..5b277db0 100644 --- a/docs/release-notes/release-notes.rst +++ b/docs/release-notes/release-notes.rst @@ -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 |