foreman/docs/src/installation-instructions.rst

   1 :Authors: Tim Rozet (trozet@redhat.com)
   2 :Version: 0.0.1
   3
   4 ====================================================
   5 OPNFV Installation Instructions - Foreman/QuickStack
   6 ====================================================
   7
   8 Abstract
   9 ========
  10
  11 This document describes how to deploy a Foreman/QuickStack-based OPNFV system.
  12
  13 .. contents:: Table of Contents
  14    :backlinks: none
  15
  16 Introduction
  17 ============
  18
  19 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.
  20
  21 The audience is assumed to have a good background in networking and Linux administration.
  22
  23 Preface
  24 =======
  25
  26 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).
  27
  28 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``).
  29
  30 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.
  31
  32 ``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.
  33
  34 Setup Requirements
  35 ==================
  36
  37 Jumphost Requirements
  38 ---------------------
  39
  40 The Jumphost requirements are outlined below:
  41
  42 1.     CentOS 7 (from ISO or self-installed).
  43
  44 2.     Root access.
  45
  46 3.     libvirt or other hypervisors disabled (no kernel modules loaded).
  47
  48 4.     3-4 NICs, untagged (no 802.1Q tagging), with IP addresses.
  49
  50 5.     Internet access for downloading packages, with a default gateway configured.
  51
  52 6.     4 GB of RAM for a bare metal deployment, 24 GB of RAM for a VM deployment.
  53
  54 Network Requirements
  55 --------------------
  56
  57 Network requirements include:
  58
  59 1.     No DHCP or TFTP server running on networks used by OPNFV.
  60
  61 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.
  62
  63 3.     Lights out OOB network access from Jumphost with IPMI node enabled (bare metal deployment only).
  64
  65 4.     Admin or public network has Internet access, meaning a gateway and DNS availability.
  66
  67 *Note: Storage network will be consolidated to the private network if only 3 networks are used.*
  68
  69 Bare Metal Node Requirements
  70 ----------------------------
  71
  72 Bare metal nodes require:
  73
  74 1.     IPMI enabled on OOB interface for power control.
  75
  76 2.     BIOS boot priority should be PXE first then local hard disk.
  77
  78 3.     BIOS PXE interface should include admin network mentioned above.
  79
  80 Execution Requirements (Bare Metal Only)
  81 ----------------------------------------
  82
  83 In order to execute a deployment, one must gather the following information:
  84
  85 1.     IPMI IP addresses for the nodes.
  86
  87 2.     IPMI login information for the nodes (user/pass).
  88
  89 3.     MAC address of admin interfaces on nodes.
  90
  91 4.     MAC address of private interfaces on 3 nodes that will be controllers.
  92
  93
  94 Installation High-Level Overview - Bare Metal Deployment
  95 ========================================================
  96
  97 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.
  98
  99 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.
 100
 101 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.
 102
 103 ``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.
 104
 105 ``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.
 106
 107 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.
 108
 109 Khaleesi will wait until these nodes are fully provisioned and then return a success or failure based on the outcome of the Puppet application.
 110
 111 Installation High-Level Overview - VM Deployment
 112 ================================================
 113
 114 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.
 115
 116 To Foreman these nodes look like they have just built and register the same way as bare metal nodes.
 117
 118 Installation Guide - Bare Metal Deployment
 119 ==========================================
 120
 121 This section goes step-by-step on how to correctly install and provision the OPNFV target system to bare metal nodes.
 122
 123 Install Bare Metal Jumphost
 124 ---------------------------
 125
 126 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 here <ISO LINK>.
 127
 128 2.  Boot the ISO off of a USB or other installation media and walk through installing OPNFV CentOS 7.
 129
 130 3.  After OS is installed login to your Jumphost as root.
 131
 132 4.  Configure IP addresses on 3-4 interfaces that you have selected as your admin, private, public, and storage (optional) networks.
 133
 134 5.  Configure the IP gateway to the Internet either, preferably on the public interface.
 135
 136 6.  Configure your ``/etc/resolv.conf`` to point to a DNS server (8.8.8.8 is provided by Google).
 137
 138 7.  Disable selinux:
 139
 140     - ``setenforce 0``
 141     - ``sed -i 's/SELINUX=.*/SELINUX=permissive/' /etc/selinux/config``
 142
 143 8.  Disable firewalld:
 144
 145     - ``systemctl stop firewalld``
 146     - ``systemctl disable firewalld``
 147
 148 Creating an Inventory File
 149 --------------------------
 150
 151 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``.
 152
 153 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``
 154
 155 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.
 156
 157 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.
 158
 159 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:
 160
 161     - ``mac_address``: change to MAC address of that node's admin NIC (defaults to 1st NIC)
 162     - ``bmc_ip``: change to IP Address of BMC (out-of-band)/IPMI IP
 163     - ``bmc_mac``: same as above, but MAC address
 164     - ``bmc_user``: IPMI username
 165     - ``bmc_pass``: IPMI password
 166
 167 5.  Also edit the following for only controller nodes:
 168
 169     - ``private_mac`` - change to MAC address of node's private NIC (default to 2nd NIC)
 170
 171 6.  Save your changes.
 172
 173 Running ``deploy.sh``
 174 ---------------------
 175
 176 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``.
 177
 178 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.
 179
 180 Follow the steps below to execute:
 181
 182 1.  ``cd /root/bgs_vagrant``
 183
 184 2.  ``./deploy.sh -base_config </root/my_ksgen_settings.yml>``
 185
 186 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.
 187
 188 4.  Your nodes will take 40-60 minutes to re-install CentOS 7 and install/configure OPNFV.  When complete you will see "Finished: SUCCESS"
 189
 190 .. _setup_verify:
 191
 192 Verifying the Setup
 193 -------------------
 194
 195 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:
 196
 197 1.  ``cd /tmp/bgs_vagrant``
 198
 199 2.  ``vagrant ssh`` (password is "vagrant")
 200
 201 3.  You are now in the VM and can check the status of Foreman service, etc.  For example: ``systemctl status foreman``
 202
 203 4.  Type "exit" and leave the Vagrant VM.  Now execute: ``cat /tmp/bgs_vagrant/opnfv_ksgen_settings.yml | grep foreman_url``
 204
 205 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.
 206
 207 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.
 208
 209     **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/**
 210
 211 7.  Now go to your web browser and insert the Horizon public VIP.  The login will be "admin"/"octopus".
 212
 213 8.  You are now able to follow the `OpenStack Verification <openstack_verify_>`_ section.
 214
 215 .. _openstack_verify:
 216
 217 OpenStack Verification
 218 ----------------------
 219
 220 Now that you have Horizon access, let's make sure OpenStack the OPNFV target system are working correctly:
 221
 222 1.  In Horizon, click Project -> Compute -> Volumes, Create Volume
 223
 224 2.  Make a volume "test_volume" of size 1 GB
 225
 226 3.  Now in the left pane, click Compute -> Images, click Create Image
 227
 228 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``
 229
 230 5.  Select format "QCOW2", select Public, then hit Create Image
 231
 232 6.  Now click Project -> Network -> Networks, click Create Network
 233
 234 7.  Enter a name "test_network", click Next
 235
 236 8.  Enter a subnet name "test_subnet", and enter Network Address ``10.0.0.0/24``, click Next
 237
 238 9.  Enter ``10.0.0.5,10.0.0.9`` under Allocation Pools, then hit Create
 239
 240 10. Now go to Project -> Compute -> Instances, click Launch Instance
 241
 242 11. Enter Instance Name "cirros1", select Instance Boot Source "Boot from image", and then select Image Name "cirros"
 243
 244 12. Click Launch, status should show "Spawning" while it is being built
 245
 246 13. You can now repeat steps 11 and 12, but create a "cirros2" named instance
 247
 248 14. Once both instances are up you can see their IP addresses on the Instances page.  Click the Instance Name of cirros1.
 249
 250 15. Now click the "Console" tab and login as "cirros"/"cubswin" :)
 251
 252 16. Verify you can ping the IP address of cirros2
 253
 254 Congratulations you have successfully installed OPNFV!
 255
 256 Installation Guide - VM Deployment
 257 ==================================
 258
 259 This section goes step-by-step on how to correctly install and provision the OPNFV target system to VM nodes.
 260
 261 Install Jumphost
 262 ----------------
 263
 264 Follow the instructions in the `Install Bare Metal Jumphost`_ section.
 265
 266 Running ``deploy.sh``
 267 ---------------------------
 268
 269 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:
 270
 271 - ``/tmp/compute``
 272 - ``/tmp/controller1``
 273 - ``/tmp/controller2``
 274 - ``/tmp/controller3``
 275
 276 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.
 277
 278 Follow the steps below to execute:
 279
 280 1.  ``cd /root/bgs_vagrant``
 281
 282 2.  ``./deploy.sh -virtual``
 283
 284 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.
 285
 286 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.
 287
 288 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!"
 289
 290 Verifying the Setup - VMs
 291 -------------------------
 292
 293 Follow the instructions in the `Verifying the Setup <setup_verify_>`_ section.
 294
 295 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.
 296
 297 OpenStack Verification - VMs
 298 ----------------------------
 299
 300 Follow the steps in `OpenStack Verification <openstack_verify_>`_ section.
 301
 302 Frequently Asked Questions
 303 ==========================
 304
 305 License
 306 =======
 307
 308 All Foreman/QuickStack and "common" entities are protected by the `Apache 2.0 License <http://www.apache.org/licenses/>`_.
 309
 310 References
 311 ==========
 312
 313 OPNFV
 314 -----
 315
 316 OpenStack
 317 ---------
 318
 319 OpenDaylight
 320 ------------
 321
 322 Foreman
 323 -------