diff options
| -rw-r--r-- | docs/templates/installation-instructions.rst | 219 | ||||
| -rw-r--r-- | docs/templates/release-notes.rst | 48 |
2 files changed, 241 insertions, 26 deletions
diff --git a/docs/templates/installation-instructions.rst b/docs/templates/installation-instructions.rst new file mode 100644 index 000000000..388907ea6 --- /dev/null +++ b/docs/templates/installation-instructions.rst @@ -0,0 +1,219 @@ +:Authors: Jonas Bjurel (Ericsson) +:Version: 0.1 + +================================================================ +OPNFV Installation instructions for - < Component denomination > +================================================================ + +Abstract +======== + +This document describes how to install <Component>, it's dependencies and required system resources. + +License +======= +<WORK'S NAME> (c) by <AUTHOR'S NAME> + +<WORK'S NAME> is licensed under a Creative Commons Attribution 4.0 Unported 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 + +2 Introduction + +3 Preface + +4 Hardware requirements + +5 Top of the rack (TOR) Configuration requirements + +6 OPNFV Software installation and deployment + +7 Installation health-check + +8 Post installation and deployment actions + +9 References + +1 Version history +=================== + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 0.1.1 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 1.0 | | | +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +2 Introduction +================ +<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED> + +<EXAMPLE>: + +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. + +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 compliant. + +The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. + +3 Preface +=========== +<DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.> + +<EXAMPLE>: + +Before starting the installation of Fuel@OPNFV, 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> + +Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: +<git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis> +Check-out the Arno release: +<cd genesis; git checkout arno> +Goto the fuel directory and build the .iso +<cd fuel/build; make all> + +Familiarize yourself with the Fuel 6.0.1 version by reading the following documents: +- abc <http://wiki.openstack.org/abc> +- def <http://wiki.openstack.org/def> +- ghi <http://wiki.openstack.org/ghi> + +Secondly, a number of deployment specific parameters must be collected, those are: + +1. Provider sub-net and gateway information + +2. Provider VLAN information + +3. Provider DNS addresses + +4. Provider NTP addresses + +This information will be needed for the configuration procedures provided in this document. + +4 Hardware requirements +========================= +<PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL> + +<EXAMPLE>: + +Following minimum hardware requirements must be met for installation of Fuel@OPNFV: + ++--------------------+----------------------------------------------------+ +| **HW Aspect** | **Requirement** | +| | | ++--------------------+----------------------------------------------------+ +| **# of servers** | Minimum 5 (3 for non redundant deployment) | +| | 1 Fuel deployment master (may be virtualized) | +| | 3(1) Controllers | +| | 1 Compute | ++--------------------+----------------------------------------------------+ +| **CPU** | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz | +| | | ++--------------------+----------------------------------------------------+ +| **RAM** | Minimum 16GB/server (Depending on VNF work load) | +| | | ++--------------------+----------------------------------------------------+ +| **Disk** | Minimum 256GB 10kRPM spinning disks | +| | | ++--------------------+----------------------------------------------------+ +| **NICs** | 2(1)x10GE Niantec for Private/Public (Redundant) | +| | | +| | 2(1)x10GE Niantec for SAN (Redundant) | +| | | +| | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) | +| | | ++--------------------+----------------------------------------------------+ + +5 Top of the rack (TOR) Configuration requirements +==================================================== +<DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs> + +<EXAMPLE>: + +The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as for the tenant networks (East/West) and provider connectivity (North/South bound connectivity). The switching connectivity can (but does not need to) be fully redundant, in case it and comprises a redundant 10GE switch pair for “Traffic/Payload/SAN” purposes as well as a 1GE switch pair for “infrastructure control-, management and administration” + +The 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. + +This following sections guides through required black-box switch configurations. + +5.1 VLAN considerations and blue-print +-------------------------------------- + +5.2 IP Address plan considerations and blue-print +------------------------------------------------- + +6 OPNFV Software installation and deployment +============================================== +<DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT> + +<EXAMPLE>: + +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. +Etc. + +6.1 Install Fuel master +----------------------- + +6.2 Create an OPNV (Fuel Environment) +------------------------------------- + +6.3 Configure the OPNFV environment +----------------------------------- + +6.4 Deploy the OPNFV environment +-------------------------------- + +7 Installation health-check +============================ +<DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL> + +<EXAMPLE>: + +Now that the OPNFV environment has been created, and before the post installation configurations is started, perform a system health check from the Fuel GUI: + +- Select the “Health check” TAB. +- Select all test-cases +- And click “Run tests” + +All test cases except the following should pass: + +8 Post installation and deployment actions +============================================ +<DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED> + +<EXAMPLE>: +After the OPNFV deployment is completed, the following manual changes needs to be performed in order for the system to work according OPNFV standards. + +**Change host OS password:** +Change the Host OS password by...... + +9 References +============= +<PROVIDE NEEDED/USEFUL REFERENCES> + +<EXAMPLES>: + +9.1 OPNFV +------------- + +9.2 OpenStack +----------------- + +9.3 OpenDaylight +-------------------- + +9.4 Fuel +------------
\ No newline at end of file diff --git a/docs/templates/release-notes.rst b/docs/templates/release-notes.rst index 56a1ade13..d6b21cbeb 100644 --- a/docs/templates/release-notes.rst +++ b/docs/templates/release-notes.rst @@ -1,18 +1,16 @@ -:Authors: - Jonas Bjurel (Ericsson) - :Version: 0.1 +:Authors: Jonas Bjurel (Ericsson) +:Version: 0.1 -================================================================== -Release Note for OPNFV "Arno release" - < Component denomination > -================================================================== +====================================================================== +OPNFV Release Note for "Arno-SRx release" - < Component denomination > +====================================================================== Abstract ======== -This document describes delivery revision information from the CEE 15A -project. +This document provides the release notes for <RELEASE> of <COMPONENT>. -Licence +License ======= <WORK'S NAME> (c) by <AUTHOR'S NAME> @@ -42,7 +40,7 @@ Licence | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2015-04-14 | 0.1.0 | UABJONB | First draft | +| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ | | 0.1.1 | | | @@ -50,13 +48,12 @@ Licence +--------------------+--------------------+--------------------+--------------------+ | | 1.0 | | | | | | | | -| | | | | +--------------------+--------------------+--------------------+--------------------+ 2 Important notes =================== -<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITTERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE> +<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE> <EXAMPLE>: @@ -69,11 +66,11 @@ Licence <EXAMPLE>: -Arno Fuel@OPNFV is based the OpenStack Fuel upstrem project version 6.0.1, but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations...... +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...... 4 Release Data ================ -<STATE RELEVANT RELEASE DATA/RECCORDS> +<STATE RELEVANT RELEASE DATA/RECORDS> <EXAMPLE>: @@ -81,7 +78,7 @@ Arno Fuel@OPNFV is based the OpenStack Fuel upstrem project version 6.0.1, but a | **Project** | E.g. Arno/genesis/fuel@opnfv | | | | +--------------------------------------+--------------------------------------+ -| **Repo/commitID** | E.g. genesis/adf634a0d4..... | +| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | | | | +--------------------------------------+--------------------------------------+ | **Release designation** | E.g. Arno RC2 | @@ -113,8 +110,7 @@ Arno Fuel@OPNFV is based the OpenStack Fuel upstrem project version 6.0.1, but a <EXAMPLE>: -- The Fuel@OPNFV installation guide version has cheanged from version 0.1 to to 0.2 - +- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2 4.2 Reason for version ---------------------- @@ -130,10 +126,10 @@ Arno Fuel@OPNFV is based the OpenStack Fuel upstrem project version 6.0.1, but a | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| BGS-123 | ADD OpenDaylight ML2 integration | +| BGS-123 | ADD OpenDaylight ml2 integration | | | | +--------------------------------------+--------------------------------------+ -| BGS-456 | Add autodeployment of Fuel@OPNFV | +| BGS-456 | Add auto-deployment of Fuel@OPNFV | | | | +--------------------------------------+--------------------------------------+ @@ -153,21 +149,20 @@ Arno Fuel@OPNFV is based the OpenStack Fuel upstrem project version 6.0.1, but a | | | +--------------------------------------+--------------------------------------+ - 4.3 Deliverables ---------------- 4.3.1 Software deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETREIVED> +<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED> <EXAMPLE>: 4.3.2 Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETREIVED> +<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED> <EXAMPLE>: @@ -176,7 +171,7 @@ Arno Fuel@OPNFV is based the OpenStack Fuel upstrem project version 6.0.1, but a 5.1 System Limitations ------------------------- -<STATE ALL RELLEVANT SYSTEM LIMITATIONS> +<STATE ALL RELEVANT SYSTEM LIMITATIONS> <EXAMPLE>: @@ -186,7 +181,7 @@ Arno Fuel@OPNFV is based the OpenStack Fuel upstrem project version 6.0.1, but a **Storage:** Ceph is the only supported storage configuration. -**Max number of networks:** 3800 (Needs special switch config) +**Max number of networks:** 3800 (Needs special switch config.) **L3Agent:** L3 agent and floating IPs is not supported. @@ -239,7 +234,7 @@ Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: | | | | | 2. Heat deploy.... | +--------------------------------------+--------------------------------------+ -| Robot sest suite 456 | Following tests failed: | +| Robot test suite 456 | Following tests failed: | | | | | | 1....... | | | | @@ -253,4 +248,5 @@ Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: <EXAMPLE>: For more information on the OPNFV Arno release, please see: -http://wiki.opnfv.org/release/arno
\ No newline at end of file + +http://wiki.opnfv.org/release/arno |