diff options
Diffstat (limited to 'fuel/docs')
| -rw-r--r-- | fuel/docs/src/installation-instructions.rst | 47 | ||||
| -rw-r--r-- | fuel/docs/src/release-notes.rst | 137 |
2 files changed, 101 insertions, 83 deletions
diff --git a/fuel/docs/src/installation-instructions.rst b/fuel/docs/src/installation-instructions.rst index c90534d..316b6c7 100644 --- a/fuel/docs/src/installation-instructions.rst +++ b/fuel/docs/src/installation-instructions.rst @@ -1,10 +1,11 @@ -:Authors: Jonas Bjurel (Ericsson AB) -:Version: 0.0.4 - ================================================================================================== OPNFV Installation instructions for the Arno release of OPNFV when using Fuel as a deployment tool ================================================================================================== +.. contents:: Table of Contents + :backlinks: none + + Abstract ======== @@ -35,10 +36,9 @@ Version history | 2015-05-27 | 0.0.4 | Christopher Price | Minor changes | | | | (Ericsson AB) | | +--------------------+--------------------+--------------------+--------------------+ - - -.. contents:: Table of Contents - :backlinks: none +| 2015-06-02 | 0.0.5 | Christopher Price | Minor changes | +| | | (Ericsson AB) | | ++--------------------+--------------------+--------------------+--------------------+ Introduction @@ -55,21 +55,27 @@ Preface Before starting the installation of the Arno release of OPNFV when using Fuel as a deployment tool, some planning must be done. -First of all, the Fuel deployment .iso image needs to be retrieved, the Latest stable Arno release of OPNFV when using Fuel as a deployment tool can be found here: <www.opnfv.org/abc/def> +Retrieving the ISO image +------------------------ + +First of all, the Fuel deployment arnofuel.iso image needs to be retrieved, the .iso image of the Arno release of OPNFV when using Fuel as a deployment tool can be found here at http://artifacts.opnfv.org/arno.2015.1.0/fuel/arno.2015.1.0.fuel.iso + +Building the ISO image +---------------------- -Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: +Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository. To retrieve the repository for the Arno release use the following command. <git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis> -Check-out the Arno release: +Check-out the Arno release tag to set the branch to the baseline required to replicate the Arno release. -<cd genesis; git checkout arno> +<cd genesis; git checkout arno.2015.1.0> Go to the fuel directory and build the .iso <cd fuel/build; make all> -For more information on how to build, please see "OPNFV Build instructions for - Arno release of OPNFV when using Fuel as a deployment tool <http://www.opnfv.org/xyz> +For more information on how to build, please see "OPNFV Build instructions for - Arno release of OPNFV when using Fuel as a deployment tool which you retrieves with the repository at </genesis/fuel/docs/src/build-instructions.rst> Next, familiarize yourself with the Fuel 6.0.1 version by reading the following documents: @@ -79,7 +85,6 @@ Next, familiarize yourself with the Fuel 6.0.1 version by reading the following - Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-6.0/operations.html#operations-guide> - A number of deployment specific parameters must be collected, those are: 1. Provider sub-net and gateway information @@ -133,17 +138,17 @@ The switching infrastructure provides connectivity for the OPNFV infrastructure The physical TOR switches are **not** automatically configured from the OPNFV reference platform. All the networks involved in the OPNFV infrastructure as well as the provider networks and the private tenant VLANs needs to be manually configured. -Manual configuration of the Arno hardware platform should be carried out according to the Pharos specification <link>. +Manual configuration of the Arno hardware platform should be carried out according to the Pharos specification http://artifacts.opnfv.org/arno.2015.1.0/docs/pharos-spec.arno.2015.1.0.pdf OPNFV Software installation and deployment ========================================== -This section describes the installation of the Fuel@OPNFV installation server (Fuel master) as well as the deployment of the full OPNFV reference platform stack across a server cluster. +This section describes the installation of the OPNFV installation server (Fuel master) as well as the deployment of the full OPNFV reference platform stack across a server cluster. Install Fuel master ------------------- -1. Mount the built .iso file (release/opnfv-<version>.iso) as a boot device to the jump host server. +1. Mount the built fuel.arno.2015.1.0.iso file as a boot device to the jump host server. 2. Reboot the jump host to establish the Fuel server. @@ -365,3 +370,13 @@ OpenDaylight Fuel ---- + +:Authors: Jonas Bjurel (Ericsson AB) +:Version: 0.0.5 + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date_ + diff --git a/fuel/docs/src/release-notes.rst b/fuel/docs/src/release-notes.rst index ddbe318..69560e1 100644 --- a/fuel/docs/src/release-notes.rst +++ b/fuel/docs/src/release-notes.rst @@ -1,40 +1,26 @@ -:Authors: Jonas Bjurel (Ericsson) -:Version: 0.3 - ===================================================================================== OPNFV Release Note for the Arno release of OPNFV when using Fuel as a deployment tool ===================================================================================== + +.. contents:: Table of Contents + :backlinks: none + + Abstract ======== -This document compiles the release notes for the ARNO release, when using Fuel as a deployment tool. +This document compiles the release notes for the Arno release of OPNFV when using Fuel as a deployment tool. License ======= -Arno release with th Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) - -Arno release with the Fuel deployment tool Docs are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>. - - -**Contents** -1 Version History +Arno release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) -2 Important notes - -3 Summary - -4 Delivery Data - -5 Known Limitations, Issues and Workarounds - -6 Test Result - -7 References +Arno release with the Fuel deployment tool Docs are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>. -1 Version history -=================== +Version history +=============== +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | @@ -49,16 +35,19 @@ Arno release with the Fuel deployment tool Docs are licensed under a Creative Co | 2015-05-12 | 0.3 | Chris Price | Minor edits | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2015-06-02 | 0.4 | Chris Price | Minor edits | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ -2 Important notes -=================== +Important notes +=============== For the first OPNFV release (Arno), these notes introduce use of `OpenStack Fuel <https://wiki.openstack.org/wiki/Fuel>`_ for the deployment stage of the OPNFV continuous integration (CI) pipeline. The goal of the Arno release and this Fuel-based deployment process is to establish a foundational platform accelerating further development of the OPNFV infrastructure. Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run before deployment is started. -3 Summary -=========== +Summary +======= For Arno, the typical use of Fuel as an OpenStack installer is supplemented with OPNFV unique components such as `OpenDaylight <http://www.opendaylight.org/software>`_ version Helium as well as OPNFV-unique configurations. @@ -73,35 +62,39 @@ This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pi - Automated validation of the Arno deployment -4 Release Data -================ +Release Data +============ +--------------------------------------+--------------------------------------+ -| **Project** | Arno/genesis/fuel | +| **Project** | genesis/bgs | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | genesis/arno | +| **Repo/tag** | genesis/arno_1.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Arno | +| **Release designation** | Arno 1.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2015-Spring | +| **Release date** | 2015-06-04 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | OPNFV Arno release | | | | +--------------------------------------+--------------------------------------+ -4.1 Version change ------------------- +Version change +-------------- -4.1.1 Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Module version changes +~~~~~~~~~~~~~~~~~~~~~~ This is the first tracked release of genesis/fuel. It is based on following upstream versions: -- Fuel 6.0.1 (Juno release) +- Fuel 6.0.1 +- OpenStack Juno release - OpenDaylight Helium-SR2 -4.1.2 Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~ This is the first tracked version of genesis/fuel. It comes with the following documentation: - OPNFV Installation instructions for Arno with Fuel as deployment tool @@ -109,10 +102,10 @@ This is the first tracked version of genesis/fuel. It comes with the following d - OPNFV Build instructions for Arno with Fuel as deployment tool -4.2 Reason for version ----------------------- -4.2.1 Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ +Reason for version +------------------ +Feature additions +~~~~~~~~~~~~~~~~~ +--------------------------------------+--------------------------------------+ | **JIRA REFERENCE** | **SLOGAN** | @@ -125,8 +118,8 @@ This is the first tracked version of genesis/fuel. It comes with the following d | | | +--------------------------------------+--------------------------------------+ -4.2.2 Bug corrections -~~~~~~~~~~~~~~~~~~~~~ +Bug corrections +~~~~~~~~~~~~~~~ **JIRA TICKETS:** @@ -138,23 +131,23 @@ This is the first tracked version of genesis/fuel. It comes with the following d | | | +--------------------------------------+--------------------------------------+ -4.3 Deliverables ----------------- +Deliverables +------------ -4.3.1 Software deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ Fuel-based installer iso (opnfv.iso) file -4.3.2 Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 0.0.1 -- OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 0.1 (this document) +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ +- OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 1.0.0 +- OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 1.0.0 (this document) -5 Known Limitations, Issues and Workarounds -============================================ +Known Limitations, Issues and Workarounds +========================================= -5.1 System Limitations -------------------------- +System Limitations +------------------ **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades @@ -166,8 +159,8 @@ Fuel-based installer iso (opnfv.iso) file **L3Agent:** L3 agent and floating IPs is not supported. -5.2 Known issues -------------------- +Known issues +------------ **JIRA TICKETS:** @@ -179,13 +172,13 @@ Fuel-based installer iso (opnfv.iso) file | | | +--------------------------------------+--------------------------------------+ -5.3 Workarounds ------------------- +Workarounds +----------- **-** -6 Test Result -============== +Test Result +=========== Arno release with the Fuel deployment tool has undergone QA test runs with the following results: @@ -197,7 +190,17 @@ Arno release with the Fuel deployment tool has undergone QA test runs with the f +--------------------------------------+--------------------------------------+ -7 References -============= +References +========== For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno. + +:Authors: Jonas Bjurel (Ericsson) +:Version: 0.4 + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date_ + |