From d6c8a86713224b25a723aa97f2ed158825a4f68d Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Wed, 16 Dec 2015 15:34:35 +0100 Subject: Updated Installation Instruction for FUEL B-REL WP1 (FUEL 7.0 rebasing) Updates include: - MTU Fix (JIRA FUEL-84) - Updates for FUEL config (admin pwd, HTTP proxy option) - Updates for FUEL 7.0 UI Elements - Tagged areas for updated when ODL is available in next WP - Corrected typo - Changed name installation-intruction - Changed name build-instruction JIRA: FUEL-84 replacing change: https://gerrit.opnfv.org/gerrit/#/c/3449/ Change-Id: Ib855c67e7fbe93781a4252f43f2911d9c5fa0645 Signed-off-by: Sofia Wallin --- docs/installation-instruction.rst | 636 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 636 insertions(+) create mode 100644 docs/installation-instruction.rst (limited to 'docs/installation-instruction.rst') diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst new file mode 100644 index 000000000..5c4438991 --- /dev/null +++ b/docs/installation-instruction.rst @@ -0,0 +1,636 @@ +============================================================================================================= +OPNFV Installation instruction for the Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool +============================================================================================================= + +.. contents:: Table of Contents + :backlinks: none + +Abstract +======== +This document describes how to install the Brahmaputra WP1 release of +OPNFV when using Fuel as a deployment tool covering it's limitations, +dependencies and required system resources. + +License +======= +Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool +Docs (c) by Jonas Bjurel (Ericsson AB) + +Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool +Docs are licensed under a Creative Commons Attribution 4.0 +International License. You should have received a copy of the license +along with this. If not, see +. + +Version history +=============== ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2015-06-03 | 1.0.0 | Jonas Bjurel | Installation | +| | | (Ericsson AB) | instruction for | +| | | | the Arno release | +| | | | | +| 2015-09-27 | 1.1.0 | Daniel Smith | ARNO SR1-RC1 | +| | | (Ericsson AB) | update | +| | | | | +| | | | | +| 2015-11-19 | 2.0.0 | Daniel Smith | B-Rel WP1 update | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +Introduction +============ + +This document describes providing guidelines on how to install and +configure the Brahmaputra WP1 release of OPNFV when using Fuel as a +deployment tool including required software and hardware +configurations. + +Although the available installation options gives a high degree of +freedom in how the system is set-up including architecture, services +and features, etc. said permutations may not provide an OPNFV +compliant reference architecture. This instruction provides a +step-by-step guide that results in an OPNFV Brahmaputra WP1 compliant +deployment. + +The audience of this document is assumed to have good knowledge in +networking and Unix/Linux administration. + +Preface +======= +Before starting the installation of the Brahmaputra WP1 release of +OPNFV when using Fuel as a deployment tool, some planning must be +done. + +Retrieving the ISO image +------------------------ + +First of all, the Fuel deployment ISO image needs to be retrieved, the +.iso image of the Brahmaputra WP1 release of OPNFV when using Fuel as +a deployment tool can be found at +http://artifacts.opnfv.org/fuel/opnfv-2015-11-19_03-04-21.iso NOTE: +TO BE UPDATED WITH FINAL B-REL ARTIFACT + + +Building the ISO image +---------------------- + + +Alternatively, you may build the .iso from source by cloning the +opnfv/genesis git repository. To retrieve the repository for the Arno +release use the following command: + +- git clone https://@gerrit.opnf.org/gerrit/fuel + +Check-out the Brahmaputra WP1 release tag to set the branch to the +baseline required to replicate the Brahmaputra WP1 release: + +- TODO: NEEDS UPDATE TO REFLECT WP1 TAG / NEW REPO - cd genesis; git + checkout stable/arno2015.2.0 + +Go to the fuel directory and build the .iso: + +- cd fuel/build; make all + +For more information on how to build, please see "OPNFV Build +instructions for - Brahmaputra WP1 release of OPNFV when using Fuel as +a deployment tool which you retrieved with the repository at + + +Next, familiarize yourself with the Fuel 7.0 version by reading the +following documents: + +- Fuel planning guide + + +- Fuel user guide + + +- Fuel operations guide + + +- Fuel Plugin Developers Guide + +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 + +5. Network Topology you plan to Deploy (VLAN, GRE(VXLAN), FLAT) + +6. Linux Distro you intend to deploy. + +7. How many nodes and what roles you want to deploy (Controllers, +Storage, Computes) + +8. Monitoring Options you want to deploy (Ceilometer, MongoDB). + +9. Other options not covered in the document are available in the +links above + + +This information will be needed for the configuration procedures +provided in this document. + +Hardware requirements +===================== + +The following minimum hardware requirements must be met for the +installation of Brahmaputra WP1 using Fuel: + ++--------------------+------------------------------------------------------+ +| **HW Aspect** | **Requirement** | +| | | ++--------------------+------------------------------------------------------+ +| **# of nodes** | Minimum 6 (3 for non redundant deployment): | +| | | +| | - 1 Fuel deployment master (may be virtualized) | +| | | +| | - 3(1) Controllers | +| | | +| | - 1 Compute | +| | | +| | - 1 Ceilometer (VM option) | ++--------------------+------------------------------------------------------+ +| **CPU** | Minimum 1 socket x86_AMD64 with Virtualization | +| | support | ++--------------------+------------------------------------------------------+ +| **RAM** | Minimum 16GB/server (Depending on VNF work load) | +| | | ++--------------------+------------------------------------------------------+ +| **Disk** | Minimum 256GB 10kRPM spinning disks | +| | | ++--------------------+------------------------------------------------------+ +| **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) | +| | | +| | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network | +| | | +| | note: These can be run on single NIC - or spread out | +| | over other nics as your hardware supports | ++--------------------+------------------------------------------------------+ + +Help with Hardware Requirements +=============================== + + +Calculate hardware requirements: + +Refer to the OpenStack Hardware Compability List + +for more information on various hardware types available for use. + +When choosing the hardware on which you will deploy your OpenStack +environment, you should think about: + + - CPU -- Consider the number of virtual machines that you plan + to deploy in your cloud environment and the CPU per virtual + machine. + - Memory -- Depends on the amount of RAM assigned per virtual + machine and the controller node. + - Storage -- Depends on the local drive space per virtual + machine, remote volumes that can be attached to a virtual + machine, and object storage. + - Networking -- Depends on the Choose Network Topology, the + network bandwidth per virtual machine, and network storage. + + +Top of the rack (TOR) Configuration requirements +================================================ + +The switching infrastructure provides connectivity for the OPNFV +infrastructure operations, tenant networks (East/West) and provider +connectivity (North/South bound connectivity); it also provides needed +connectivity for the storage Area Network (SAN). To avoid traffic +congestion, it is strongly suggested that three physically separated +networks are used, that is: 1 physical network for administration and +control, one physical network for tenant private and public networks, +and one physical network for SAN. The switching connectivity can (but +does not need to) be fully redundant, in such case it and comprises a +redundant 10GE switch pair for each of the three physically separated +networks. + +The physical TOR switches are **not** automatically configured from +the OPNFV reference platform. All the networks involved in the OPNFV +infrastructure as well as the provider networks and the private tenant +VLANs needs to be manually configured. + +Manual configuration of the Brahmaputra WP1 hardware platform should +be carried out according to the Pharos specification TODO- + +OPNFV Software installation and deployment +========================================== + +This section describes the installation of the OPNFV installation +server (Fuel master) as well as the deployment of the full OPNFV +reference platform stack across a server cluster. + +Install Fuel master +------------------- +1. Mount the Brahmaputra WP1 ISO file as a boot device to the jump host server. + +2. Reboot the jump host to establish the Fuel server. + + - The system now boots from the ISO image. + + - Select 'DVD Fuel Install (Static IP)' + + - Press [Enter]. + +3. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes). + +4. In the 'Fuel User' Section - Confirm/change the default password + - Enter 'admin' in the Fuel password input + + - Enter 'admin' in the Confim password input + + - Select 'Check' and press [Enter] + +5. In 'Network Setup' Section - Configure DHCP/Static IP information +for your FUEL node - For example, ETH0 is 10.20.0.2/24 for FUEL +booting and ETH1 is DHCP in your corporate/lab network. + + - Configure eth1 or other network interfaces here as well (if you + have them present on your FUEL server). + +6. In 'PXE Setup' Section - Change the following fields to appropriate +values (example below): + + - DHCP Pool Start 10.20.0.3 + + - DHCP Pool End 10.20.0.254 + + - DHCP Pool Gateway 10.20.0.2 (ip of Fuel node) + +7. In 'DNS & Hostname' - Change the following fields to appropriate values: + + - Hostname -fuel + + - Domain + + - Search Domain + + - External DNS + + - Hostname to test DNS + + - Select 'Check' and press [Enter] + + +8. OPTION TO ENABLE PROXY SUPPORT - In 'Bootstrap Image', edit the +following fields to define a proxy. + + NOTE: cannot be used in tandem with local repo support + NOTE: not tested with ODL for support (plugin) + + - Navigate to 'HTTP proxy' and input your http proxy address + + - Select 'Check' and press [Enter] + + +9. In 'Time Sync' Section - Change the following fields to appropriate values: + + - NTP Server 1 + + - NTP Server 2 + + - NTP Server 3 + +10. Start the installation. + + - Select Quit Setup and press Save and Quit. + + - Installation starts, wait until a screen with logon credentials is shown. + + +Boot the Node Servers +--------------------- + +After the Fuel Master node has rebooted from the above step and is at +the login prompt, you should boot the Node Servers (Your +Compute/Control/Storage blades (nested or real)) with a PXE Booting +Scheme so that the FUEL +Master can pick them up for control. + +11. Enable PXE booting + + - For every controller and compute server: enable PXE Booting as + the first boot device in the BIOS boot order menu and hard disk + as the second boot device in the same menu. + +12. Reboot all the control and compute blades. + +13. Wait for the availability of nodes showing up in the Fuel GUI. + + - Connect to the FUEL UI via the URL provided in the Console + (default: http://10.20.0.2:8000) + + - Wait until all nodes are displayed in top right corner of the + Fuel GUI: TOTAL NODES and UNALLOCATED NODES. + + + +Install ODL Plugin on FUEL node +------------------------------- + +NOTE: CURRENTLY DISABLED IN B-REL WP1 + +14. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme) + +15. Verify the plugin exists at /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm + +16. Install the plugin with the command + + - "fuel plugins --install /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm" + + - Expected output: "Plugin opendaylight-0.6-0.6.1-1.noarch.rpm was + successfully installed." + + +Create an OPNFV Environment +--------------------------- + +17. Connect to Fuel WEB UI with a browser towards port http://:8000 (login admin/admin) + +18. Create and name a new OpenStack environment, to be installed. + +19. Select and press "Next" + +20. Select compute virtulization method. + + - Select KVM as hypervisor (or one of your choosing) and press "Next" + +18. Select network mode. + + - Select Neutron with GRE segmentation and press "Next" + + Note: Required if using the ODL plugin + +19. Select Storage Back-ends. + + - Select "Yes, use Ceph" if you intend to deploy Ceph Backends and + press "Next" + +20. Select additional services you wish to install. + + - Check option and press "Next" + Note: If you use Ceilometer and you only have 5 nodes, you may + have to run in a 3/1/1 (controller/ceilo-mongo/compute) + configuration. Suggest adding more compute nodes + +21. Create the new environment. + + - Click "Create" Button + +Configure the OPNFV environment +------------------------------- + +22. Enable PXE booting (if you haven't done this already) + + - For every controller and compute server: enable PXE Booting as + the first boot device in the BIOS boot order menu and hard disk + as the second boot device in the same menu. + +23. Wait for the availability of nodes showing up in the Fuel GUI. + + - Wait until all nodes are displayed in top right corner of the + Fuel GUI: TOTAL NODES and UNALLOCATED NODES. + +24. Open the environment you previously created. + +25. Open the networks tab. + +26. Update the Public network configuration. + + Change the following fields to appropriate values: + + - IP Range Start to + + - IP Range End to + + - CIDR to + + - Check VLAN tagging. + + - Set appropriate VLAN id. + + - Gateway to + + - Set floating ip ranges + + +27. Update the Storage Network Configuration + + - Set CIDR to appropriate value (default 192.168.1.0/24) + + - Set vlan to appropriate value (default 102) + +28. Update the Management network configuration. + + - Set CIDR to appropriate value (default 192.168.0.0/24) + + - Check VLAN tagging. + + - Set appropriate VLAN id. (default 101) + +29. Update the Private Network Information + + - Set CIDR to appropriate value (default 192.168.2.0/24 + + - Check and set VLAN tag appropriately (default 103) + +30. Update the Neutron L3 configuration. + + - Set Internal network CIDR to an appropriate value + + - Set Internal network gateway to an appropriate value + + - Set Guest OS DNS Server values appropriately + +31. Save Settings. + +32. Click on the "Nodes" Tab in the FUEL WEB UI. + +33. Assign roles. + + - Click on "+Add Nodes" button + + - Check "Controller" and the "Storage-Ceph OSD" in the Assign Roles Section + + - Check the 3 Nodes you want to act as Controllers from the bottom half of the screen + + - Click . + + - Click on "+Add Nodes" button + + - Check "Compute" in the Assign Roles Section + + - Check the Nodes that you want to act as Computes from the bottom half of the screen + + - Click . + + +34. Configure interfaces. + + - Check Select to select all nodes with Control, Telemetry, + MongoDB and Compute node roles. + + - Click + + - Screen Configure interfaces on number of nodes is shown. + + - Assign interfaces (bonded) for mgmt-, admin-, private-, public- + and storage networks + + Note: Set MTU level to at least MTU=1458 (recommended + MTU=1450 for SDN over VXLAN Usage) for each network if you + using ODL plugin + + - Click Apply + +Enable ODL +---------- + +TODO: NOT UPDATED YET FOR WP1 - NOT AVAILABLE AT TIME OF EDIT + +35. In the FUEL UI of your Enviornment, click the "Settings" Tab + + - Enable OpenStack debug logging (in the Common Section) - optional + + - Check the OpenDaylight Lithium Plugin Section + + - Check to enable VXLAN + + - Modify VNI and Port Range if desired + + - Click "Save Settings" at the bottom to Save. + + +OPTIONAL - Set Local Mirror Repos +--------------------------------- + +The following steps can be executed if you are in an environment with +no connection to the internet. The Fuel server delivers a local repo +that can be used for installation / deployment of openstack. + +36. In the Fuel UI of your Environment, click the Settings Tab and +scroll to the Repositories Section. + + - Replace the URI values for the "Name" values outlined below: + + - "ubuntu" URI="deb http://:8080/ubuntu-part trusty main" + - "ubuntu-security" URI="deb + http://:8080/ubuntu-part trusty main" + - "ubuntu-updates" URI="deb + http://:8080/ubuntu-part trusty main" + - "mos-updates" URI="deb + http://:8080/mos-ubuntu mos6.1-updates main + restricted" + - "mos-security" URI="deb + http://:8080/mos-ubuntu mos6.1-security main + restricted" + - "mos-holdback" URI="deb + http://:8080/mos-ubuntu mos6.1-holdback main + restricted" + + - Click "Save Settings" at the bottom to Save your changes + +Verify Networks +--------------- + +Its is important that Verify Networks be done as it will ensure that +you can not only communicate on the networks you have setup, but can +fetch the packages needed for a succesful deployment. + +37. From the FUEL UI in your Environment, Select the Networks Tab + + - At the bottom of the page, Select "Verify Networks" + + - Continue to fix your topology (physical switch, etc) until the + "Verification Succeeded - Your network is configured correctly" + message is shown + +Deploy Your Environment +----------------------- + +38. Deploy the environment. + + In the Fuel GUI, click on the Dashboard Tab. + + - Click on 'Deploy Changes' in the 'Ready to Deploy?' Section + + - Examine any information notice that pops up and click 'Deploy' + + Wait for your deployment to complete, you can view the 'Dashboard' + Tag to see the progress and status of your deployment. + +Installation health-check +========================= + +39. Perform system health-check + + - Click the "Health Check" tab inside your Environment in the FUEL Web UI + + - Check "Select All" and Click "Run Tests" + + Note: Live-Migraition test will fail (Bug in ODL currently), + you can skip this test in the list if you choose to not see + the error message, simply uncheck it in the list + + - Allow tests to run and investigate results where appropriate + +40. Verify that the OpenDaylight GUI is accessible + +TODO: Not available for WP1 Update at time of writing + +Point your browser to the following URL: +http://{Controller-VIP}:8181/index.html> and login: + + - Username: admin + - Password: admin + +References +========== + +OPNFV +----- + +`OPNFV Home Page `_ + +`OPNFV Genesis project page `_ + +OpenStack +--------- + +`OpenStack Kilo Release artifacts `_ + +`OpenStack documentation `_ + +OpenDaylight +------------ + +`OpenDaylight artifacts `_ + +Fuel +---- + +`Fuel documentation `_ + +:Authors: Daniel Smith (Ericsson AB) +:Version: 2.0.0 + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date -- cgit 1.2.3-korg