aboutsummaryrefslogtreecommitdiffstats
path: root/docs/installation-instruction.rst
diff options
context:
space:
mode:
authorJonas Bjurel <jonas.bjurel@ericsson.com>2016-01-13 20:22:14 +0100
committerJonas Bjurel <jonas.bjurel@ericsson.com>2016-02-10 20:49:07 +0100
commitef0b33dcc34ee38d090487eabba122ae018980a0 (patch)
treea57ea12ec9274b7a0996e0eba6f202f55dadd500 /docs/installation-instruction.rst
parent28abcb7287d3170e007e938872116161c927c38a (diff)
Documentation according to new template provided by the Docs team
- The Config guide is not an atonomos document, but will be scraped into a bigger context. - The post install guide is not an atonomos document, but will be scraped into a bigger context. - Installation instructions is an atonomos document describing details on how to install Fuel@OPNFV - Build instructions is an atonomos document describing how to build Fuel@OPNFV - Release notes - Agreed with the community that binary image files shall be in the repo, as much as I hate it. DO NOT MERGE JIRA: FUEL-38 Change-Id: I88a93e20ef2c67a2c973147a7a1e332e3da55674 Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>
Diffstat (limited to 'docs/installation-instruction.rst')
-rw-r--r--docs/installation-instruction.rst591
1 files changed, 284 insertions, 307 deletions
diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst
index 5c4438991..eb02d7860 100644
--- a/docs/installation-instruction.rst
+++ b/docs/installation-instruction.rst
@@ -1,58 +1,38 @@
-=============================================================================================================
-OPNFV Installation instruction for the Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool
-=============================================================================================================
+========================================================================================================
+OPNFV Installation instruction for the Brahmaputra 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.
+This document describes how to install the Brahmaputra release of
+OPNFV when using Fuel as a deployment tool, covering it's usage,
+limitations, dependencies and required system resources.
License
=======
-Brahmaputra WP1 release of OPNFV when using Fuel as a deployment tool
+Brahmaputra 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
+This document is licensed under a Creative Commons Attribution 4.0
International License. You should have received a copy of the license
-along with this. If not, see
+along with this document. If not, see
<http://creativecommons.org/licenses/by/4.0/>.
-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.
+This document provides guidelines on how to install and
+configure the Brahmaputra 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
+Although the available installation options give 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
+step-by-step guide that results in an OPNFV Brahmaputra compliant
deployment.
The audience of this document is assumed to have good knowledge in
@@ -60,80 +40,66 @@ 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
+Before starting the installation of the Brahmaputra release of
+OPNFV, 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
-
+Fuel .iso image of the Brahmaputra release can be found at <TODO>
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
+Alternatively, you may build the Fuel .iso from source by cloning the
+opnfv/fuel git repository. To retrieve the repository for the Brahmaputra
release use the following command:
-- git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/fuel
+$git clone https://<linux foundation uid>@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:
+Check-out the Brahmaputra release tag to set the branch to the
+baseline required to replicate the Brahmaputra release:
-- TODO: NEEDS UPDATE TO REFLECT WP1 TAG / NEW REPO - cd genesis; git
- checkout stable/arno2015.2.0
+$ git checkout stable/<TODO>
Go to the fuel directory and build the .iso:
-- cd fuel/build; make all
+$ 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
+instructions for - Brahmaputra release of OPNFV when using Fuel as
a deployment tool which you retrieved with the repository at
-</fuel/fuel/docs/src/build-instructions.rst>
+</fuel/fuel/docs/src/build-instructions.rst> <TODO>
-Next, familiarize yourself with the Fuel 7.0 version by reading the
-following documents:
+Next, familiarize yourself with Fuel by reading the following documents:
-- Fuel planning guide
- <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>
+- Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>
-- Fuel user guide
- <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>
+- Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>
-- Fuel operations guide
- <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>
+- Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>
- Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>
-A number of deployment specific parameters must be collected, those are:
+Prior to installation, a number of deployment specific parameters must be collected, those are:
-1. Provider sub-net and gateway information
+#. Provider sub-net and gateway information
-2. Provider VLAN information
+#. Provider VLAN information
-3. Provider DNS addresses
+#. Provider DNS addresses
-4. Provider NTP addresses
+#. Provider NTP addresses
-5. Network Topology you plan to Deploy (VLAN, GRE(VXLAN), FLAT)
+#. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
-6. Linux Distro you intend to deploy.
+#. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
-7. How many nodes and what roles you want to deploy (Controllers,
-Storage, Computes)
+#. Monitoring options you want to deploy (Ceilometer, Syslog, erc.).
-8. Monitoring Options you want to deploy (Ceilometer, MongoDB).
-
-9. Other options not covered in the document are available in the
-links above
+#. Other options not covered in the document are available in the links above
This information will be needed for the configuration procedures
@@ -143,24 +109,24 @@ Hardware requirements
=====================
The following minimum hardware requirements must be met for the
-installation of Brahmaputra WP1 using Fuel:
+installation of Brahmaputra using Fuel:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
+--------------------+------------------------------------------------------+
-| **# of nodes** | Minimum 6 (3 for non redundant deployment): |
+| **# of nodes** | Minimum 5 (3 for non redundant deployment): |
| | |
| | - 1 Fuel deployment master (may be virtualized) |
| | |
-| | - 3(1) Controllers |
+| | - 3(1) Controllers (1 colocated mongo/ceilometer |
+| | role, 2 Ceph-OSD roles) |
| | |
-| | - 1 Compute |
+| | - 1 Compute (1 co-located Ceph-OSD role) |
| | |
-| | - 1 Ceilometer (VM option) |
+--------------------+------------------------------------------------------+
| **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
-| | support |
+| | support |
+--------------------+------------------------------------------------------+
| **RAM** | Minimum 16GB/server (Depending on VNF work load) |
| | |
@@ -172,33 +138,30 @@ installation of Brahmaputra WP1 using Fuel:
| | |
| | 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 |
+| | Note: These can be allocated to a single NIC - |
+| | or spread out over multiple NICs as your hardware |
+| | supports. |
+--------------------+------------------------------------------------------+
Help with Hardware Requirements
===============================
-
Calculate hardware requirements:
-Refer to the OpenStack Hardware Compability List
+Refer to the OpenStack Hardware Compatibility List:
<https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-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.
+- 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
@@ -206,24 +169,24 @@ 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.
+connectivity (North/South); 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 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
+the Fuel 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-<insert link
-to Pharos ARNO SR1 Specification>
+Manual configuration of the Brahmaputra hardware platform should
+be carried out according to the OPNFV Pharos specification:
+<https://wiki.opnfv.org/pharos/pharos_specification>
OPNFV Software installation and deployment
==========================================
@@ -234,68 +197,72 @@ 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.
+#. Mount the Brahmaputra Fuel ISO file/media as a boot device to the jump host server.
-2. Reboot the jump host to establish the Fuel server.
+#. Reboot the jump host to establish the Fuel server.
- The system now boots from the ISO image.
- - Select 'DVD Fuel Install (Static IP)'
+ - Select "Fuel Install (Static IP)" (See figure below)
- Press [Enter].
-3. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
+ .. figure:: img/grub-1.png
+
+#. 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
+#. In the "Fuel User" section - Confirm/change the default password (See figure below)
- - Enter 'admin' in the Confim password input
+ - Enter "admin" in the Fuel password input
- - Select 'Check' and press [Enter]
+ - Enter "admin" in the Confirm password input
-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.
+ - Select "Check" and press [Enter]
- - Configure eth1 or other network interfaces here as well (if you
- have them present on your FUEL server).
+ .. figure:: img/fuelmenu1.png
-6. In 'PXE Setup' Section - Change the following fields to appropriate
-values (example below):
+#. In the "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 (see figure below).
+
+ - Configure eth1 or other network interfaces here as well (if you have them present on your FUEL server).
+
+ .. figure:: img/fuelmenu2.png
+
+#. In the "PXE Setup" section (see figure below) - 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)
+ - DHCP Pool Gateway 10.20.0.2 (IP address of Fuel node)
+
+ .. figure:: img/fuelmenu3.png
-7. In 'DNS & Hostname' - Change the following fields to appropriate values:
+#. In the "DNS & Hostname" section (see figure below) - Change the following fields to appropriate values:
- - Hostname <OPNFV Region name>-fuel
+ - Hostname
- - Domain <Domain Name>
+ - Domain
- - Search Domain <Search Domain Name>
+ - Search Domain
- External DNS
- - Hostname to test DNS <Hostname to test DNS>
+ - Hostname to test DNS
- - Select 'Check' and press [Enter]
+ - Select <Check> and press [Enter]
+ .. figure:: img/fuelmenu4.png
-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)
+#. OPTION TO ENABLE PROXY SUPPORT - In the "Bootstrap Image" section (see figure below), edit the following fields to define a proxy. (**NOTE:** cannot be used in tandem with local repository support)
- - Navigate to 'HTTP proxy' and input your http proxy address
+ - Navigate to "HTTP proxy" and enter your http proxy address
- - Select 'Check' and press [Enter]
+ - Select <Check> and press [Enter]
+ .. figure:: img/fuelmenu5.png
-9. In 'Time Sync' Section - Change the following fields to appropriate values:
+#. In the "Time Sync" section (see figure below) - Change the following fields to appropriate values:
- NTP Server 1 <Customer NTP server 1>
@@ -303,301 +270,322 @@ following fields to define a proxy.
- NTP Server 3 <Customer NTP server 3>
-10. Start the installation.
+ .. figure:: img/fuelmenu6.png
+
+#. Start the installation.
- Select Quit Setup and press Save and Quit.
- - Installation starts, wait until a screen with logon credentials is shown.
+ - Installation starts, wait until the login screen is shown.
Boot the Node Servers
---------------------
-After the Fuel Master node has rebooted from the above step and is at
+After the Fuel Master node has rebooted from the above steps 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.
+Compute/Control/Storage blades (nested or real) with a PXE booting
+scheme so that the FUEL Master can pick them up for control.
+
+#. 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.
+
+#. Reboot all the control and compute blades.
-11. Enable PXE booting
+#. Wait for the availability of nodes showing up in the Fuel GUI.
- - 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.
+ - Connect to the FUEL UI via the URL provided in the Console (default: https://10.20.0.2:8443)
-12. Reboot all the control and compute blades.
+ - Wait until all nodes are displayed in top right corner of the Fuel GUI: Total nodes and Unallocated nodes (see figure below).
-13. Wait for the availability of nodes showing up in the Fuel GUI.
+ .. figure:: img/nodes.png
- - 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 number of server> TOTAL NODES and <total number
- of servers> UNALLOCATED NODES.
+Install additional Plugins/Features on the FUEL node
+----------------------------------------------------
+#. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
+#. Select wanted plugins/features from the /opt/opnfv/ directory.
-Install ODL Plugin on FUEL node
+#. Install the wanted plugin with the command "fuel plugins --install /opt/opnfv/<plugin-name>-<version>.<arch>.rpm"
+ Expected output: "Plugin ....... was successfully installed." (see figure below)
+
+ .. figure:: img/plugin_install.png
+
+Create an OpenStack Environment
-------------------------------
-NOTE: CURRENTLY DISABLED IN B-REL WP1
+#. Connect to Fuel WEB UI with a browser (default: https://10.20.0.2:8443) (login admin/admin)
-14. SSH to your FUEL node (e.g. root@10.20.0.2 pwd: r00tme)
+#. Create and name a new OpenStack environment, to be installed.
-15. Verify the plugin exists at /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm
+ .. figure:: img/newenv.png
-16. Install the plugin with the command
+#. Select "<Liberty on Ubuntu 14.04>" and press <Next>
- - "fuel plugins --install /opt/opnfv/opendaylight-0.6-0.6.1-1.noarch.rpm"
+#. Select "compute virtulization method".
- - Expected output: "Plugin opendaylight-0.6-0.6.1-1.noarch.rpm was
- successfully installed."
+ - Select "QEMU-KVM as hypervisor" and press <Next>
+#. Select "network mode".
-Create an OPNFV Environment
----------------------------
+ - Select "Neutron with ML2 plugin"
-17. Connect to Fuel WEB UI with a browser towards port http://<ip of
-fuel server>:8000 (login admin/admin)
+ - Select "Neutron with tunneling segmentation" (Required when using the ODL or ONOS plugins)
-18. Create and name a new OpenStack environment, to be installed.
+ - Press <Next>
-19. Select <Kilo on Ubuntu 14.04> and press "Next"
+#. Select "Storage Back-ends".
-20. Select compute virtulization method.
+ - Select "Ceph for block storage" and press <Next>
- - Select KVM as hypervisor (or one of your choosing) and press "Next"
+#. Select "additional services" you wish to install.
-18. Select network mode.
+ - Check option "Install Celiometer (OpenStack Telemetry)" and press <Next>
- - Select Neutron with GRE segmentation and press "Next"
+#. Create the new environment.
- Note: Required if using the ODL plugin
+ - Click <Create> Button
-19. Select Storage Back-ends.
+Configure the network environment
+---------------------------------
- - Select "Yes, use Ceph" if you intend to deploy Ceph Backends and
- press "Next"
+#. Open the environment you previously created.
-20. Select additional services you wish to install.
+#. Open the networks tab and select the "default Node Networks group to" on the left pane (see figure below).
- - Check option <Install Celiometer (OpenStack Telemetry)> 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
+ .. figure:: img/network.png
-21. Create the new environment.
+#. Update the Public network configuration and change the following fields to appropriate values:
- - Click "Create" Button
+ - CIDR to <CIDR for Public IP Addresses>
-Configure the OPNFV environment
--------------------------------
+ - IP Range Start to <Public IP Address start>
-22. Enable PXE booting (if you haven't done this already)
+ - IP Range End to <Public IP Address end>
- - 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.
+ - Gateway to <Gateway for Public IP Addresses>
-23. Wait for the availability of nodes showing up in the Fuel GUI.
+ - Check <VLAN tagging>.
- - Wait until all nodes are displayed in top right corner of the
- Fuel GUI: <total number of server> TOTAL NODES and <total number
- of servers> UNALLOCATED NODES.
+ - Set appropriate VLAN id.
-24. Open the environment you previously created.
+#. Update the Storage Network Configuration
-25. Open the networks tab.
+ - Set CIDR to appropriate value (default 192.168.1.0/24)
-26. Update the Public network configuration.
+ - Set IP Range Start to appropriate value (default 192.168.1.1)
- Change the following fields to appropriate values:
+ - Set IP Range End to appropriate value (default 192.168.1.254)
- - IP Range Start to <Public IP Address start>
+ - Set vlan to appropriate value (default 102)
- - IP Range End to <Public IP Address end>
+#. Update the Management network configuration.
- - CIDR to <CIDR for Public IP Addresses>
+ - Set CIDR to appropriate value (default 192.168.0.0/24)
- - Check VLAN tagging.
+ - Set IP Range Start to appropriate value (default 192.168.0.1)
- - Set appropriate VLAN id.
+ - Set IP Range End to appropriate value (default 192.168.0.254)
- - Gateway to <Gateway for Public IP Addresses>
+ - Check <VLAN tagging>.
- - Set floating ip ranges
+ - Set appropriate VLAN id. (default 101)
+#. Update the Private Network Information
-27. Update the Storage Network Configuration
+ - Set CIDR to appropriate value (default 192.168.2.0/24
- - Set CIDR to appropriate value (default 192.168.1.0/24)
+ - Set IP Range Start to appropriate value (default 192.168.2.1)
- - Set vlan to appropriate value (default 102)
+ - Set IP Range End to appropriate value (default 192.168.2.254)
-28. Update the Management network configuration.
+ - Check <VLAN tagging>.
- - Set CIDR to appropriate value (default 192.168.0.0/24)
+ - Set appropriate VLAN tag (default 103)
- - Check VLAN tagging.
+#. Select the "Neutron L3 Node Networks group" on the left pane.
- - Set appropriate VLAN id. (default 101)
+ .. figure:: img/neutronl3.png
-29. Update the Private Network Information
+#. Update the Floating Network configuration.
- - Set CIDR to appropriate value (default 192.168.2.0/24
+ - Set the Floating IP range start (default 172.16.0.130)
- - Check and set VLAN tag appropriately (default 103)
+ - Set the Floating IP range end (default 172.16.0.254)
-30. Update the Neutron L3 configuration.
+ - Set the Floating network name (default admin_floating_net)
- - Set Internal network CIDR to an appropriate value
+#. Update the Internal Network configuration.
- - Set Internal network gateway to an appropriate value
+ - Set Internal network CIDR to an appropriate value (default 192.168.111.0/24)
- - Set Guest OS DNS Server values appropriately
+ - Set Internal network gateway to an appropriate value
-31. Save Settings.
+ - Set the Internal network name (default admin_internal_net)
-32. Click on the "Nodes" Tab in the FUEL WEB UI.
+#. Update the Guest OS DNS servers.
-33. Assign roles.
+ - Set Guest OS DNS Server values appropriately
- - Click on "+Add Nodes" button
+#. Save Settings.
- - Check "Controller" and the "Storage-Ceph OSD" in the Assign Roles Section
+#. Select the "Other Node Networks group" on the left pane(see figure below).
- - Check the 3 Nodes you want to act as Controllers from the bottom half of the screen
+ .. figure:: img/other.png
- - Click <Apply Changes>.
+#. Update the Public network assignment.
- - Click on "+Add Nodes" button
+ - Check the box for "Assign public network to all nodes" (Required by OpenDaylight)
- - Check "Compute" in the Assign Roles Section
+#. Update Host OS DNS Servers.
- - Check the Nodes that you want to act as Computes from the bottom half of the screen
+ - Provide the DNS server settings
- - Click <Apply Changes>.
+#. Update Host OS NTP Servers.
+ - Provide the NTP server settings
-34. Configure interfaces.
+Select Hypervisor type
+----------------------
- - Check Select <All> to select all nodes with Control, Telemetry,
- MongoDB and Compute node roles.
+#. In the FUEL UI of your Environment, click the "Settings" Tab
- - Click <Configure Interfaces>
+#. Select Compute on the left side pane (see figure below)
- - Screen Configure interfaces on number of <number of nodes> nodes is shown.
+ - Check the KVM box and press "Save settings"
- - Assign interfaces (bonded) for mgmt-, admin-, private-, public-
- and storage networks
+ .. figure:: img/compute.png
+
+Enable Plugins
+--------------
+
+#. In the FUEL UI of your Environment, click the "Settings" Tab
+
+#. Select Other on the left side pane (see figure below)
- 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
+ - Enable and configure the plugins of your choice
- - Click Apply
+ .. figure:: img/plugins.png
-Enable ODL
-----------
+Allocate nodes to environment and assign functional roles
+---------------------------------------------------------
-TODO: NOT UPDATED YET FOR WP1 - NOT AVAILABLE AT TIME OF EDIT
+#. Click on the "Nodes" Tab in the FUEL WEB UI (see figure below).
-35. In the FUEL UI of your Enviornment, click the "Settings" Tab
+ .. figure:: img/addnodes.png
- - Enable OpenStack debug logging (in the Common Section) - optional
+#. Assign roles (see figure below).
- - Check the OpenDaylight Lithium Plugin Section
+ - Click on the <+Add Nodes> button
+
+ - Check <Controller>, <Telemetry - MongoDB> and optionally an SDN Controller role (OpenDaylight controller/ONOS) in the Assign Roles Section.
+
+ - Check one node which you want to act as a Controller from the bottom half of the screen
+
+ - Click <Apply Changes>.
- - Check to enable VXLAN
+ - Click on the <+Add Nodes> button
- - Modify VNI and Port Range if desired
+ - Check the <Controller> and <Storage - Ceph OSD> roles.
- - Click "Save Settings" at the bottom to Save.
+ - Check the two next nodes you want to act as Controllers from the bottom half of the screen
+
+ - Click <Apply Changes>
+
+ - Click on <+Add Nodes> button
+
+ - Check the <Compute> and <Storage - Ceph OSD> roles.
+
+ - Check the Nodes you want to act as Computes from the bottom half of the screen
+
+ - Click <Apply Changes>.
+
+ .. figure:: img/computelist.png
+
+#. Configure interfaces (see figure below).
+
+ - Check Select <All> to select all allocated nodes
+
+ - Click <Configure Interfaces>
+
+ - Assign interfaces (bonded) for mgmt-, admin-, private-, public-
+ and storage networks
+
+ - Click <Apply>
+
+ .. figure:: img/interfaceconf.png
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
+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.
+#. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
- Replace the URI values for the "Name" values outlined below:
- "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
- - "ubuntu-security" URI="deb
- http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
- - "ubuntu-updates" URI="deb
- http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
- - "mos-updates" URI="deb
- http://<ip-of-fuel-server>:8080/mos-ubuntu mos6.1-updates main
- restricted"
- - "mos-security" URI="deb
- http://<ip-of-fuel-server>:8080/mos-ubuntu mos6.1-security main
- restricted"
- - "mos-holdback" URI="deb
- http://<ip-of-fuel-server>:8080/mos-ubuntu mos6.1-holdback main
- restricted"
-
- - Click "Save Settings" at the bottom to Save your changes
+
+ - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
+
+ - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/ubuntu-part trusty main"
+
+ - "mos-updates" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-updates main restricted"
+
+ - "mos-security" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-security main restricted"
+
+ - "mos-holdback" URI="deb http://<ip-of-fuel-server>:8080/mos-ubuntu mos8.0-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.
+It is important that the Verify Networks action is performed as it will verify
+that communicate works for the networks you have setup, as well as check that
+packages needed for a successful deployment can be fetched.
+
+#. From the FUEL UI in your Environment, Select the Networks Tab and select "Connectivity check" on the left pane (see figure below)
-37. From the FUEL UI in your Environment, Select the Networks Tab
+ - Select <Verify Networks>
- - At the bottom of the page, Select "Verify Networks"
+ - Continue to fix your topology (physical switch, etc) until the "Verification Succeeded" and "Your network is configured correctly" message is shown
+
+ .. figure:: img/verifynet.png
- - 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.
+ - In the Fuel GUI, click on the "Dashboard" Tab.
- - Click on 'Deploy Changes' in the 'Ready to Deploy?' Section
+ - Click on <Deploy Changes> in the "Ready to Deploy?" section
- - Examine any information notice that pops up and click 'Deploy'
+ - 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.
+ Wait for your deployment to complete, you can view the "Dashboard"
+ Tab to see the progress and status of your deployment.
Installation health-check
=========================
-39. Perform system health-check
+#. Perform system health-check (see figure below)
- 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
+ - Check <Select All> and Click <Run Tests>
- 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
+ .. figure:: img/health.png
References
==========
@@ -607,12 +595,10 @@ OPNFV
`OPNFV Home Page <www.opnfv.org>`_
-`OPNFV Genesis project page <https://wiki.opnfv.org/get_started>`_
-
OpenStack
---------
-`OpenStack Kilo Release artifacts <http://www.openstack.org/software/kilo>`_
+`OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
`OpenStack documentation <http://docs.openstack.org>`_
@@ -625,12 +611,3 @@ Fuel
----
`Fuel documentation <https://wiki.openstack.org/wiki/Fuel>`_
-
-:Authors: Daniel Smith (Ericsson AB)
-:Version: 2.0.0
-
-**Documentation tracking**
-
-Revision: _sha1_
-
-Build date: _date