Table of Contents
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.
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/>.
Date | Ver. | Author | Comment |
2015-05-07 | 0.0.1 | Tim Rozet (RedHat) | First draft |
2015-05-27 | 0.0.2 | Christopher Price (Ericsson AB) | Minor changes & formatting |
2015-06-02 | 0.0.3 | Christopher Price (Ericsson AB) | Minor changes & formatting |
2015-06-03 | 0.0.4 | Ildiko Vancsa (Ericsson) | Minor changes |
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.
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 (arno.2015.1.0.foreman.iso), and the automatic deployment script (deploy.sh).
An OPNFV install requires a "Jumphost" in order to operate. The bootable ISO will allow you to install a customized CentOS 7 release to the Jumphost, which then gives you the required packages needed to run deploy.sh. If you already have a Jumphost with CentOS 7 installed, you may choose to ignore the ISO step and instead move directly to running deploy.sh. In this case, deploy.sh will install the necessary packages for you in order to execute.
deploy.sh installs Foreman/QuickStack VM server using Vagrant with VirtualBox as its provider. This VM is then used to provision the OPNFV target system (3 controllers, n compute nodes). These nodes can be either virtual or bare metal. This guide contains instructions for installing both.
The Jumphost requirements are outlined below:
Network requirements include:
Note: Storage network will be consolidated to the private network if only 3 networks are used.
Bare metal nodes require:
In order to execute a deployment, one must gather the following information:
The setup presumes that you have 6 bare metal servers and have already setup connectivity on at least 3 interfaces for all servers via a TOR switch or other network implementation.
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.
The Jumphost can be installed using the bootable ISO. The Jumphost should then be configured with an IP gateway on its admin or public interface and configured with a working DNS server. The Jumphost should also have routable access to the lights out network.
deploy.sh is then executed in order to install the Foreman/QuickStack Vagrant VM. deploy.sh uses a configuration file with YAML format in order to know how to install and provision the OPNFV target system. The information gathered under section Execution Requirements (Bare Metal Only) is put into this configuration file.
deploy.sh brings up a CentOS 7 Vagrant VM, provided by VirtualBox. The VM then executes an Ansible project called Khaleesi in order to install Foreman and QuickStack. Once the Foreman/QuickStack VM is up, Foreman will be configured with the nodes' information. This includes MAC address, IPMI, OpenStack type (controller, compute, OpenDaylight controller) and other information. At this point Khaleesi makes a REST API call to Foreman to instruct it to provision the hardware.
Foreman will then reboot the nodes via IPMI. The nodes should already be set to PXE boot first off the admin interface. Foreman will then allow the nodes to PXE and install CentOS 7 as well as Puppet. Foreman/QuickStack VM server runs a Puppet Master and the nodes query this master to get their appropriate OPNFV configuration. The nodes will then reboot one more time and once back up, will DHCP on their private, public and storage NICs to gain IP addresses. The nodes will now check in via Puppet and start installing OPNFV.
Khaleesi will wait until these nodes are fully provisioned and then return a success or failure based on the outcome of the Puppet application.
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.
This section goes step-by-step on how to correctly install and provision the OPNFV target system to bare metal nodes.
You now need to take the MAC address/IPMI info gathered in section Execution Requirements (Bare Metal Only) and create the YAML inventory (also known as configuration) file for deploy.sh.
You are now ready to deploy OPNFV! deploy.sh will use your /tmp/ directory to store its Vagrant VMs. Your Foreman/QuickStack Vagrant VM will be running out of /tmp/bgs_vagrant.
It is also recommended that you power off your nodes before running deploy.sh If there are DHCP servers or other network services that are on those nodes it may conflict with the installation.
Follow the steps below to execute:
Now that the installer has finished it is a good idea to check and make sure things are working correctly. To access your Foreman/QuickStack VM:
cd /tmp/bgs_vagrant
vagrant ssh (password is "vagrant")
You are now in the VM and can check the status of Foreman service, etc. For example: systemctl status foreman
Type "exit" and leave the Vagrant VM. Now execute: cat /tmp/bgs_vagrant/opnfv_ksgen_settings.yml | grep foreman_url
This is your Foreman URL on your public interface. You can go to your web browser, http://<foreman_ip>, login will be "admin"/"octopus". This way you can look around in Foreman and check that your hosts are in a good state, etc.
In Foreman GUI, you can now go to Infrastructure -> Global Parameters. This is a list of all the variables being handed to Puppet for configuring OPNFV. Look for horizon_public_vip. This is your IP address to Horizon GUI.
Note: You can find out more about how to ues Foreman by going to http://www.theforeman.org/ or by watching a walkthrough video here: https://bluejeans.com/s/89gb/
Now go to your web browser and insert the Horizon public VIP. The login will be "admin"/"octopus".
You are now able to follow the OpenStack Verification section.
Now that you have Horizon access, let's make sure OpenStack the OPNFV target system are working correctly:
Congratulations you have successfully installed OPNFV!
This section goes step-by-step on how to correctly install and provision the OPNFV target system to VM nodes.
Follow the instructions in the Install Bare Metal Jumphost section.
You are now ready to deploy OPNFV! deploy.sh will use your /tmp/ directory to store its Vagrant VMs. Your Foreman/QuickStack Vagrant VM will run out of /tmp/bgs_vagrant. Your compute and subsequent controller nodes will run in:
Each VM will be brought up and bridged to your Jumphost NICs. deploy.sh will first bring up your Foreman/QuickStack Vagrant VM and afterwards it will bring up each of the nodes listed above, in order.
Follow the steps below to execute:
Follow the instructions in the Verifying the Setup section.
Also, for VM deployment you are able to easily access your nodes by going to /tmp/<node name> and then vagrant ssh (password is "vagrant"). You can use this to go to a controller and check OpenStack services, OpenDaylight, etc.
Follow the steps in OpenStack Verification section.
All Foreman/QuickStack and "common" entities are protected by the Apache 2.0 License.
Upstream OpenDaylight provides a number of packaging and deployment options meant for consumption by downstream projects like OPNFV.
Currently, OPNFV Foreman uses OpenDaylight's Puppet module, which in turn depends on OpenDaylight's RPM.
Note that the RPM is currently hosted on Copr, but will soon be migrated to OpenDaylight's infrastructure and/or the new CentOS NFV SIG.
Authors: | Tim Rozet (trozet@redhat.com) |
---|---|
Version: | 0.0.3 |
Documentation tracking
Revision: 1a9d2532a3cf8bf01fbe829d38bc8988d43aca44
Build date: Tue Jul 28 15:39:58 UTC 2015