diff options
Diffstat (limited to 'fuel/docs/src')
| -rw-r--r-- | fuel/docs/src/installation-instructions.rst | 40 | ||||
| -rw-r--r-- | fuel/docs/src/release-notes.rst | 69 |
2 files changed, 53 insertions, 56 deletions
diff --git a/fuel/docs/src/installation-instructions.rst b/fuel/docs/src/installation-instructions.rst index 05f56f3..4c935d0 100644 --- a/fuel/docs/src/installation-instructions.rst +++ b/fuel/docs/src/installation-instructions.rst @@ -1,20 +1,20 @@ :Authors: Jonas Bjurel (Ericsson AB) -:Version: 0.0.2 +:Version: 0.0.3 -================================================ -OPNFV Installation instructions for - Fuel@OPNFV -================================================ +================================================================================================== +OPNFV Installation instructions for the Arno release of OPNFV when using Fuel as a deployment tool +================================================================================================== Abstract ======== -This document describes how to install Fuel@OPNFV, it's dependencies and required system resources. +This document describes how to install the Arno release of OPNFV when using Fuel as a deployment tool covering it's limitations, dependencies and required system resources. License ======= -Fuel@OPNFV DOCs (c) by Jonas Bjurel (Ericsson AB) +Arno release of OPNFV when using Fuel as a deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) -Fuel@OPNFV 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/>. +Arno release of OPNFV when using Fuel as a 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** @@ -50,23 +50,26 @@ Fuel@OPNFV DOCs are licensed under a Creative Commons Attribution 4.0 Internatio | 2015-04-23 | 0.0.2 | Jonas Bjurel | Minor changes | | | | (Ericsson AB) | | +--------------------+--------------------+--------------------+--------------------+ +| 2015-05-16 | 0.0.3 | Christopher Price | Minor changes | +| | | (Ericsson AB) | | ++--------------------+--------------------+--------------------+--------------------+ 2 Introduction ================ -This document describes the supported software and hardware configurations for the Fuel@OPNFV reference platform as well as providing guidelines on how to install and configure such reference system. +This document describes the supported software and hardware configurations for the Arno release of OPNFV when using Fuel as a deployment tool as well as providing guidelines on how to install and configure such reference system. Although the available installation options gives a high degree of freedom in how the system is set-up, with what architecture, services and features, etc., not nearly all of those permutations provides a OPNFV compliant reference architecture. Following the guidelines in this document ensures a result that is OPNFV R1 (Arno) compliant. -The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. +The audience of this document is assumed to have good knowledge in networking and Unix/Linux administration. 3 Preface =========== -Before starting the installation of Fuel@OPNFV, some planning must preceed. +Before starting the installation of Arno release of OPNFV when using Fuel as a deployment tool, some planning must preceed. -First of all, the Fuel@OPNFV .iso image needs to be retrieved, the Latest stable Arno release of Fuel@OPNFV can be found here: <www.opnfv.org/abc/def> +First of all, the Fuel@OPNFV .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> Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: @@ -80,7 +83,7 @@ Goto the fuel directory and build the .iso <cd fuel/build; make all> -For more information on how to build, please see "OPNF Build instructions for - FUel@OPNFV <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 <http://www.opnfv.org/xyz> Next, familiarize yourself with the Fuel 6.0.1 version by reading the following documents: @@ -140,17 +143,12 @@ Following minimum hardware requirements must be met for installation of Fuel@OPN 5 Top of the rack (TOR) Configuration requirements ==================================================== -The switching infrastructure provides connectivity for the OPNFV infra-structure operations, tenant networks (East/West) and provider connectivity (North/South bound connectivity); it als provides needed connectivity for the strage Area Network (SAN). To avoid traffic congestion, it is strongly sugested that three physcally separated networks are used, that is: 1 physical network for administration and control, one physical network for tenant private and public networks, and one physical network for SAN. The switching connectivity can (but does not need to) be fully redundant, in such case it and comprises a redundant 10GE switch pair for each of the three physcally separated networks. +The switching infrastructure provides connectivity for the OPNFV infra-structure operations, tenant networks (East/West) and provider connectivity (North/South bound connectivity); it also provides needed connectivity for the storage Area Network (SAN). To avoid traffic congestion, it is strongly sugested that three physcally separated networks are used, that is: 1 physical network for administration and control, one physical network for tenant private and public networks, and one physical network for SAN. The switching connectivity can (but does not need to) be fully redundant, in such case it and comprises a redundant 10GE switch pair for each of the three physcally separated networks. The physical TOR switches are **not** automatically configured from the OPNFV reference platform. All the networks involved in the OPNFV infra-structure as well as the provider networks and the private tenant VLANs needs to be manually configured. -The following sections guides through required black-box switch configurations. - -5.1 VLAN considerations and blue-print --------------------------------------- +Manual configuration of the Arno hardware platform should be carried out according to the Pharos specification <link>. -5.2 IP Address plan considerations and blue-print -------------------------------------------------- 6 OPNFV Software installation and deployment ============================================== @@ -159,9 +157,9 @@ This section describes the installation of the Fuel@OPNFV installation server (F 6.1 Install Fuel master ----------------------- -1. Mount the built .iso file (release/opnfv-<version>.iso) as a boot device to the fuel server. +1. Mount the built .iso file (release/opnfv-<version>.iso) as a boot device to the jump host server. -2. Reboot the fuel server. +2. Reboot the jump host to establish the Fuel server. - The system now boots from the ISO image. diff --git a/fuel/docs/src/release-notes.rst b/fuel/docs/src/release-notes.rst index 221b7f7..ddbe318 100644 --- a/fuel/docs/src/release-notes.rst +++ b/fuel/docs/src/release-notes.rst @@ -1,20 +1,20 @@ :Authors: Jonas Bjurel (Ericsson) -:Version: 0.2 +:Version: 0.3 -================================================================ -OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV -================================================================ +===================================================================================== +OPNFV Release Note for the Arno release of OPNFV when using Fuel as a deployment tool +===================================================================================== Abstract ======== -This document provides the release notes for ARNO-RC2 release candidate of Fuel@OPNFV. +This document compiles the release notes for the ARNO release, when using Fuel as a deployment tool. License ======= -Fuel@OPNFV DOCs (c) by Jonas Bjurel (Ericsson AB) +Arno release with th Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB) -Fuel@OPNFV 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/>. +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** @@ -46,26 +46,32 @@ Fuel@OPNFV DOCs are licensed under a Creative Commons Attribution 4.0 Internatio | 2015-04-23 | 0.2 | Jonas Bjurel | Minor change | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2015-05-12 | 0.3 | Chris Price | Minor edits | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ 2 Important notes =================== -This is the first OPNFV Arno pre-release that implements the deploy stage of the OPNFV CI pipeline. +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 ran befor deployment is started. +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 =========== -Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1, but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations. +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. -This Arno pre-release of Fuel@OPNFV adds the deploy stage of the OPNFV CI pipeline +This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including: -- Documentation is built by Jenkins -- .iso image is built by Jenkins -- Jenkins deploy an Fuel@OPNFV stack instance on a nested hypervisor environment (KVM) +- Documentation built by Jenkins + - this document (release notes) + - installation instructions + - build-instructions +- The Arno Fuel installer image (.iso) built by Jenkins +- Automated deployment of Arno with running on bare metal or a nested hypervisor environment (KVM) +- Automated validation of the Arno deployment -Automatic test of the deployed system is not part of this pre-release. 4 Release Data ================ @@ -74,17 +80,13 @@ Automatic test of the deployed system is not part of this pre-release. | **Project** | Arno/genesis/fuel | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | genesis/arno-rc2 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | Arno RC2 | +| **Repo/tag** | genesis/arno | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2015-04-16 | +| **Release designation** | Arno | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Internal quality assurance | -| | and CI Pipline dry-run | +| **Release date** | 2015-Spring | | | | +--------------------------------------+--------------------------------------+ @@ -93,20 +95,19 @@ Automatic test of the deployed system is not part of this pre-release. 4.1.1 Module version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of genesis/fuel. It is based on following upstream versions: +This is the first tracked release of genesis/fuel. It is based on following upstream versions: - Fuel 6.0.1 (Juno release) - - OpenDaylight Helium-SR2 -- Ubuntu 12.04.5 - 4.1.2 Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is the first tracked version of genesis/fuel. It comes with the following documentation: -- OPNFV Installation instructions for - Fuel@OPNFV - ver. 0.0.1 -- OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV - ver. 0.1 (this document) +- OPNFV Installation instructions for Arno with Fuel as deployment tool +- OPNFV Release Notes for Arno use of Fuel as deployment tool +- OPNFV Build instructions for Arno with Fuel as deployment tool + 4.2 Reason for version ---------------------- @@ -142,12 +143,12 @@ This is the first tracked version of genesis/fuel. It comes with the following d 4.3.1 Software deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Fuel@OPNFV .iso file +Fuel-based installer iso (opnfv.iso) file 4.3.2 Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for - Fuel@OPNFV - ver. 0.0.1 -- OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV - ver. 0.1 (this document) +- 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) 5 Known Limitations, Issues and Workarounds ============================================ @@ -186,7 +187,7 @@ Fuel@OPNFV .iso file 6 Test Result ============== -Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: +Arno release with the Fuel deployment tool has undergone QA test runs with the following results: +--------------------------------------+--------------------------------------+ | **TEST-SUITE** | **Results:** | @@ -199,6 +200,4 @@ Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: 7 References ============= -For more information on the OPNFV Arno release, please see: - -http://wiki.opnfv.org/release/arno +For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno. |