1 Installation High-Level Overview - Bare Metal Deployment
2 ========================================================
4 The setup presumes that you have 6 or more bare metal servers already setup
5 with network connectivity on at least 1 or more network interfaces for all
6 servers via a TOR switch or other network implementation.
8 The physical TOR switches are **not** automatically configured from the OPNFV
9 reference platform. All the networks involved in the OPNFV infrastructure as
10 well as the provider networks and the private tenant VLANs needs to be manually
13 The Jumphost can be installed using the bootable ISO or by using the
14 (``opnfv-apex*.rpm``) RPMs and their dependencies. The Jumphost should then be
15 configured with an IP gateway on its admin or public interface and configured
16 with a working DNS server. The Jumphost should also have routable access
17 to the lights out network for the overcloud nodes.
19 ``opnfv-deploy`` is then executed in order to deploy the undercloud VM and to
20 provision the overcloud nodes. ``opnfv-deploy`` uses three configuration files
21 in order to know how to install and provision the OPNFV target system.
22 The information gathered under section
23 `Execution Requirements (Bare Metal Only)`_ is put into the YAML file
24 ``/etc/opnfv-apex/inventory.yaml`` configuration file. Deployment options are
25 put into the YAML file ``/etc/opnfv-apex/deploy_settings.yaml``. Alternatively
26 there are pre-baked deploy_settings files available in ``/etc/opnfv-apex/``.
27 These files are named with the naming convention
28 os-sdn_controller-enabled_feature-[no]ha.yaml. These files can be used in place
29 of the ``/etc/opnfv-apex/deploy_settings.yaml`` file if one suites your
30 deployment needs. Networking definitions gathered under section
31 `Network Requirements`_ are put into the YAML file
32 ``/etc/opnfv-apex/network_settings.yaml``. ``opnfv-deploy`` will boot the
33 undercloud VM and load the target deployment configuration into the
34 provisioning toolchain. This information includes MAC address, IPMI,
35 Networking Environment and OPNFV deployment options.
37 Once configuration is loaded and the undercloud is configured it will then
38 reboot the overcloud nodes via IPMI. The nodes should already be set to PXE
39 boot first off the admin interface. The nodes will first PXE off of the
40 undercloud PXE server and go through a discovery/introspection process.
42 Introspection boots off of custom introspection PXE images. These images are
43 designed to look at the properties of the hardware that is being booted
44 and report the properties of it back to the undercloud node.
46 After introspection the undercloud will execute a Heat Stack Deployment to
47 continue node provisioning and configuration. The nodes will reboot and PXE
48 from the undercloud PXE server again to provision each node using Glance disk
49 images provided by the undercloud. These disk images include all the necessary
50 packages and configuration for an OPNFV deployment to execute. Once the disk
51 images have been written to node's disks the nodes will boot locally and
52 execute cloud-init which will execute the final node configuration. This
53 configuration is largely completed by executing a puppet apply on each node.
55 Installation High-Level Overview - VM Deployment
56 ================================================
58 The VM nodes deployment operates almost the same way as the bare metal
59 deployment with a few differences mainly related to power management.
60 ``opnfv-deploy`` still deploys an undercloud VM. In addition to the undercloud
61 VM a collection of VMs (3 control nodes + 2 compute for an HA deployment or 1
62 control node and 1 or more compute nodes for a Non-HA Deployment) will be
63 defined for the target OPNFV deployment. The part of the toolchain that
64 executes IPMI power instructions calls into libvirt instead of the IPMI
65 interfaces on baremetal servers to operate the power management. These VMs are
66 then provisioned with the same disk images and configuration that baremetal
69 To Triple-O these nodes look like they have just built and registered the same
70 way as bare metal nodes, the main difference is the use of a libvirt driver for
73 Installation Guide - Bare Metal Deployment
74 ==========================================
76 This section goes step-by-step on how to correctly install and provision the
77 OPNFV target system to bare metal nodes.
79 Install Bare Metal Jumphost
80 ---------------------------
82 1a. If your Jumphost does not have CentOS 7 already on it, or you would like to
83 do a fresh install, then download the Apex bootable ISO from the OPNFV
84 artifacts site <http://artifacts.opnfv.org/apex.html>. There have been
85 isolated reports of problems with the ISO having trouble completing
86 installation successfully. In the unexpected event the ISO does not work
87 please workaround this by downloading the CentOS 7 DVD and performing a
88 "Virtualization Host" install. If you perform a "Minimal Install" or
89 install type other than "Virtualization Host" simply run
90 ``sudo yum groupinstall "Virtualization Host"``
91 ``chkconfig libvirtd on && reboot``
92 to install virtualzation support and enable libvirt on boot. If you use the
93 CentOS 7 DVD proceed to step 1b once the CentOS 7 with "Virtualzation Host"
96 1b. If your Jump host already has CentOS 7 with libvirt running on it then
97 install the RDO Newton Release RPM and epel-release:
99 ``sudo yum install https://repos.fedorapeople.org/repos/openstack/openstack-newton/rdo-release-newton-4.noarch.rpm``
100 ``sudo yum install epel-release``
102 The RDO Project release repository is needed to install OpenVSwitch, which
103 is a dependency of opnfv-apex. If you do not have external connectivity to
104 use this repository you need to download the OpenVSwitch RPM from the RDO
105 Project repositories and install it with the opnfv-apex RPM.
107 2a. Boot the ISO off of a USB or other installation media and walk through
108 installing OPNFV CentOS 7. The ISO comes prepared to be written directly
109 to a USB drive with dd as such:
111 ``dd if=opnfv-apex.iso of=/dev/sdX bs=4M``
113 Replace /dev/sdX with the device assigned to your usb drive. Then select
114 the USB device as the boot media on your Jumphost
116 2b. If your Jump host already has CentOS 7 with libvirt running on it then
117 install the opnfv-apex RPMs using the OPNFV artifacts yum repo. This yum
118 repo is created at release. It will not exist before release day.
120 ``sudo yum install http://artifacts.opnfv.org/apex/euphrates/opnfv-apex-release-euphrates.noarch.rpm``
122 Once you have installed the repo definitions for Apex, RDO and EPEL then
125 ``sudo yum install opnfv-apex``
127 2c. If you choose not to use the Apex yum repo or you choose to use
128 pre-released RPMs you can download and install the required RPMs from the
129 artifacts site <http://artifacts.opnfv.org/apex.html>. The following RPMs
130 are available for installation:
132 - opnfv-apex - OpenDaylight, OVN, and nosdn support *
133 - opnfv-apex-undercloud - (reqed) Undercloud Image
134 - python34-opnfv-apex - (reqed) OPNFV Apex Python package
135 - python34-markupsafe - (reqed) Dependency of python34-opnfv-apex **
136 - python34-jinja2 - (reqed) Dependency of python34-opnfv-apex **
137 - python3-ipmi - (reqed) Dependency of python34-opnfv-apex **
138 - python34-pbr - (reqed) Dependency of python34-opnfv-apex **
139 - python34-virtualbmc - (reqed) Dependency of python34-opnfv-apex **
140 - python34-iptables - (reqed) Dependency of python34-opnfv-apex **
141 - python34-cryptography - (reqed) Dependency of python34-opnfv-apex **
142 - python34-libvirt - (reqed) Dependency of python34-opnfv-apex **
144 \* One or more of these RPMs is required
145 Only one of opnfv-apex or opnfv-apex-onos is required. It is safe to leave
146 the unneeded SDN controller's RPMs uninstalled if you do not intend to use
149 ** These RPMs are not yet distributed by CentOS or EPEL.
150 Apex has built these for distribution with Apex while CentOS and EPEL do
151 not distribute them. Once they are carried in an upstream channel Apex will
152 no longer carry them and they will not need special handling for
156 The EPEL and RDO yum repos are still required:
157 ``sudo yum install epel-release``
158 ``sudo yum install https://repos.fedorapeople.org/repos/openstack/openstack-newton/rdo-release-newton-4.noarch.rpm``
160 Once the apex RPMs are downloaded install them by passing the file names
162 ``sudo yum install python34-markupsafe-<version>.rpm
163 python3-jinja2-<version>.rpm python3-ipmi-<version>.rpm``
164 ``sudo yum install opnfv-apex-<version>.rpm
165 opnfv-apex-undercloud-<version>.rpm python34-opnfv-apex-<version>.rpm``
167 3. After the operating system and the opnfv-apex RPMs are installed, login to
168 your Jumphost as root.
170 4. Configure IP addresses on the interfaces that you have selected as your
173 5. Configure the IP gateway to the Internet either, preferably on the public
176 6. Configure your ``/etc/resolv.conf`` to point to a DNS server
177 (8.8.8.8 is provided by Google).
179 Creating a Node Inventory File
180 ------------------------------
182 IPMI configuration information gathered in section
183 `Execution Requirements (Bare Metal Only)`_ needs to be added to the
184 ``inventory.yaml`` file.
186 1. Copy ``/usr/share/doc/opnfv/inventory.yaml.example`` as your inventory file
187 template to ``/etc/opnfv-apex/inventory.yaml``.
189 2. The nodes dictionary contains a definition block for each baremetal host
190 that will be deployed. 1 or more compute nodes and 3 controller nodes are
191 required. (The example file contains blocks for each of these already).
192 It is optional at this point to add more compute nodes into the node list.
194 3. Edit the following values for each node:
196 - ``mac_address``: MAC of the interface that will PXE boot from undercloud
197 - ``ipmi_ip``: IPMI IP Address
198 - ``ipmi_user``: IPMI username
199 - ``ipmi_password``: IPMI password
200 - ``pm_type``: Power Management driver to use for the node
201 values: pxe_ipmitool (tested) or pxe_wol (untested) or pxe_amt (untested)
202 - ``cpus``: (Introspected*) CPU cores available
203 - ``memory``: (Introspected*) Memory available in Mib
204 - ``disk``: (Introspected*) Disk space available in Gb
205 - ``disk_device``: (Opt***) Root disk device to use for installation
206 - ``arch``: (Introspected*) System architecture
207 - ``capabilities``: (Opt**) Node's role in deployment
208 values: profile:control or profile:compute
210 \* Introspection looks up the overcloud node's resources and overrides these
211 value. You can leave default values and Apex will get the correct values when
212 it runs introspection on the nodes.
214 ** If capabilities profile is not specified then Apex will select node's roles
215 in the OPNFV cluster in a non-deterministic fashion.
217 \*** disk_device declares which hard disk to use as the root device for
218 installation. The format is a comma delimited list of devices, such as
219 "sda,sdb,sdc". The disk chosen will be the first device in the list which
220 is found by introspection to exist on the system. Currently, only a single
221 definition is allowed for all nodes. Therefore if multiple disk_device
222 definitions occur within the inventory, only the last definition on a node
223 will be used for all nodes.
225 Creating the Settings Files
226 ---------------------------
228 Edit the 2 settings files in /etc/opnfv-apex/. These files have comments to
229 help you customize them.
231 1. deploy_settings.yaml
232 This file includes basic configuration options deployment, and also documents
233 all available options.
234 Alternatively, there are pre-built deploy_settings files available in
235 (``/etc/opnfv-apex/``). These files are named with the naming convention
236 os-sdn_controller-enabled_feature-[no]ha.yaml. These files can be used in
237 place of the (``/etc/opnfv-apex/deploy_settings.yaml``) file if one suites
238 your deployment needs. If a pre-built deploy_settings file is chosen there
239 is no need to customize (``/etc/opnfv-apex/deploy_settings.yaml``). The
240 pre-built file can be used in place of the
241 (``/etc/opnfv-apex/deploy_settings.yaml``) file.
243 2. network_settings.yaml
244 This file provides Apex with the networking information that satisfies the
245 prerequisite `Network Requirements`_. These are specific to your
248 Running ``opnfv-deploy``
249 ------------------------
251 You are now ready to deploy OPNFV using Apex!
252 ``opnfv-deploy`` will use the inventory and settings files to deploy OPNFV.
254 Follow the steps below to execute:
256 1. Execute opnfv-deploy
257 ``sudo opnfv-deploy -n network_settings.yaml
258 -i inventory.yaml -d deploy_settings.yaml``
259 If you need more information about the options that can be passed to
260 opnfv-deploy use ``opnfv-deploy --help``. -n
261 network_settings.yaml allows you to customize your networking topology.
263 2. Wait while deployment is executed.
264 If something goes wrong during this part of the process, start by reviewing
265 your network or the information in your configuration files. It's not
266 uncommon for something small to be overlooked or mis-typed.
267 You will also notice outputs in your shell as the deployment progresses.
269 3. When the deployment is complete the undercloud IP and ovecloud dashboard
270 url will be printed. OPNFV has now been deployed using Apex.
272 .. _`Execution Requirements (Bare Metal Only)`: index.html#execution-requirements-bare-metal-only
273 .. _`Network Requirements`: index.html#network-requirements