foreman/docs/src/installation-instructions.rst

   1 =======================================================================================================
   2 OPNFV Installation instructions for the Arno release of OPNFV when using Foreman as a deployment tool
   3 =======================================================================================================
   4
   5
   6 .. contents:: Table of Contents
   7    :backlinks: none
   8
   9
  10 Abstract
  11 ========
  12
  13 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.
  14
  15 License
  16 =======
  17 Arno release of OPNFV when using Foreman as a deployment tool Docs (c) by Tim Rozet (RedHat)
  18
  19 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/>.
  20
  21 Version history
  22 ===================
  23
  24 +--------------------+--------------------+--------------------+--------------------+
  25 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 | 2015-05-07         | 0.0.1              | Tim Rozet          | First draft        |
  29 |                    |                    | (RedHat)           |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31 | 2015-05-27         | 0.0.2              | Christopher Price  | Minor changes &    |
  32 |                    |                    | (Ericsson AB)      | formatting         |
  33 +--------------------+--------------------+--------------------+--------------------+
  34 | 2015-06-02         | 0.0.3              | Christopher Price  | Minor changes &    |
  35 |                    |                    | (Ericsson AB)      | formatting         |
  36 +--------------------+--------------------+--------------------+--------------------+
  37 | 2015-06-03         | 0.0.4              | Ildiko Vancsa      | Minor changes      |
  38 |                    |                    | (Ericsson)         |                    |
  39 +--------------------+--------------------+--------------------+--------------------+
  40
  41
  42 Introduction
  43 ============
  44
  45 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.
  46
  47 The audience is assumed to have a good background in networking and Linux administration.
  48
  49 Preface
  50 =======
  51
  52 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).
  53
  54 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``).
  55
  56 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.
  57
  58 ``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.
  59
  60 Setup Requirements
  61 ==================
  62
  63 Jumphost Requirements
  64 ---------------------
  65
  66 The Jumphost requirements are outlined below:
  67
  68 1.     CentOS 7 (from ISO or self-installed).
  69
  70 2.     Root access.
  71
  72 3.     libvirt or other hypervisors disabled (no kernel modules loaded).
  73
  74 4.     3-4 NICs, untagged (no 802.1Q tagging), with IP addresses.
  75
  76 5.     Internet access for downloading packages, with a default gateway configured.
  77
  78 6.     4 GB of RAM for a bare metal deployment, 24 GB of RAM for a VM deployment.
  79
  80 Network Requirements
  81 --------------------
  82
  83 Network requirements include:
  84
  85 1.     No DHCP or TFTP server running on networks used by OPNFV.
  86
  87 2.     3-4 separate VLANs (untagged) with connectivity between Jumphost and nodes (bare metal deployment only).  These make up the admin, private, public and optional storage networks.
  88
  89 3.     Lights out OOB network access from Jumphost with IPMI node enabled (bare metal deployment only).
  90
  91 4.     Admin or public network has Internet access, meaning a gateway and DNS availability.
  92
  93 *Note: Storage network will be consolidated to the private network if only 3 networks are used.*
  94
  95 Bare Metal Node Requirements
  96 ----------------------------
  97
  98 Bare metal nodes require:
  99
 100 1.     IPMI enabled on OOB interface for power control.
 101
 102 2.     BIOS boot priority should be PXE first then local hard disk.
 103
 104 3.     BIOS PXE interface should include admin network mentioned above.
 105
 106 Execution Requirements (Bare Metal Only)
 107 ----------------------------------------
 108
 109 In order to execute a deployment, one must gather the following information:
 110
 111 1.     IPMI IP addresses for the nodes.
 112
 113 2.     IPMI login information for the nodes (user/pass).
 114
 115 3.     MAC address of admin interfaces on nodes.
 116
 117 4.     MAC address of private interfaces on 3 nodes that will be controllers.
 118
 119
 120 Installation High-Level Overview - Bare Metal Deployment
 121 ========================================================
 122
 123 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.
 124
 125 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.
 126
 127 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.
 128
 129 ``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.
 130
 131 ``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.
 132
 133 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.
 134
 135 Khaleesi will wait until these nodes are fully provisioned and then return a success or failure based on the outcome of the Puppet application.
 136
 137 Installation High-Level Overview - VM Deployment
 138 ================================================
 139
 140 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.
 141
 142 To Foreman these nodes look like they have just built and register the same way as bare metal nodes.
 143
 144 Installation Guide - Bare Metal Deployment
 145 ==========================================
 146
 147 This section goes step-by-step on how to correctly install and provision the OPNFV target system to bare metal nodes.
 148
 149 Install Bare Metal Jumphost
 150 ---------------------------
 151
 152 1.  If your Jumphost does not have CentOS 7 already on it, or you would like to do a fresh install, then download the Foreman/QuickStack bootable ISO <http://artifacts.opnfv.org/arno.2015.1.0/foreman/arno.2015.1.0.foreman.iso> here.
 153
 154 2.  Boot the ISO off of a USB or other installation media and walk through installing OPNFV CentOS 7.
 155
 156 3.  After OS is installed login to your Jumphost as root.
 157
 158 4.  Configure IP addresses on 3-4 interfaces that you have selected as your admin, private, public, and storage (optional) networks.
 159
 160 5.  Configure the IP gateway to the Internet either, preferably on the public interface.
 161
 162 6.  Configure your ``/etc/resolv.conf`` to point to a DNS server (8.8.8.8 is provided by Google).
 163
 164 7.  Disable selinux:
 165
 166     - ``setenforce 0``
 167     - ``sed -i 's/SELINUX=.*/SELINUX=permissive/' /etc/selinux/config``
 168
 169 8.  Disable firewalld:
 170
 171     - ``systemctl stop firewalld``
 172     - ``systemctl disable firewalld``
 173
 174 Creating an Inventory File
 175 --------------------------
 176
 177 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``.
 178
 179 1.  Copy the ``opnfv_ksgen_settings.yml`` file from ``/root/bgs_vagrant/`` to another directory and rename it to be what you want EX: ``/root/my_ksgen_settings.yml``
 180
 181 2.  Edit the file in your favorite editor.  There is a lot of information in this file, but you really only need to be concerned with the "nodes:" dictionary.
 182
 183 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.
 184
 185 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:
 186
 187     - ``mac_address``: change to MAC address of that node's admin NIC (defaults to 1st NIC)
 188     - ``bmc_ip``: change to IP Address of BMC (out-of-band)/IPMI IP
 189     - ``bmc_mac``: same as above, but MAC address
 190     - ``bmc_user``: IPMI username
 191     - ``bmc_pass``: IPMI password
 192
 193 5.  Also edit the following for only controller nodes:
 194
 195     - ``private_mac`` - change to MAC address of node's private NIC (default to 2nd NIC)
 196
 197 6.  Save your changes.
 198
 199 Running ``deploy.sh``
 200 ---------------------
 201
 202 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``.
 203
 204 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.
 205
 206 Follow the steps below to execute:
 207
 208 1.  ``cd /root/bgs_vagrant``
 209
 210 2.  ``./deploy.sh -base_config </root/my_ksgen_settings.yml>``
 211
 212 3.  It will take about 20-25 minutes to install Foreman/QuickStack VM.  If something goes wrong during this part of the process, it is most likely a problem with the setup of your Jumphost.  You will also notice different outputs in your shell.  When you see messages that say "TASK:" or "PLAY:" this is Khalessi running and installing Foreman/QuickStack inside of your VM or deploying your nodes.  Look for "PLAY [Deploy Nodes]" as a sign that Foreman/QuickStack is finished installing and now your nodes are being rebuilt.
 213
 214 4.  Your nodes will take 40-60 minutes to re-install CentOS 7 and install/configure OPNFV.  When complete you will see "Finished: SUCCESS"
 215
 216 Verifying the Setup
 217 -------------------
 218
 219 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:
 220
 221 1.  ``cd /tmp/bgs_vagrant``
 222
 223 2.  ``vagrant ssh`` (password is "vagrant")
 224
 225 3.  You are now in the VM and can check the status of Foreman service, etc.  For example: ``systemctl status foreman``
 226
 227 4.  Type "exit" and leave the Vagrant VM.  Now execute: ``cat /tmp/bgs_vagrant/opnfv_ksgen_settings.yml | grep foreman_url``
 228
 229 5.  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.
 230
 231 6.  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.
 232
 233     **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/**
 234
 235 7.  Now go to your web browser and insert the Horizon public VIP.  The login will be "admin"/"octopus".
 236
 237 8.  You are now able to follow the `OpenStack Verification`_ section.
 238
 239 OpenStack Verification
 240 ----------------------
 241
 242 Now that you have Horizon access, let's make sure OpenStack the OPNFV target system are working correctly:
 243
 244 1.  In Horizon, click Project -> Compute -> Volumes, Create Volume
 245
 246 2.  Make a volume "test_volume" of size 1 GB
 247
 248 3.  Now in the left pane, click Compute -> Images, click Create Image
 249
 250 4.  Insert a name "cirros", Insert an Image Location ``http://download.cirros-cloud.net/0.3.3/cirros-0.3.3-x86_64-disk.img``
 251
 252 5.  Select format "QCOW2", select Public, then hit Create Image
 253
 254 6.  Now click Project -> Network -> Networks, click Create Network
 255
 256 7.  Enter a name "test_network", click Next
 257
 258 8.  Enter a subnet name "test_subnet", and enter Network Address ``10.0.0.0/24``, click Next
 259
 260 9.  Enter ``10.0.0.5,10.0.0.9`` under Allocation Pools, then hit Create
 261
 262 10. Now go to Project -> Compute -> Instances, click Launch Instance
 263
 264 11. Enter Instance Name "cirros1", select Instance Boot Source "Boot from image", and then select Image Name "cirros"
 265
 266 12. Click Launch, status should show "Spawning" while it is being built
 267
 268 13. You can now repeat steps 11 and 12, but create a "cirros2" named instance
 269
 270 14. Once both instances are up you can see their IP addresses on the Instances page.  Click the Instance Name of cirros1.
 271
 272 15. Now click the "Console" tab and login as "cirros"/"cubswin" :)
 273
 274 16. Verify you can ping the IP address of cirros2
 275
 276 Congratulations you have successfully installed OPNFV!
 277
 278 Installation Guide - VM Deployment
 279 ==================================
 280
 281 This section goes step-by-step on how to correctly install and provision the OPNFV target system to VM nodes.
 282
 283 Install Jumphost
 284 ----------------
 285
 286 Follow the instructions in the `Install Bare Metal Jumphost`_ section.
 287
 288 Running ``deploy.sh``
 289 ---------------------------
 290
 291 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:
 292
 293 - ``/tmp/compute``
 294 - ``/tmp/controller1``
 295 - ``/tmp/controller2``
 296 - ``/tmp/controller3``
 297
 298 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.
 299
 300 Follow the steps below to execute:
 301
 302 1.  ``cd /root/bgs_vagrant``
 303
 304 2.  ``./deploy.sh -virtual``
 305
 306 3.  It will take about 20-25 minutes to install Foreman/QuickStack VM.  If something goes wrong during this part of the process, it is most likely a problem with the setup of your Jumphost.  You will also notice different outputs in your shell.  When you see messages that say "TASK:" or "PLAY:" this is Khalessi running and installing Foreman/QuickStack inside of your VM or deploying your nodes.  When you see "Foreman is up!", that means deploy will now move on to bringing up your other nodes.
 307
 308 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.
 309
 310 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!"
 311
 312 Verifying the Setup - VMs
 313 -------------------------
 314
 315 Follow the instructions in the `Verifying the Setup`_ section.
 316
 317 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.
 318
 319 OpenStack Verification - VMs
 320 ----------------------------
 321
 322 Follow the steps in `OpenStack Verification`_ section.
 323
 324 Frequently Asked Questions
 325 ==========================
 326
 327 License
 328 =======
 329
 330 All Foreman/QuickStack and "common" entities are protected by the `Apache 2.0 License <http://www.apache.org/licenses/>`_.
 331
 332 References
 333 ==========
 334
 335 OPNFV
 336 -----
 337
 338 `OPNFV Home Page <www.opnfv.org>`_
 339
 340 `OPNFV Genesis project page <https://wiki.opnfv.org/get_started>`_
 341
 342 OpenStack
 343 ---------
 344
 345 `OpenStack Juno Release artifacts <http://www.openstack.org/software/juno>`_
 346
 347 `OpenStack documentation <http://docs.openstack.org>`_
 348
 349 OpenDaylight
 350 ------------
 351
 352 Upstream OpenDaylight provides `a number of packaging and deployment options <https://wiki.opendaylight.org/view/Deployment>`_ meant for consumption by downstream projects like OPNFV.
 353
 354 Currently, OPNFV Foreman uses `OpenDaylight's Puppet module <https://github.com/dfarrell07/puppet-opendaylight>`_, which in turn depends on `OpenDaylight's RPM <https://copr.fedoraproject.org/coprs/dfarrell07/OpenDaylight/>`_.
 355
 356 Note that the RPM is currently hosted on Copr, but `will soon <https://trello.com/c/qseotfgL/171-host-odl-rpm-on-odl-infra>`_ be migrated to OpenDaylight's infrastructure and/or the new CentOS NFV SIG.
 357
 358 Foreman
 359 -------
 360
 361 `Foreman documentation <http://theforeman.org/documentation.html>`_
 362
 363 :Authors: Tim Rozet (trozet@redhat.com)
 364 :Version: 0.0.3
 365
 366 **Documentation tracking**
 367
 368 Revision: _sha1_
 369
 370 Build date:  _date_
 371