docs/installation-instructions/baremetal.rst

   1 Installation High-Level Overview - Bare Metal Deployment
   2 ========================================================
   3
   4 The setup presumes that you have 6 bare metal servers and have already setup network
   5 connectivity on at least 2 interfaces for all servers via a TOR switch or other
   6 network implementation.
   7
   8 The physical TOR switches are **not** automatically configured from the OPNFV reference
   9 platform.  All the networks involved in the OPNFV infrastructure as well as the provider
  10 networks and the private tenant VLANs needs to be manually configured.
  11
  12 The Jumphost can be installed using the bootable ISO or by other means including the
  13 (``opnfv-apex``) RPMs and virtualization capabilities.  The Jumphost should then be
  14 configured with an IP gateway on its admin or public interface and configured with a
  15 working DNS server.  The Jumphost should also have routable access to the lights out network.
  16
  17 ``opnfv-deploy`` is then executed in order to deploy the Instack VM.  ``opnfv-deploy`` uses
  18 three configuration files in order to know how to install and provision the OPNFV target system.
  19 The information gathered under section `Execution Requirements (Bare Metal Only)`_ is put
  20 into the YAML file (``/etc/opnfv-apex/inventory.yaml``) configuration file.  Deployment
  21 options are put into the YAML file (``/etc/opnfv-apex/deploy_settings.yaml``).  Networking
  22 definitions gathered under section `Network Requirements`_ are put into the YAML file
  23 (``/etc/opnfv-apex/network_settings.yaml``).  ``opnfv-deploy`` will boot the Instack VM
  24 and load the target deployment configuration into the provisioning toolchain.  This includes
  25 MAC address, IPMI, Networking Environment and OPNFV deployment options.
  26
  27 Once configuration is loaded and Instack is configured it will then reboot the nodes via IPMI.
  28 The nodes should already be set to PXE boot first off the admin interface.  The nodes will
  29 first PXE off of the Instack PXE server and go through a discovery/introspection process.
  30
  31 Introspection boots off of custom introspection PXE images. These images are designed to look
  32 at the properties of the hardware that is booting off of them and report the properties of
  33 it back to the Instack node.
  34
  35 After introspection Instack will execute a Heat Stack Deployment to being node provisioning
  36 and configuration.  The nodes will reboot and PXE again off the Instack PXE server to
  37 provision each node using the Glance disk images provided by Instack. These disk images
  38 include all the necessary packages and configuration for an OPNFV deployment to execute.
  39 Once the node's disk images have been written to disk the nodes will boot off the newly written
  40 disks and execute cloud-init which will execute the final node configuration. This
  41 configuration is largly completed by executing a puppet apply on each node.
  42
  43 Installation High-Level Overview - VM Deployment
  44 ================================================
  45
  46 The VM nodes deployment operates almost the same way as the bare metal deployment with a
  47 few differences.  ``opnfv-deploy`` still deploys an Instack VM. In addition to the Instack VM
  48 a collection of VMs (3 control nodes + 2 compute for an HA deployment or 1 control node and
  49 1 compute node for a Non-HA Deployment) will be defined for the target OPNFV deployment.
  50 The part of the toolchain that executes IPMI power instructions calls into libvirt instead of
  51 the IPMI interfaces on baremetal servers to operate the power managment.  These VMs are then
  52 provisioned with the same disk images and configuration that baremetal would be.
  53
  54 To RDO Manager these nodes look like they have just built and registered the same way as
  55 bare metal nodes, the main difference is the use of a libvirt driver for the power management.
  56
  57 Installation Guide - Bare Metal Deployment
  58 ==========================================
  59
  60 **WARNING: Baremetal documentation is not complete.  WARNING: The main missing instructions are r elated to bridging
  61 the networking for the undercloud to the physical underlay network for the overcloud to be deployed to.**
  62
  63 This section goes step-by-step on how to correctly install and provision the OPNFV target
  64 system to bare metal nodes.
  65
  66 Install Bare Metal Jumphost
  67 ---------------------------
  68
  69 1a. If your Jumphost does not have CentOS 7 already on it, or you would like to do a fresh
  70     install, then download the Apex bootable ISO from OPNFV artifacts <http://artifacts.opnfv.org/>.
  71     There have been isolated reports of problems with the ISO having trouble completing
  72     installation successfully. In the unexpected event the ISO does not work please workaround
  73     this by downloading the CentOS 7 DVD and performing a "Virtualization Host" install.
  74     If you perform a "Minimal Install" or install type other than "Virtualization Host" simply
  75     run ``sudo yum groupinstall "Virtualization Host" && chkconfig libvird on`` and reboot
  76     the host. Once you have completed the base CentOS install proceed to step 1b.
  77
  78 1b. If your Jump host already has CentOS 7 with libvirt running on it then install the
  79     opnfv-apex RPMs from OPNFV artifacts <http://artifacts.opnfv.org/>. The following RPMS
  80     are available for installation:
  81
  82     - opnfv-apex - OpenDaylight L2 / L3 and ONOS support **
  83     - opnfv-apex-opendaylight-sfc - OpenDaylight SFC support **
  84     - opnfv-apex-undercloud (required)
  85     - opnfv-apex-common (required)
  86
  87     ** One or more of these RPMs is required
  88     If you only want the experimental SFC support then the opnfv-apex RPM is not required.
  89     If you only want OpenDaylight or ONOS support then the opnfv-apex-opendaylight-sfc RPM is
  90     not required.
  91
  92     To install these RPMs download them to the local disk on your CentOS 7 install and pass the
  93     file names directly to yum:
  94     ``sudo yum install opnfv-apex-<version>.rpm opnfv-apex-undercloud-<version>.rpm opnfv-apex-common-<version>.rpm``
  95
  96 2a.  Boot the ISO off of a USB or other installation media and walk through installing OPNFV CentOS 7.
  97     The ISO comes prepared to be written directly to a USB drive with dd as such:
  98
  99     ``dd if=opnfv-apex.iso of=/dev/sdX bs=4M``
 100
 101     Replace /dev/sdX with the device assigned to your usb drive. Then select the USB device as the
 102     boot media on your Jumphost
 103
 104 2b. Install the RDO Release RPM and the opnfv-apex RPM:
 105
 106     ``sudo yum install -y https://www.rdoproject.org/repos/rdo-release.rpm opnfv-apex-{version}.rpm``
 107
 108     The RDO Project release repository is needed to install OpenVSwitch, which is a dependency of
 109     opnfv-apex. If you do not have external connectivity to use this repository you need to download
 110     the OpenVSwitch RPM from the RDO Project repositories and install it with the opnfv-apex RPM.
 111
 112 3.  After the operating system and the opnfv-apex RPMs are installed, login to your Jumphost as root.
 113
 114 4.  Configure IP addresses on the interfaces that you have selected as your networks.
 115
 116 5.  Configure the IP gateway to the Internet either, preferably on the public interface.
 117
 118 6.  Configure your ``/etc/resolv.conf`` to point to a DNS server (8.8.8.8 is provided by Google).
 119
 120 Creating a Node Inventory File
 121 ------------------------------
 122
 123 IPMI configuration information gathered in section `Execution Requirements (Bare Metal Only)`_
 124 needs to be added to the ``inventory.yaml`` file.
 125
 126 1.  Copy ``/usr/share/doc/opnfv/inventory.yaml.example`` as your inventory file template to
 127     ``/etc/opnfv-apex/inventory.yaml``.
 128
 129 2.  The nodes dictionary contains a definition block for each baremetal host that will be deployed.
 130     1 or more compute nodes and 3 controller nodes are required.
 131     (The example file contains blocks for each of these already).
 132     It is optional at this point to add more compute nodes into the node list.
 133
 134 3.  Edit the following values for each node:
 135
 136     - ``mac_address``: MAC of the interface that will PXE boot from Instack
 137     - ``ipmi_ip``: IPMI IP Address
 138     - ``ipmi_user``: IPMI username
 139     - ``ipmi_password``: IPMI password
 140     - ``pm_type``: Power Management driver to use for the node
 141     - ``cpus``: (Introspected*) CPU cores available
 142     - ``memory``: (Introspected*) Memory available in Mib
 143     - ``disk``: (Introspected*) Disk space available in Gb
 144     - ``arch``: (Introspected*) System architecture
 145     - ``capabilities``: (Optional**) Intended node role (profile:control or profile:compute)
 146
 147 * Introspection looks up the overcloud node's resources and overrides these value. You can
 148 leave default values and Apex will get the correct values when it runs introspection on the nodes.
 149
 150 ** If capabilities profile is not specified then Apex will select node's roles in the OPNFV cluster
 151 in a non-deterministic fashion.
 152
 153 Creating the Settings Files
 154 ---------------------------
 155
 156 Edit the 2 settings files in /etc/opnfv-apex/. These files have comments to help you customize them.
 157
 158 1. deploy_settings.yaml
 159    This file includes basic configuration options deployment.
 160
 161 2. network_settings.yaml
 162    This file provides Apex with the networking information that satisfies the
 163    prerequisite `Network Requirements`_. These are specific to your environment.
 164
 165 Running ``opnfv-deploy``
 166 ------------------------
 167
 168 You are now ready to deploy OPNFV using Apex!
 169 ``opnfv-deploy`` will use the inventory and settings files to deploy OPNFV.
 170
 171 Follow the steps below to execute:
 172
 173 1.  Execute opnfv-deploy
 174     ``sudo opnfv-deploy [ --flat | -n network_settings.yaml ] -i inventory.yaml -d deploy_settings.yaml``
 175     If you need more information about the options that can be passed to opnfv-deploy use ``opnfv-deploy --help``
 176     --flat will collapse all networks onto a single nic, -n network_settings.yaml allows you to customize your
 177     networking topology.
 178
 179 2.  Wait while deployment is executed.
 180     If something goes wrong during this part of the process,
 181     it is most likely a problem with the setup of your network or the information in your configuration files.
 182     You will also notice different outputs in your shell.
 183
 184 3.  The message "Overcloud Deployed" will display when When the deployment is complete.  Just above this message there
 185     will be a URL that ends in port http://<host>:5000. This url is also the endpoint for the OPNFV Horizon Dashboard
 186     if connected to on port 80.
 187
 188 .. _`Execution Requirements (Bare Metal Only)`: requirements.html#execution-requirements-bare-metal-only
 189 .. _`Network Requirements`: requirements.html#network-requirements