diff options
Diffstat (limited to 'fuel')
| -rw-r--r-- | fuel/LICENCE | 1 | ||||
| -rw-r--r-- | fuel/README | 1 | ||||
| -rw-r--r-- | fuel/TODO | 9 | ||||
| -rw-r--r-- | fuel/build/RELEASENOTES | 32 | ||||
| -rw-r--r-- | fuel/build/TODO | 10 | ||||
| -rw-r--r-- | fuel/docs/src/installation-instructions.rst | 219 | ||||
| -rw-r--r-- | fuel/docs/src/release-notes.rst | 252 | ||||
| -rw-r--r-- | fuel/docs/src/tmp/BUILD/README.architecture (renamed from fuel/build/DOC/BUILD/README.architecture) | 0 | ||||
| -rw-r--r-- | fuel/docs/src/tmp/BUILD/README.build (renamed from fuel/build/DOC/BUILD/README.build) | 0 | ||||
| -rw-r--r-- | fuel/docs/src/tmp/BUILD/README.examples (renamed from fuel/build/DOC/BUILD/README.examples) | 0 | ||||
| -rw-r--r-- | fuel/docs/src/tmp/INSTALL/README (renamed from fuel/build/DOC/INSTALL/README) | 0 |
11 files changed, 482 insertions, 42 deletions
diff --git a/fuel/LICENCE b/fuel/LICENCE new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/fuel/LICENCE @@ -0,0 +1 @@ + diff --git a/fuel/README b/fuel/README new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/fuel/README @@ -0,0 +1 @@ + diff --git a/fuel/TODO b/fuel/TODO new file mode 100644 index 0000000..906dfb5 --- /dev/null +++ b/fuel/TODO @@ -0,0 +1,9 @@ +######################################################################### +# Contributors/version/date +# jonas.bjurel@ericsson.com 0.2 2015.04.14 +######################################################################### +Following items needs to be done to achieve an OPNFV/BGS ARNO Fuel Stack: +1) Add support for CentOS 6.5 - REMAINING +2) Add Autodeployment "deploy.sh" for Jenkins +3) Dry-run Funktest (Jenkins/Robot/etc.) +4) Finalize Documentation
\ No newline at end of file diff --git a/fuel/build/RELEASENOTES b/fuel/build/RELEASENOTES deleted file mode 100644 index 76b4208..0000000 --- a/fuel/build/RELEASENOTES +++ /dev/null @@ -1,32 +0,0 @@ -############################################################################## -# Copyright (c) 2015 Ericsson AB and others. -# stefan.k.berg@ericsson.com -# jonas.bjurel@ericsson.com -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## - -This patch introduces the following features and bug fixes: ------------------------------------------------------------ -1) The OpenDaylight SDN server - unplumbed (config.mk needs to be changed - in order to enable it, see: fuel-build/DOC/BUILD/README.build) -2) cofig-spec - a way to configure the stack component versions - to be built - see the fuel-build/config.mk file -3) A simplified Docker build startegy, pulling a pre-fabricated - docker base image from the Internet - -NOTE: Before you start building - you need to purge any previous -"opnfv.org/ubuntu-builder" docker image: "sudo docker rmi -f opnfv.org/ubuntu-builder -Double check that you dont have any remaining "opnfv.org/ubuntu-builder" images by -"docker images". -A new docker image will automatically be rebuilt in the build process. - -Limitations and known issues: ------------------------------ -1) OpenDaylight is for now just sitting in the controllers, not plumbed to anything - northbound or southbound. -2) OpenDaylight is currently only building with Oracle Java JDK, that is Oracle Java - is used in the build process while OpenJava is used in the runtime environment. - Read the licencing obligations in /fuel-build/LICENCE before you start building. diff --git a/fuel/build/TODO b/fuel/build/TODO deleted file mode 100644 index 897a7e8..0000000 --- a/fuel/build/TODO +++ /dev/null @@ -1,10 +0,0 @@ -############################################ -# Contributors/version/date -# jonas.bjurel@ericsson.com 0.1 2015.01.28 -############################################ -Following items needs to be done to achieve an OPNFV/BGS R1 Stack: -1) Rebase to Fuel 6.0/6.1 - DONE -2) Add support for CentOS 6.5 - REMAINING -3) Add build-support and manifests for Open daylight Ubuntu and CentOS - - Initial build and deployment of ODL/Helium - DONE - - Configuration and plumbing - IN PROGRESS
\ No newline at end of file diff --git a/fuel/docs/src/installation-instructions.rst b/fuel/docs/src/installation-instructions.rst new file mode 100644 index 0000000..388907e --- /dev/null +++ b/fuel/docs/src/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/fuel/docs/src/release-notes.rst b/fuel/docs/src/release-notes.rst new file mode 100644 index 0000000..d6b21cb --- /dev/null +++ b/fuel/docs/src/release-notes.rst @@ -0,0 +1,252 @@ +:Authors: Jonas Bjurel (Ericsson) +:Version: 0.1 + +====================================================================== +OPNFV Release Note for "Arno-SRx release" - < Component denomination > +====================================================================== + +Abstract +======== + +This document provides the release notes for <RELEASE> of <COMPONENT>. + +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 Important notes + +3 Summary + +4 Delivery Data + +5 Known Limitations, Issues and Workarounds + +6 Test Result + +7 References + +1 Version history +=================== + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 0.1.1 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 1.0 | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +2 Important notes +=================== + +<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE> + +<EXAMPLE>: + +**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master – see the OPNFV@Fuel SW installation instructions + +3 Summary +=========== + +<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES> + +<EXAMPLE>: + +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/RECORDS> + +<EXAMPLE>: + ++--------------------------------------+--------------------------------------+ +| **Project** | E.g. Arno/genesis/fuel@opnfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | E.g. Arno RC2 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | E.g. 2015-04-16 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance| +| | | ++--------------------------------------+--------------------------------------+ + +4.1 Version change +------------------ + +4.1.1 Module version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED> + +<EXAMPLE>: + +- Fuel have changed from 5.1 to 6.0.1 + +- OpenDaylight has changed from Helium-SR1 to Helium-SR2 + +4.1.2 Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE> + +<EXAMPLE>: + +- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2 + +4.2 Reason for version +---------------------- +4.2.1 Feature additions +~~~~~~~~~~~~~~~~~~~~~~~ +<STATE ADDED FEATURES BY REFERENCE TO JIRA> + +<EXAMPLE>: + +**JIRA BACK-LOG:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-123 | ADD OpenDaylight ml2 integration | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-456 | Add auto-deployment of Fuel@OPNFV | +| | | ++--------------------------------------+--------------------------------------+ + +4.2.2 Bug corrections +~~~~~~~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-888 | Fuel doesn't deploy | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-999 | Floating IP doesn't work | +| | | ++--------------------------------------+--------------------------------------+ + +4.3 Deliverables +---------------- + +4.3.1 Software deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +<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 RETRIEVED> + +<EXAMPLE>: + +5 Known Limitations, Issues and Workarounds +============================================ + +5.1 System Limitations +------------------------- +<STATE ALL RELEVANT SYSTEM LIMITATIONS> + +<EXAMPLE>: + +**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades + +**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade + +**Storage:** Ceph is the only supported storage configuration. + +**Max number of networks:** 3800 (Needs special switch config.) + +**L3Agent:** L3 agent and floating IPs is not supported. + +5.2 Known issues +------------------- +<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE> + +<EXAMPLE>: + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-987 | Nova-compute process does | +| | not re-spawn when killed | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-654 | MOS 5.1 : neutron net-list returns | +| | "400 Bad request" | +| | | ++--------------------------------------+--------------------------------------+ + +5.3 Workarounds +------------------ + +<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE> + +<EXAMPLE>: + +- In case the contact with a compute is lost - restart the compute host +- In case the disk is full on a controller - delete all files in /tmp + +6 Test Result +============== +<STATE THE QA COVERAGE AND RESULTS> + +<EXAMPLE>: + +Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: + ++--------------------------------------+--------------------------------------+ +| **TEST-SUITE** | **Results:** | +| | | ++--------------------------------------+--------------------------------------+ +| Tempest test suite 123 | Following tests failed: | +| | | +| | 1. Image resizing.... | +| | | +| | 2. Heat deploy.... | ++--------------------------------------+--------------------------------------+ +| Robot test suite 456 | Following tests failed: | +| | | +| | 1....... | +| | | +| | 2....... | ++--------------------------------------+--------------------------------------+ + +7 References +============= +<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION> + +<EXAMPLE>: + +For more information on the OPNFV Arno release, please see: + +http://wiki.opnfv.org/release/arno diff --git a/fuel/build/DOC/BUILD/README.architecture b/fuel/docs/src/tmp/BUILD/README.architecture index 4629763..4629763 100644 --- a/fuel/build/DOC/BUILD/README.architecture +++ b/fuel/docs/src/tmp/BUILD/README.architecture diff --git a/fuel/build/DOC/BUILD/README.build b/fuel/docs/src/tmp/BUILD/README.build index b8ce799..b8ce799 100644 --- a/fuel/build/DOC/BUILD/README.build +++ b/fuel/docs/src/tmp/BUILD/README.build diff --git a/fuel/build/DOC/BUILD/README.examples b/fuel/docs/src/tmp/BUILD/README.examples index 4629763..4629763 100644 --- a/fuel/build/DOC/BUILD/README.examples +++ b/fuel/docs/src/tmp/BUILD/README.examples diff --git a/fuel/build/DOC/INSTALL/README b/fuel/docs/src/tmp/INSTALL/README index 456e26d..456e26d 100644 --- a/fuel/build/DOC/INSTALL/README +++ b/fuel/docs/src/tmp/INSTALL/README |