diff options
author | Jonas Bjurel <jonas.bjurel@ericsson.com> | 2015-06-02 22:15:52 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@172.30.200.206> | 2015-06-02 22:15:52 +0000 |
commit | f5cd1a97d49f11b393be18d592c5a8e4eff7acb0 (patch) | |
tree | 6721667c270300dfaaa3ea74d64174b4cbcabc2a | |
parent | 0266c6f64cfcf71f1f7f4c845ce5d38412056e2f (diff) | |
parent | d8466933939f811ddbb58bace7794d4b84eb4fbd (diff) |
Merge "Amended documents with further alignment of structure and some editorials. Prepared for final content updates and relase information. Added documentation tracking."
-rw-r--r-- | common/docs/user-guide.rst | 38 | ||||
-rw-r--r-- | foreman/docs/src/installation-instructions.rst | 25 | ||||
-rw-r--r-- | foreman/docs/src/release-notes.rst | 149 | ||||
-rw-r--r-- | fuel/docs/src/installation-instructions.rst | 24 | ||||
-rw-r--r-- | fuel/docs/src/release-notes.rst | 137 |
5 files changed, 211 insertions, 162 deletions
diff --git a/common/docs/user-guide.rst b/common/docs/user-guide.rst index d64372e..d482000 100644 --- a/common/docs/user-guide.rst +++ b/common/docs/user-guide.rst @@ -1,6 +1,3 @@ -:Authors: Christopher Price (christopher.price@ericsson.com) -:Version: 0.0.1 - ===================================== OPNFV User Guide for the Arno release ===================================== @@ -12,6 +9,7 @@ This document provides an overview of how to use the Arno release of OPNFV once License ======= + OPNFV User Guide for the Arno release (c) by Christopher Price (christopher.price@ericsson.com) OPNFV User Guide for the Arno release is 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/>. @@ -26,6 +24,9 @@ Version history | 2015-05-28 | 0.0.1 | Christopher Price | Initial version | | | | (Ericsson AB) | | +--------------------+--------------------+--------------------+--------------------+ +| 2015-06-02 | 0.0.2 | Christopher Price | Minor Updates | +| | | (Ericsson AB) | | ++--------------------+--------------------+--------------------+--------------------+ .. contents:: Table of Contents @@ -70,6 +71,11 @@ In order to deploy the Arno release on a Pharos compliant lab using the Foreman In order to deploy the Arno release on a Pharos compliant lab using the Fuel deployment toolchain you should follow in the Fuel installation guide: http://artifacts.opnfv.org/genesis/fuel/docs/installation-instructions.html +Enabling or disabling OpenDaylight and the native Neutron driver +---------------------------------------------------------------- + +You may find that you wish to adjust the system by enabling or disabling the native OpenStack Neutron driver depending on the tasks you are trying to achieve with the platform. Each of the deployment tools has the option to deploy with or without OpenDaylight enabled. Details of the available delpoyment options can be found in the associated installation-instructions, please note the platform validation procedures expect a fully deployed platform and results may vary depending on the options selected. + Deployment Validation --------------------- @@ -81,7 +87,7 @@ Operating the Arno platform The Arno release provides a platform for deploying software on virtual infrastructure. The majority of operations to be executed on the platform revolve around deploying, managing and removing software (applications) on the platform itself. Application deployment is covered in the following sections, however some platform operations you may want to perform include setting up a tenant, in OpenStack tenants are also known as projects in this document we will refer to them as tenants, and associated users for that tenant. OpenStack provides a good overview of how to create your first tenant for deploying your applications. You should create a tenant for your applications, associate users with the tenant and assign quota's. - - Open the OpenStack console (Horizon) you should find this by logging into your control node, for POD1 of the OPNFV lab this would be <172.30.9.70:80> +- Open the OpenStack console (Horizon) you should find this by logging into your control node; for example to access the console of POD1 of the OPNFV lab you would browse to <172.30.9.70:80> - Create your tenant and users by following the instructions at: http://docs.openstack.org/openstack-ops/content/projects_users.html Further actions and activities for checking logs and status can be found in other areas of the operations document: http://docs.openstack.org/openstack-ops/content/openstack-ops_preface.html @@ -99,6 +105,20 @@ Most actions you will want to perform can be executed from the OpenStack dashboa Frequently Asked Questions ========================== +Does OPNFV provide support for the Arno release? +------------------------------------------------ + +The Arno release of OPNFV is intended to be a developmental release and is not considered suitable for production deployment or at scale testing activities. As a developmental release, and in the spirit of collaborative development, we want as much feedback from the community as possible on your experiences with the platform and how the release can be improved. + +Support for Arno is provided in two ways: + +You can engage with the community to help us improve and further develop the OPNFV platform by raising Jira Bugs or Tasks, and pushing correction patches to our repositories. + + - To access Jira for issue reporting or improvement proposals head to: https://jira.opnfv.org/ + - To get started helping out developing the platform head to: https://wiki.opnfv.org/developer + +Alternatively if you are intending to invest your time as a user of the platform you can request support and help from our mailing list at: mailto://support@opnfv.org + License ======= @@ -119,3 +139,13 @@ OpenDaylight Foreman ------- + +:Authors: Christopher Price (christopher.price@ericsson.com) +:Version: 0.0.2 + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date_ + diff --git a/foreman/docs/src/installation-instructions.rst b/foreman/docs/src/installation-instructions.rst index df9030b..8f190e3 100644 --- a/foreman/docs/src/installation-instructions.rst +++ b/foreman/docs/src/installation-instructions.rst @@ -1,10 +1,12 @@ -:Authors: Tim Rozet (trozet@redhat.com) -:Version: 0.0.2 - ======================================================================================================= OPNFV Installation instructions for the Arno release of OPNFV when using Foreman as a deployment tool ======================================================================================================= + +.. contents:: Table of Contents + :backlinks: none + + Abstract ======== @@ -29,10 +31,9 @@ Version history | 2015-05-27 | 0.0.2 | Christopher Price | Minor changes & | | | | (Ericsson AB) | formatting | +--------------------+--------------------+--------------------+--------------------+ - - -.. contents:: Table of Contents - :backlinks: none +| 2015-06-02 | 0.0.3 | Christopher Price | Minor changes & | +| | | (Ericsson AB) | formatting | ++--------------------+--------------------+--------------------+--------------------+ Introduction @@ -343,3 +344,13 @@ OpenDaylight Foreman ------- + +:Authors: Tim Rozet (trozet@redhat.com) +:Version: 0.0.3 + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date_ + diff --git a/foreman/docs/src/release-notes.rst b/foreman/docs/src/release-notes.rst index da832e5..2fd3e2b 100644 --- a/foreman/docs/src/release-notes.rst +++ b/foreman/docs/src/release-notes.rst @@ -1,37 +1,25 @@ -:Authors: Tim Rozet (trozet@redhat.com) -:Version: 0.1 - =========================================================================================== OPNFV Release Note for the Arno release of OPNFV when using Foreman as a deployment tool =========================================================================================== + +.. contents:: Table of Contents + :backlinks: none + + Abstract ======== -This document provides the release notes for ARNO-RC2 release candidate of Foreman/QuickStack@OPNFV. +This document provides the release notes for Arno release with the Foreman/QuickStack deployment toolchain. License ======= -All Foreman/QuickStack and "common" entities are protected by the Apache License ( http://www.apache.org/licenses/ ) - -**Contents** - -1 Version History -2 Important notes - -3 Summary - -4 Delivery Data - -5 Known Limitations, Issues and Workarounds - -6 Test Result +All Foreman/QuickStack and "common" entities are protected by the Apache License ( http://www.apache.org/licenses/ ) -7 References -1 Version history -=================== +Version history +=============== +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | @@ -40,54 +28,52 @@ All Foreman/QuickStack and "common" entities are protected by the Apache License | 2015-04-16 | 0.1.0 | Tim Rozet | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2015-06-02 | 0.1.1 | Chris Price | Minor Edits | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ -2 Important notes -=================== +Important notes +=============== -This is the first OPNFV Arno pre-release that implements the deploy stage of the OPNFV CI pipeline. +This is the initial OPNFV Arno release that implements the deploy stage of the OPNFV CI pipeline. Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Foreman/QuickStack installer. -3 Summary -=========== - -Arno Foreman/QuickStack@OPNFV is an installer capable of setting up an OPNFV target system. The current definition of an OPNFV target system is OpenStack Juno upstream project versioncombined with OpenDaylight version: Helium. The system is deployed with OpenStack High Availability (HA) for most OpenStack services. OpenDaylight is deployed in non-HA form as HA is not availble for Arno release. Ceph storage is used as Cinder backend, and is the only supported storage for Arno. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node. +Summary +======= -This Arno pre-release of Foreman/QuickStack@OPNFV adds the deploy stage of the OPNFV CI pipeline +Arno release with the Foreman/QuickStack deployment toolchain will establish an OPNFV target system on a Pharos compliant lab infrastructure. The current definition of an OPNFV target system is and OpenStack Juno version combined with OpenDaylight version: Helium. The system is deployed with OpenStack High Availability (HA) for most OpenStack services. OpenDaylight is deployed in non-HA form as HA is not availble for Arno release. Ceph storage is used as Cinder backend, and is the only supported storage for Arno. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node. - Documentation is built by Jenkins - .iso image is built by Jenkins -- Jenkins deploys an Foreman/QuickStack@OPNFV stack to baremetal, which includes 3 control+network nodes, and 2 compute nodes. +- Jenkins deploys an Arno release with the Foreman/QuickStack deployment toolchain baremetal, which includes 3 control+network nodes, and 2 compute nodes. -Automatic test of the deployed system is not part of this pre-release. - -4 Release Data -================ +Release Data +============ +--------------------------------------+--------------------------------------+ -| **Project** | Arno/genesis/bgs | +| **Project** | genesis/bgs | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | genesis/arno-rc2 | +| **Repo/tag** | genesis/arno_1.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Arno RC2 | +| **Release designation** | Arno 1.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2015-04-23 | +| **Release date** | 2015-06-04 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Internal quality assurance | -| | and CI Pipline dry-run | +| **Purpose of the delivery** | OPNFV Arno release | | | | +--------------------------------------+--------------------------------------+ -4.1 Version change ------------------- +Version change +-------------- -4.1.1 Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of genesis-Foreman/QuickStack. It is based on following upstream versions: +Module version changes +~~~~~~~~~~~~~~~~~~~~~~ +This is the first tracked version of the Arno release with the Foreman/QuickStack deployment toolchain. It is based on following upstream versions: - OpenStack (Juno release) @@ -95,17 +81,16 @@ This is the first tracked version of genesis-Foreman/QuickStack. It is based on - CentOS 7 -4.1.2 Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of genesis-Foreman/QuickStack. It comes with the following documentation: +Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for - Foreman/QuickStack@OPNFV - ver. 0.0.1 -- OPNFV Release Note for "Arno-RC2 release candidate" - Foreman/QuickStack@OPNFV - ver. 0.1 (this document) +This is the first tracked version of Arno release with the Foreman/QuickStack deployment toolchain. The following documentation is provided with this release: -4.2 Reason for version ----------------------- -4.2.1 Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ +- OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0 +- OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0 (this document) + +Feature additions +~~~~~~~~~~~~~~~~~ +--------------------------------------+--------------------------------------+ | **JIRA REFERENCE** | **SLOGAN** | @@ -115,8 +100,8 @@ This is the first tracked version of genesis-Foreman/QuickStack. It comes with t | | using Foreman/Quickstack. | +--------------------------------------+--------------------------------------+ -4.2.2 Bug corrections -~~~~~~~~~~~~~~~~~~~~~ +Bug corrections +~~~~~~~~~~~~~~~ **JIRA TICKETS:** @@ -128,24 +113,24 @@ This is the first tracked version of genesis-Foreman/QuickStack. It comes with t | | | +--------------------------------------+--------------------------------------+ -4.3 Deliverables ----------------- +Deliverables +------------ -4.3.1 Software deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ Foreman/QuickStack@OPNFV .iso file deploy.sh - Automatically deploys Target OPNFV System to Bare Metal -4.3.2 Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for - Foreman/QuickStack@OPNFV - ver. 0.0.1 -- OPNFV Release Note for "Arno-RC2 release candidate" - Foreman/QuickStack@OPNFV - ver. 0.1 (this document) +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ +- OPNFV Installation instructions for the Arno release with the Foreman/QuickStack deployment toolchain - ver. 1.0.0 +- OPNFV Release Notes for the Arno release with the Foreman/QuickStack deployment toolchain - 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 Foreman/QuickStack master, 3 Controllers, 20 Compute blades @@ -156,8 +141,8 @@ deploy.sh - Automatically deploys Target OPNFV System to Bare Metal **Min master requirements:** At least 2048 MB of RAM -5.2 Known issues -------------------- +Known issues +------------ **JIRA TICKETS:** @@ -169,15 +154,15 @@ deploy.sh - Automatically deploys Target OPNFV System to Bare Metal | | by puppet | +--------------------------------------+--------------------------------------+ -5.3 Workarounds ------------------- +Workarounds +----------- **-** -6 Test Result -============== +Test Result +=========== -Foreman/QuickStack@OPNFV Arno RC2 has undergone QA test runs with the following results: +The Arno release with the Foreman/QuickStack deployment toolchain has undergone QA test runs with the following results: +--------------------------------------+--------------------------------------+ | **TEST-SUITE** | **Results:** | @@ -187,9 +172,19 @@ Foreman/QuickStack@OPNFV Arno RC2 has undergone QA test runs with the following +--------------------------------------+--------------------------------------+ -7 References -============= +References +========== For more information on the OPNFV Arno release, please see: http://wiki.opnfv.org/release/arno + +:Authors: Tim Rozet (trozet@redhat.com) +:Version: 0.2 + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date_ + diff --git a/fuel/docs/src/installation-instructions.rst b/fuel/docs/src/installation-instructions.rst index c90534d..59a5a8b 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 @@ -365,3 +365,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_ + |