From 0f416cdda6a27f8d3dabd84dfe6bf09e9b681cf3 Mon Sep 17 00:00:00 2001 From: Jonas Bjurel Date: Tue, 14 Apr 2015 23:30:26 +0200 Subject: Initial rearrangements for the OPNFV/opnfvdoc documentation structure including LOW level READMEs, LICENCEs, and TODOs. JIRA: Change-Id: Ifd2baa5b1db3ae0fb354e39548eb7f9547639581 Signed-off-by: Jonas Bjurel --- fuel/LICENCE | 1 + fuel/README | 1 + fuel/TODO | 9 + fuel/build/DOC/BUILD/README.architecture | 10 -- fuel/build/DOC/BUILD/README.build | 98 ----------- fuel/build/DOC/BUILD/README.examples | 10 -- fuel/build/DOC/INSTALL/README | 154 ----------------- fuel/build/RELEASENOTES | 32 ---- fuel/build/TODO | 10 -- fuel/docs/src/installation-instructions.rst | 219 ++++++++++++++++++++++++ fuel/docs/src/release-notes.rst | 252 ++++++++++++++++++++++++++++ fuel/docs/src/tmp/BUILD/README.architecture | 10 ++ fuel/docs/src/tmp/BUILD/README.build | 98 +++++++++++ fuel/docs/src/tmp/BUILD/README.examples | 10 ++ fuel/docs/src/tmp/INSTALL/README | 154 +++++++++++++++++ 15 files changed, 754 insertions(+), 314 deletions(-) create mode 100644 fuel/LICENCE create mode 100644 fuel/README create mode 100644 fuel/TODO delete mode 100644 fuel/build/DOC/BUILD/README.architecture delete mode 100644 fuel/build/DOC/BUILD/README.build delete mode 100644 fuel/build/DOC/BUILD/README.examples delete mode 100644 fuel/build/DOC/INSTALL/README delete mode 100644 fuel/build/RELEASENOTES delete mode 100644 fuel/build/TODO create mode 100644 fuel/docs/src/installation-instructions.rst create mode 100644 fuel/docs/src/release-notes.rst create mode 100644 fuel/docs/src/tmp/BUILD/README.architecture create mode 100644 fuel/docs/src/tmp/BUILD/README.build create mode 100644 fuel/docs/src/tmp/BUILD/README.examples create mode 100644 fuel/docs/src/tmp/INSTALL/README 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/DOC/BUILD/README.architecture b/fuel/build/DOC/BUILD/README.architecture deleted file mode 100644 index 4629763..0000000 --- a/fuel/build/DOC/BUILD/README.architecture +++ /dev/null @@ -1,10 +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 -############################################################################## - diff --git a/fuel/build/DOC/BUILD/README.build b/fuel/build/DOC/BUILD/README.build deleted file mode 100644 index b8ce799..0000000 --- a/fuel/build/DOC/BUILD/README.build +++ /dev/null @@ -1,98 +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 -############################################################################## - -How to setup and use the OPNFV/BGS/FUEL build system -==================================================== - -1. Build system requirements ----------------------------- -1.1 Host HW/VM requirements ---------------------------- -- An x86_64 host (real iron or VM) with Ubuntu 14.04 LTS installed -- ~30 GB available disc -- 4 GB RAM - -1.2 Host SW dependencies ------------------------- -The host should run Ubuntu 14.04 -On the host, the following packages must be installed: -- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes -for Ubuntu 14.04. Note: only use the Ubuntu stock distro of Docker (docker.io) -- git (simply available through apt-get install git) -- make (simply available through apt-get install make) -- curl - -2 Setting up the Docker build container ----------------------------------------- -When having installed Docker, add yourself to the docker group: -usermod -a -G docker - -Also make sure to define rellevant dns servers part of the global dns chain in -in your /etc/default/docker config file, eg. -DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4" - -Then restart docker with "service docker.io restart".: - -3. Setting up OPNFV Gerrit in order to being able to clone the code -------------------------------------------------------------------- -- Start by creating a SSH key, if you don't already have one, create one with ssh-keygen - -- Add your generated public key in OPNFV Gerrit -https://gerrit.opnfv.org/ - (this requires a linuxfoundation account, create one if you do not already have one) - -- Select "SSH Public Keys" to the left and then "Add Key" and paste your public key in. - -4. Clone the OPNFV code git repository --------------------------------------- - So now we're coming to the fun part! Let's clone the code repository: - git clone ssh://@gerrit.opnfv.org:29418/genesis - - Change the directory to "fuel-build" - cd fuel-build/ - -5. Set up (build) your build environment ----------------------------------------- -Select the versions of the components you want to build by editing the -fuel-build/config-spec file. Note if you want to build with OpenDaylight -SDN controller you need to uncomment the lines starting with odl-main and -java-main - -6. Build your fuel .iso image ------------------------------ -That's it, time to build! -make [all] - -This will: -- If not allready existing, initialize the docker build environment -- If not already done, build OpenDaylight from upstream (as defined by fuel-build/ - config-spec) -- If not already done, build fuel from upstream (as defined by fuel-build/config-spec) -- Build the defined additions to fuel (as defined by the structure of this framework) -- Apply changes and patches to fuel (as defined by the structure of this framework) -- Reconstruct a fuel .iso image - -If the build is successful, you will find the generated ISO file in the release -subdirectory! - -NOTE: the build of the baseline for Fuel and odl are cached, if build results reffering -to the same versions as specified in fuel-build/config spec has been built before, these -packages will not be rebuilt. The cache is cleared by "make clean" - -7. Install your stack ---------------------- -Please see DOC/INSTALL/README - -NOTES and TODO: ---------------- -The build system will for now partly run as sudo -BUT NOTE, NONE OF THE MAKEFILES OR SCRIPTS SHALL BE EXECUTED WITH -SUDO/ROOT PRIVILEDGES! -TODO: Change the scripts so that no root priviledges will be needed - diff --git a/fuel/build/DOC/BUILD/README.examples b/fuel/build/DOC/BUILD/README.examples deleted file mode 100644 index 4629763..0000000 --- a/fuel/build/DOC/BUILD/README.examples +++ /dev/null @@ -1,10 +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 -############################################################################## - diff --git a/fuel/build/DOC/INSTALL/README b/fuel/build/DOC/INSTALL/README deleted file mode 100644 index 456e26d..0000000 --- a/fuel/build/DOC/INSTALL/README +++ /dev/null @@ -1,154 +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 README file describes how to install the OPNFV BGS Stack -============================================================= -1.1 Install Fuel Server ------------------------ -1. Mount the built .iso file (release/opnfv-.iso) as a bootdevice to the fuel server. - -2. Reboot the fuel server. - The system now boots from the ISO image. - -3. Change the grub boot params - When Press Tab to edit . is shown press Tab. - Change showmenu=no to showmenu=yes. - Change netmask=255.255.255.0 to netmask=255.255.0.0. - Press Enter. - -4 Wait until screen Fuel setup . is shown. - Note: This takes about 30 minutes. - -5. Select PXE Setup and change the following fields to appropriate values (example below): - Static Pool Start 10.20.0.3 - Static Pool End 10.20.0.254 - DHCP Pool Start 10.20.128.3 - DHCP Pool End 10.20.128.254 - -6. Select DNS & Hostname and change the following fields to appropriate values: - Hostname -fuel - Domain - Search Domain - Hostname to test DNS - -7. Select Time Sync and change the following fields to appropriate values: - NTP Server 1 - NTP Server 2 - NTP Server 3 - Note: This step is only to pass the network test, the actual ntp parameters will be set with the pre_deply script. - -8. Start the installation. - Select Quit Setup and press Save and Quit. - Installation starts, wait until a screen with logon credentials is shown. - Note: This takes about 15 minutes. - -10. Enable PXE Booting and put it first in the bios boot order menu. - -11. Reboot the controller- and compute blades. - -12. Connect to Fuel wit a browser towards port 8000 - -13. Create and name a new OpenStack environment, to be installed. - -14. Select Icehouse on Ubuntu . in field OpenStack Release. - -15. Select deployment mode. - Select the Multi-node with HA. - -16. Select compute node mode. - Select KVM as hypervisor. - -17. Select network mode. - Select Neutron with VLAN segmentation. - -18. Select Storage Backends. - Select Ceph for Cinder and default for glance. - - -19. Select additional services. - Check option Install Celiometer (OpenStack Telemetry). - -20. Create the new environment. - -21. Wait for availability nodes. - Wait until all nodes are displayed in top right in TOTAL NODES and UNALLOCATED NODES. - -22. Open the created environment. - -23. Open the networks tab. - -24. Update the public configuration. - Change the following fields to appropriate values: - IP Range Start to - IP Range End to - CIDR to - Gateway to - Check VLAN tagging. - Set appropriate VLAN id. - -25. Update the management configuration. - Set CIDR to 172.16.255.128/25. - Check VLAN tagging. - Set appropriate VLAN id. - -26. Update the storage configuration. - Set CIDR to the appropriate value - Check VLAN tagging. - Set appropriate VLAN id. - -27. Update the Neutron L2 configuration. - Set VLAN ID range. - -28. Update the Neutron L3 configuration. - Set Internal network CIDR to an appropriate value - Set Internal network gateway to an appropriate value - Set Floating IP ranges. - Set DNS Servers - -29. Save Settings. - -30. Click "verify network" to check the network set-up - -31. Update storage configuration. - -32. Open the nodes tab. - -33. Assign roles. - Check Controller and Telemetry . MongoDB. - Check three nodes to be installed as Controller in pane Assign Role. - Click Apply Changes. - Check Compute. - Check nodes to be installed as Compute nodes in pane Assign Role. - Click Apply Changes. - -34. Configure interfaces. - Check Select All to select all nodes with Control, Telemetry . MongoDB and Compute node roles. - Click Configure Interfaces. - Screen Configure interfaces on number of nodes is shown. - Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks - -35. Run the pre-deploy script. - Log on as root to the Fuel node. - Print Fuel environment Id (fuel env) - #> id | status | name | mode | release_id | changes | new | | ha_compact | 2 | - -36. Run the pre-deployment script (/opt/opnfv/pre-deploy.sh ) - As prompted for-, set the DNS servers to go into /etc/resolv.conf. - As prompted for-, set any Hosts file additions for controllers and compute nodes. You will be prompted for name, FQDN and IP for each entry. Press return when prompted for a name when you have completed your input. - As prompted for-, set NTP upstream configuration for controllers. You will be prompted for a NTP server each entry. Press return when prompted for a NTP server when you have completed your input. - -37. Deploy the environment. - In the Fuel GUI, click Deploy Changes. - -38 Verify the OpenStack Environment - Open the Health Check tab . - Select Select All. - Click Run tests. 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 , it's dependencies and required system resources. + +License +======= + (c) by + + 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 . + + +**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 +================ + + +: + +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 +=========== + + +: + +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: + +Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: +@gerrit.opnf.org/gerrit/genesis> +Check-out the Arno release: + +Goto the fuel directory and build the .iso + + +Familiarize yourself with the Fuel 6.0.1 version by reading the following documents: +- abc +- def +- 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 +========================= + + +: + +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 +==================================================== + + +: + +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 +============================================== + + +: + +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 +============================ + + +: + +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 +============================================ + + +: +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 +============= + + +: + +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 of . + +License +======= + (c) by + + 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 . + + +**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 +=================== + + + +: + +**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 +=========== + + + +: + +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 +================ + + +: + ++--------------------------------------+--------------------------------------+ +| **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 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +: + +- 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 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +: + +- 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 +~~~~~~~~~~~~~~~~~~~~~~~ + + +: + +**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 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + + +: + +4.3.2 Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + + +: + +5 Known Limitations, Issues and Workarounds +============================================ + +5.1 System Limitations +------------------------- + + +: + +**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 +------------------- + + +: + +**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 +------------------ + + + +: + +- 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 +============== + + +: + +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 +============= + + +: + +For more information on the OPNFV Arno release, please see: + +http://wiki.opnfv.org/release/arno diff --git a/fuel/docs/src/tmp/BUILD/README.architecture b/fuel/docs/src/tmp/BUILD/README.architecture new file mode 100644 index 0000000..4629763 --- /dev/null +++ b/fuel/docs/src/tmp/BUILD/README.architecture @@ -0,0 +1,10 @@ +############################################################################## +# 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 +############################################################################## + diff --git a/fuel/docs/src/tmp/BUILD/README.build b/fuel/docs/src/tmp/BUILD/README.build new file mode 100644 index 0000000..b8ce799 --- /dev/null +++ b/fuel/docs/src/tmp/BUILD/README.build @@ -0,0 +1,98 @@ +############################################################################## +# 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 +############################################################################## + +How to setup and use the OPNFV/BGS/FUEL build system +==================================================== + +1. Build system requirements +---------------------------- +1.1 Host HW/VM requirements +--------------------------- +- An x86_64 host (real iron or VM) with Ubuntu 14.04 LTS installed +- ~30 GB available disc +- 4 GB RAM + +1.2 Host SW dependencies +------------------------ +The host should run Ubuntu 14.04 +On the host, the following packages must be installed: +- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes +for Ubuntu 14.04. Note: only use the Ubuntu stock distro of Docker (docker.io) +- git (simply available through apt-get install git) +- make (simply available through apt-get install make) +- curl + +2 Setting up the Docker build container +---------------------------------------- +When having installed Docker, add yourself to the docker group: +usermod -a -G docker + +Also make sure to define rellevant dns servers part of the global dns chain in +in your /etc/default/docker config file, eg. +DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4" + +Then restart docker with "service docker.io restart".: + +3. Setting up OPNFV Gerrit in order to being able to clone the code +------------------------------------------------------------------- +- Start by creating a SSH key, if you don't already have one, create one with ssh-keygen + +- Add your generated public key in OPNFV Gerrit -https://gerrit.opnfv.org/ + (this requires a linuxfoundation account, create one if you do not already have one) + +- Select "SSH Public Keys" to the left and then "Add Key" and paste your public key in. + +4. Clone the OPNFV code git repository +-------------------------------------- + So now we're coming to the fun part! Let's clone the code repository: + git clone ssh://@gerrit.opnfv.org:29418/genesis + + Change the directory to "fuel-build" + cd fuel-build/ + +5. Set up (build) your build environment +---------------------------------------- +Select the versions of the components you want to build by editing the +fuel-build/config-spec file. Note if you want to build with OpenDaylight +SDN controller you need to uncomment the lines starting with odl-main and +java-main + +6. Build your fuel .iso image +----------------------------- +That's it, time to build! +make [all] + +This will: +- If not allready existing, initialize the docker build environment +- If not already done, build OpenDaylight from upstream (as defined by fuel-build/ + config-spec) +- If not already done, build fuel from upstream (as defined by fuel-build/config-spec) +- Build the defined additions to fuel (as defined by the structure of this framework) +- Apply changes and patches to fuel (as defined by the structure of this framework) +- Reconstruct a fuel .iso image + +If the build is successful, you will find the generated ISO file in the release +subdirectory! + +NOTE: the build of the baseline for Fuel and odl are cached, if build results reffering +to the same versions as specified in fuel-build/config spec has been built before, these +packages will not be rebuilt. The cache is cleared by "make clean" + +7. Install your stack +--------------------- +Please see DOC/INSTALL/README + +NOTES and TODO: +--------------- +The build system will for now partly run as sudo +BUT NOTE, NONE OF THE MAKEFILES OR SCRIPTS SHALL BE EXECUTED WITH +SUDO/ROOT PRIVILEDGES! +TODO: Change the scripts so that no root priviledges will be needed + diff --git a/fuel/docs/src/tmp/BUILD/README.examples b/fuel/docs/src/tmp/BUILD/README.examples new file mode 100644 index 0000000..4629763 --- /dev/null +++ b/fuel/docs/src/tmp/BUILD/README.examples @@ -0,0 +1,10 @@ +############################################################################## +# 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 +############################################################################## + diff --git a/fuel/docs/src/tmp/INSTALL/README b/fuel/docs/src/tmp/INSTALL/README new file mode 100644 index 0000000..456e26d --- /dev/null +++ b/fuel/docs/src/tmp/INSTALL/README @@ -0,0 +1,154 @@ +############################################################################## +# 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 README file describes how to install the OPNFV BGS Stack +============================================================= +1.1 Install Fuel Server +----------------------- +1. Mount the built .iso file (release/opnfv-.iso) as a bootdevice to the fuel server. + +2. Reboot the fuel server. + The system now boots from the ISO image. + +3. Change the grub boot params + When Press Tab to edit . is shown press Tab. + Change showmenu=no to showmenu=yes. + Change netmask=255.255.255.0 to netmask=255.255.0.0. + Press Enter. + +4 Wait until screen Fuel setup . is shown. + Note: This takes about 30 minutes. + +5. Select PXE Setup and change the following fields to appropriate values (example below): + Static Pool Start 10.20.0.3 + Static Pool End 10.20.0.254 + DHCP Pool Start 10.20.128.3 + DHCP Pool End 10.20.128.254 + +6. Select DNS & Hostname and change the following fields to appropriate values: + Hostname -fuel + Domain + Search Domain + Hostname to test DNS + +7. Select Time Sync and change the following fields to appropriate values: + NTP Server 1 + NTP Server 2 + NTP Server 3 + Note: This step is only to pass the network test, the actual ntp parameters will be set with the pre_deply script. + +8. Start the installation. + Select Quit Setup and press Save and Quit. + Installation starts, wait until a screen with logon credentials is shown. + Note: This takes about 15 minutes. + +10. Enable PXE Booting and put it first in the bios boot order menu. + +11. Reboot the controller- and compute blades. + +12. Connect to Fuel wit a browser towards port 8000 + +13. Create and name a new OpenStack environment, to be installed. + +14. Select Icehouse on Ubuntu . in field OpenStack Release. + +15. Select deployment mode. + Select the Multi-node with HA. + +16. Select compute node mode. + Select KVM as hypervisor. + +17. Select network mode. + Select Neutron with VLAN segmentation. + +18. Select Storage Backends. + Select Ceph for Cinder and default for glance. + + +19. Select additional services. + Check option Install Celiometer (OpenStack Telemetry). + +20. Create the new environment. + +21. Wait for availability nodes. + Wait until all nodes are displayed in top right in TOTAL NODES and UNALLOCATED NODES. + +22. Open the created environment. + +23. Open the networks tab. + +24. Update the public configuration. + Change the following fields to appropriate values: + IP Range Start to + IP Range End to + CIDR to + Gateway to + Check VLAN tagging. + Set appropriate VLAN id. + +25. Update the management configuration. + Set CIDR to 172.16.255.128/25. + Check VLAN tagging. + Set appropriate VLAN id. + +26. Update the storage configuration. + Set CIDR to the appropriate value + Check VLAN tagging. + Set appropriate VLAN id. + +27. Update the Neutron L2 configuration. + Set VLAN ID range. + +28. Update the Neutron L3 configuration. + Set Internal network CIDR to an appropriate value + Set Internal network gateway to an appropriate value + Set Floating IP ranges. + Set DNS Servers + +29. Save Settings. + +30. Click "verify network" to check the network set-up + +31. Update storage configuration. + +32. Open the nodes tab. + +33. Assign roles. + Check Controller and Telemetry . MongoDB. + Check three nodes to be installed as Controller in pane Assign Role. + Click Apply Changes. + Check Compute. + Check nodes to be installed as Compute nodes in pane Assign Role. + Click Apply Changes. + +34. Configure interfaces. + Check Select All to select all nodes with Control, Telemetry . MongoDB and Compute node roles. + Click Configure Interfaces. + Screen Configure interfaces on number of nodes is shown. + Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks + +35. Run the pre-deploy script. + Log on as root to the Fuel node. + Print Fuel environment Id (fuel env) + #> id | status | name | mode | release_id | changes | new | | ha_compact | 2 | + +36. Run the pre-deployment script (/opt/opnfv/pre-deploy.sh ) + As prompted for-, set the DNS servers to go into /etc/resolv.conf. + As prompted for-, set any Hosts file additions for controllers and compute nodes. You will be prompted for name, FQDN and IP for each entry. Press return when prompted for a name when you have completed your input. + As prompted for-, set NTP upstream configuration for controllers. You will be prompted for a NTP server each entry. Press return when prompted for a NTP server when you have completed your input. + +37. Deploy the environment. + In the Fuel GUI, click Deploy Changes. + +38 Verify the OpenStack Environment + Open the Health Check tab . + Select Select All. + Click Run tests. -- cgit 1.2.3-korg