:Authors: Tim Rozet (trozet@redhat.com)
-:Version: 0.0.1
+:Version: 0.0.2
-====================================================
-OPNFV Installation Instructions - Foreman/QuickStack
-====================================================
+=======================================================================================================
+OPNFV Installation instructions for the Arno release of OPNFV when using Foreman as a deployment tool
+=======================================================================================================
Abstract
========
-This document describes how to deploy a Foreman/QuickStack-based OPNFV system.
+This document describes how to install the Arno release of OPNFV when using Foreman/Quickstack as a deployment tool covering it's limitations, dependencies and required system resources.
+
+License
+=======
+Arno release of OPNFV when using Foreman as a deployment tool Docs (c) by Tim Rozet (RedHat)
+
+Arno release of OPNFV when using Foreman 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 <http://creativecommons.org/licenses/by/4.0/>.
+
+Version history
+===================
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| 2015-05-07 | 0.0.1 | Tim Rozet | First draft |
+| | | (RedHat) | |
++--------------------+--------------------+--------------------+--------------------+
+| 2015-05-27 | 0.0.2 | Christopher Price | Minor changes & |
+| | | (Ericsson AB) | formatting |
++--------------------+--------------------+--------------------+--------------------+
+
.. contents:: Table of Contents
:backlinks: none
+
Introduction
============
-This document describes the steps to install an OPNFV R1 (Arno) reference platform, as defined by the Bootstrap/Getting-Started (BGS) Project using the Foreman/QuickStack installer.
+This document describes the steps to install an OPNFV Arno reference platform, as defined by the Bootstrap/Getting-Started (BGS) Project using the Foreman/QuickStack installer.
The audience is assumed to have a good background in networking and Linux administration.
Preface
=======
-Foreman/QuickStack uses the Foreman Open Source project as a server management tool, which in turn manages and executes Genesis/QuickStack. Genesis/QuickStack consists of layers of Puppet modules which are capable of provisioning the OPNFV Target System (3 controllers, n number of compute nodes).
+Foreman/QuickStack uses the Foreman Open Source project as a server management tool, which in turn manages and executes Genesis/QuickStack. Genesis/QuickStack consists of layers of Puppet modules that are capable of provisioning the OPNFV Target System (3 controllers, n number of compute nodes).
The Genesis repo contains the necessary tools to get install and deploy an OPNFV target system using Foreman/QuickStack. These tools consist of the Foreman/QuickStack bootable ISO, and the automatic deployment script (``deploy.sh``).
Installation High-Level Overview - VM Deployment
================================================
-The VM nodes deployment operates almost the same way as the bare metal deployment with a few differences. ``deploy.sh`` still installs Foreman/QuickStack VM the exact same way, however the part of the Khaleesi Ansible playbook which IPMI reboots/PXE boots the servers is ignored. Instead, ``deploy.sh`` brings up N number more Vagrant VMs (where N is 3 control nodes + n compute). These VMs already come up with CentOS 7 so instead of re-provisioning the entire VM, ``deploy.sh`` initiates a small Bash script which will signal to Foreman that those nodes are built and install/configure Puppet on them.
+The VM nodes deployment operates almost the same way as the bare metal deployment with a few differences. ``deploy.sh`` still installs Foreman/QuickStack VM the exact same way, however the part of the Khaleesi Ansible playbook which IPMI reboots/PXE boots the servers is ignored. Instead, ``deploy.sh`` brings up N number more Vagrant VMs (where N is 3 control nodes + n compute). These VMs already come up with CentOS 7 so instead of re-provisioning the entire VM, ``deploy.sh`` initiates a small Bash script that will signal to Foreman that those nodes are built and install/configure Puppet on them.
To Foreman these nodes look like they have just built and register the same way as bare metal nodes.
3. The nodes dictionary contains each bare metal host you want to deploy. You can have 1 or more compute nodes and must have 3 controller nodes (these are already defined for you). It is optional at this point to add more compute nodes into the dictionary. You must use a different name, hostname, short_name and dictionary keyname for each node.
-4. Once you have decided on your node definitions you now need to modify the MAC address/IPMI info dependant to your hardware. Edit the following values for each node:
+4. Once you have decided on your node definitions you now need to modify the MAC address/IPMI info dependent on your hardware. Edit the following values for each node:
- ``mac_address``: change to MAC address of that node's admin NIC (defaults to 1st NIC)
- ``bmc_ip``: change to IP Address of BMC (out-of-band)/IPMI IP
4. ``deploy.sh`` will now bring up your other nodes, look for logging messages like "Starting Vagrant Node <node name>", "<node name> VM is up!" These are indicators of how far along in the process you are. ``deploy.sh`` will start each Vagrant VM, then run provisioning scripts to inform Foreman they are built and initiate Puppet.
-5. The speed at which nodes are provisioned is totally dependant on your Jumphost server specs. When complete you will see "All VMs are UP!"
+5. The speed at which nodes are provisioned is totally dependent on your Jumphost server specs. When complete you will see "All VMs are UP!"
Verifying the Setup - VMs
-------------------------
:Authors: Jonas Bjurel (Ericsson AB)
-:Version: 0.0.3
+:Version: 0.0.4
==================================================================================================
OPNFV Installation instructions for the Arno release of OPNFV when using Fuel as a deployment tool
Arno 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 <http://creativecommons.org/licenses/by/4.0/>.
-
-**Contents**
-
-1 Version history
-
-2 Introduction
-
-3 Preface
-
-4 Hardware requirements
-
-5 Top of the rack (TOR) Configuration requirements
-
-6 OPNFV Software installation and deployment
-
-7 Installation health-check
-
-8 Post installation and deployment actions
-
-9 References
-
-1 Version history
-===================
+Version history
+===============
+--------------------+--------------------+--------------------+--------------------+
| **Date** | **Ver.** | **Author** | **Comment** |
| 2015-05-16 | 0.0.3 | Christopher Price | Minor changes |
| | | (Ericsson AB) | |
+--------------------+--------------------+--------------------+--------------------+
+| 2015-05-27 | 0.0.4 | Christopher Price | Minor changes |
+| | | (Ericsson AB) | |
++--------------------+--------------------+--------------------+--------------------+
+
+
+.. contents:: Table of Contents
+ :backlinks: none
-2 Introduction
-================
+Introduction
+============
-This document describes the supported software and hardware configurations for the Arno release of OPNFV when using Fuel as a deployment tool as well as providing guidelines on how to install and configure such reference system.
+This document describes providing guidelines on how to install and configure the Arno 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, 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 R1 (Arno) compliant.
+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 Arno compliant deployment.
The audience of this document is assumed to have good knowledge in networking and Unix/Linux administration.
-3 Preface
-===========
+Preface
+=======
-Before starting the installation of Arno release of OPNFV when using Fuel as a deployment tool, some planning must preceed.
+Before starting the installation of the Arno release of OPNFV when using Fuel as a deployment tool, some planning must be done.
-First of all, the Fuel@OPNFV .iso image needs to be retrieved, the Latest stable Arno release of OPNFV when using Fuel as a deployment tool can be found here: <www.opnfv.org/abc/def>
+First of all, the Fuel deployment .iso image needs to be retrieved, the Latest stable Arno release of OPNFV when using Fuel as a deployment tool can be found here: <www.opnfv.org/abc/def>
Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository:
<cd genesis; git checkout arno>
-Goto the fuel directory and build the .iso
+Go to the fuel directory and build the .iso
<cd fuel/build; make all>
This information will be needed for the configuration procedures provided in this document.
-4 Hardware requirements
-=========================
+Hardware requirements
+=====================
-Following minimum hardware requirements must be met for installation of Fuel@OPNFV:
+The following minimum hardware requirements must be met for the installation of Arno using Fuel:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
+--------------------+------------------------------------------------------+
-5 Top of the rack (TOR) Configuration requirements
-====================================================
+Top of the rack (TOR) Configuration requirements
+================================================
-The switching infrastructure provides connectivity for the OPNFV infra-structure 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 sugested that three physcally 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 physcally separated networks.
+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 infra-structure as well as the provider networks and the private tenant VLANs needs to be manually configured.
+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 Arno hardware platform should be carried out according to the Pharos specification <link>.
-6 OPNFV Software installation and deployment
-==============================================
+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.
-6.1 Install Fuel master
------------------------
+Install Fuel master
+-------------------
1. Mount the built .iso file (release/opnfv-<version>.iso) as a boot device to the jump host server.
2. Reboot the jump host to establish the Fuel server.
- Press [Enter].
-4 Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
+4. Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
5. Select PXE Setup and change the following fields to appropriate values (example below):
Note: This will take about 15 minutes.
-6.2 Create an OPNV (Fuel Environment)
--------------------------------------
+Create an OPNFV Environment
+---------------------------
9. Connect to Fuel with a browser towards port 8000
** Note: This will later be overridden to VXLAN by OpenDaylight.**
-15. Select Storage Backends.
+15. Select Storage Back-ends.
- Select Ceph for Cinder and default for glance.
17. Create the new environment.
-6.3 Configure the OPNFV environment
------------------------------------
+Configure the OPNFV environment
+-------------------------------
18. 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.
+ - 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.
-19. Reboot all the controller- and compute blades.
+19. Reboot all the control and compute blades.
20. Wait for the availability of nodes showing up in the Fuel GUI.
- Gateway to <Gateway for Public IP Addresses>
- - Check VLAN tagging.
+ - Check VLAN tagging.
- Set appropriate VLAN id.
- Check VLAN tagging.
- - Set appropriate VLAN id.
+ - Set appropriate VLAN id.
25. Update the Neutron L2 configuration.
- Check <Controller and Telemetry MongoDB>.
- - Check the three servers you want to be installed as Controlle
sr in pane <Assign Role>.
+ - Check the three servers you want to be installed as Controlle
rs in pane <Assign Role>.
- Click <Apply Changes>.
- Check <Compute>.
- - Check nodes to be installed as Compute nodes in pane Assign Role.
+ - Check nodes to be installed as compute nodes in pane Assign Role.
- Click <Apply Changes>.
32. Configure interfaces.
- - Check Select <All> to select all nodes with Control, Telemetry . MongoDB and Compute node roles.
+ - Check Select <All> to select all nodes with Control, Telemetry, MongoDB and Compute node roles.
- Click <Configure Interfaces>
- Screen Configure interfaces on number of <number of nodes> nodes is shown.
+
- Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
-6.4 Deploy the OPNFV environment
---------------------------------
-**NOTE: Before the deployment is performed, the OPNFV pre-deploy script must be ran**
+Deploy the OPNFV environment
+----------------------------
+**NOTE: Before the deployment is performed, the OPNFV pre-deploy script must be run**
35. Run the pre-deploy script.
Log on as root to the Fuel node.
37. Deploy the environment.
In the Fuel GUI, click Deploy Changes.
-7 Installation health-check
-=============================
+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
+- Select all test cases
- And click “Run tests”
All test cases except the following should pass:
-8 Post installation and deployment actions
-============================================
+Post installation and deployment actions
+========================================
**-**
-9 References
-=============
+References
+==========
-9.1 OPNFV
--------------
+OPNFV
+-----
-9.2 OpenStack
------------------
+OpenStack
+---------
-9.3 OpenDaylight
---------------------
-
-9.4 Fuel
+OpenDaylight
------------
+
+Fuel
+----
Code Review / genesis.git / commitdiff