1 ========================================================================================================
2 OPNFV Installation instructions for the Bramaputra release of OPNFV when using Apex as a deployment tool
3 ========================================================================================================
6 .. contents:: Table of Contents
13 This document describes how to install the Bramaputra release of OPNFV when
14 using Apex as a deployment tool covering it's limitations, dependencies
15 and required system resources.
19 Bramaputra release of OPNFV when using Apex as a deployment tool Docs
20 (c) by Tim Rozet (Red Hat) and Dan Radez (Red Hat)
22 Bramaputra release of OPNFV when using Apex as a deployment tool Docs
23 are licensed under a Creative Commons Attribution 4.0 International License.
24 You should have received a copy of the license along with this.
25 If not, see <http://creativecommons.org/licenses/by/4.0/>.
30 +--------------------+--------------------+--------------------+---------------------------+
31 | **Date** | **Ver.** | **Author** | **Comment** |
33 +--------------------+--------------------+--------------------+---------------------------+
34 | 2015-09-17 | 1.0.0 | Dan Radez | Rewritten for |
35 | | | (Red Hat) | Apex/RDO Manager support |
36 +--------------------+--------------------+--------------------+---------------------------+
37 | 2015-06-03 | 0.0.4 | Ildiko Vancsa | Minor changes |
39 +--------------------+--------------------+--------------------+---------------------------+
40 | 2015-06-02 | 0.0.3 | Christopher Price | Minor changes & |
41 | | | (Ericsson AB) | formatting |
42 +--------------------+--------------------+--------------------+---------------------------+
43 | 2015-05-27 | 0.0.2 | Christopher Price | Minor changes & |
44 | | | (Ericsson AB) | formatting |
45 +--------------------+--------------------+--------------------+---------------------------+
46 | 2015-05-07 | 0.0.1 | Tim Rozet | First draft |
48 +--------------------+--------------------+--------------------+---------------------------+
54 This document describes the steps to install an OPNFV Bramaputra reference
55 platform, as defined by the Genesis Project using the Apex installer.
57 The audience is assumed to have a good background in networking
58 and Linux administration.
63 Apex uses the RDO Manager Open Source project as a server provisioning tool.
64 RDO Manager is the RDO Project implimentation of OpenStack's Triple-O project.
65 The Triple-O image based life cycle installation tool provisions an OPNFV
66 Target System (3 controllers, n number of compute nodes) with OPNFV specific
67 configuration provided by the Apex deployment tool chain.
69 The Apex deployment artifacts contain the necessary tools to deploy and
70 configure an OPNFV target system using the Apex deployment toolchain.
71 These artifacts offer the choice of using the Apex bootable ISO
72 (``bramaputra.2016.1.0.apex.iso``) to both install CentOS 7 and the
73 nessesary materials to deploy or the Apex RPM (``opnfv-apex.rpm``)
74 which expects installation to a CentOS 7 libvirt enabled host. The RPM
75 contains a collection of configuration file, prebuilt disk images,
76 and the automatic deployment script (``opnfv-deploy``).
78 An OPNFV install requires a "Jumphost" in order to operate. The bootable
79 ISO will allow you to install a customized CentOS 7 release to the Jumphost,
80 which includes the required packages needed to run ``opnfv-deploy``.
81 If you already have a Jumphost with CentOS 7 installed, you may choose to
82 skip the ISO step and simply install the (``opnfv-apex.rpm``) RPM. The RPM
83 is the same RPM included in the ISO and includes all the necessary disk
84 images and configuration files to execute an OPNFV deployment. Either method
85 will prepare a host to the same ready state for OPNFV deployment.
87 ``opnfv-deploy`` instantiates an RDO Manager Instack VM server using libvirt
88 as its provider. This VM is then configured and used to provision the
89 OPNFV target deployment (3 controllers, n compute nodes). These nodes can
90 be either virtual or bare metal. This guide contains instructions for
91 installing either method.
93 Triple-O Deployment Architecture
94 ================================
96 Apex is based on RDO Manager which is the RDO Project's implementation of
97 the OpenStack Triple-O project. It is important to understand the basics
98 of a Triple-O deployment to help make decisions that will assist in
99 successfully deploying OPNFV.
101 Triple-O stands for OpenStack On OpenStack. This means that OpenStack
102 will be used to install OpenStack. The target OPNFV deployment is an
103 OpenStack cloud with NFV features built-in that will be deployed by a
104 smaller all-in-one deployment of OpenStack. In this deployment
105 methodology there are two OpenStack installations. They are referred
106 to as the undercloud and the overcloud. The undercloud is used to
107 deploy the overcloud.
109 The undercloud is the all-in-one installation of OpenStack that includes
110 baremetal provisioning. RDO Manager's deployment of the undercloud is
111 call Instack. Instack will be deployed as a virtual machine on a jumphost.
112 This VM is pre-built and distributed as part of the Apex RPM.
114 The overcloud is OPNFV. Configuration will be passed into Instack and
115 Instack will use OpenStack's orchestration component call Heat to
116 execute a deployment will provision the target nodes to become OPNFV.
123 Jumphost Requirements
124 ---------------------
126 The Jumphost requirements are outlined below:
128 1. CentOS 7 (from ISO or self-installed).
132 3. libvirt virtualization support.
134 4. minimum 2 networks and maximum 6 networks, multiple NIC and/or VLAN combinations are supported. This is virtualized for a VM
137 5. The Bramaputra Apex RPM.
139 6. 16 GB of RAM for a bare metal deployment, 56 GB of RAM for a VM deployment.
144 Network requirements include:
146 1. No DHCP or TFTP server running on networks used by OPNFV.
148 2. 2-6 separate networks with connectivity between Jumphost and nodes.
150 - Control Plane Network (Provisioning)
152 - Private / Internal Network*
158 3. Lights out OOB network access from Jumphost with IPMI node enabled (bare metal deployment only).
160 4. Admin or public network has Internet access, meaning a gateway and DNS availability.
162 | `*` *These networks can be combined with each other or all combined on the Control Plane network.*
163 | `*` *Non-External networks will be consolidated to the Control Plane network if not specifically configured.*
165 Bare Metal Node Requirements
166 ----------------------------
168 Bare metal nodes require:
170 1. IPMI enabled on OOB interface for power control.
172 2. BIOS boot priority should be PXE first then local hard disk.
174 3. BIOS PXE interface should include Control Plane network mentioned above.
176 Execution Requirements (Bare Metal Only)
177 ----------------------------------------
179 In order to execute a deployment, one must gather the following information:
181 1. IPMI IP addresses for the nodes.
183 2. IPMI login information for the nodes (user/pass).
185 3. MAC address of Control Plane / Provisioning interfaces of the overcloud nodes.
188 Installation High-Level Overview - Bare Metal Deployment
189 ========================================================
191 The setup presumes that you have 6 bare metal servers and have already setup network
192 connectivity on at least 2 interfaces for all servers via a TOR switch or other
193 network implementation.
195 The physical TOR switches are **not** automatically configured from the OPNFV reference
196 platform. All the networks involved in the OPNFV infrastructure as well as the provider
197 networks and the private tenant VLANs needs to be manually configured.
199 The Jumphost can be installed using the bootable ISO or by other means including the
200 (``opnfv-apex``) RPM and virtualization capabilities. The Jumphost should then be
201 configured with an IP gateway on its admin or public interface and configured with a
202 working DNS server. The Jumphost should also have routable access to the lights out network.
204 ``opnfv-deploy`` is then executed in order to deploy the Instack VM. ``opnfv-deploy`` uses
205 two configuration files in order to know how to install and provision the OPNFV target system.
206 The information gathered under section `Execution Requirements (Bare Metal Only)`_ is put
207 into the JSON file (``instackenv.json``) configuration file. Networking definitions gathered
208 under section `Network Requirements`_ are put into the JSON file
209 (``network-environment.yaml``). ``opnfv-deploy`` will boot the Instack VM and load the target
210 deployment configuration into the provisioning toolchain. This includes MAC address, IPMI,
211 Networking Environment and OPNFV deployment options.
213 Once configuration is loaded and Instack is configured it will then reboot the nodes via IPMI.
214 The nodes should already be set to PXE boot first off the admin interface. The nodes will
215 first PXE off of the Instack PXE server and go through a discovery/introspection process.
217 Introspection boots off of custom introspection PXE images. These images are designed to look
218 at the properties of the hardware that is booting off of them and report the properties of
219 it back to the Instack node.
221 After introspection Instack will execute a Heat Stack Deployment to being node provisioning
222 and configuration. The nodes will reboot and PXE again off the Instack PXE server to
223 provision each node using the Glance disk images provided by Instack. These disk images
224 include all the necessary packages and configuration for an OPNFV deployment to execute.
225 Once the node's disk images have been written to disk the nodes will boot off the newly written
226 disks and execute cloud-init which will execute the final node configuration. This
227 configuration is largly completed by executing a puppet apply on each node.
229 Installation High-Level Overview - VM Deployment
230 ================================================
232 The VM nodes deployment operates almost the same way as the bare metal deployment with a
233 few differences. ``opnfv-deploy`` still deploys an Instack VM. In addition to the Instack VM
234 a collection of VMs (3 control nodes + 2 compute for an HA deployment or 1 control node and
235 1 compute node for a Non-HA Deployment) will be defined for the target OPNFV deployment.
236 The part of the toolchain that executes IPMI power instructions calls into libvirt instead of
237 the IPMI interfaces on baremetal servers to operate the power managment. These VMs are then
238 provisioned with the same disk images and configuration that baremetal would be.
240 To RDO Manager these nodes look like they have just built and registered the same way as
241 bare metal nodes, the main difference is the use of a libvirt driver for the power management.
243 Installation Guide - Bare Metal Deployment
244 ==========================================
246 **WARNING: Baremetal documentation is not complete. WARNING: The main missing instructions are r elated to bridging
247 the networking for the undercloud to the physical underlay network for the overcloud to be deployed to.**
249 This section goes step-by-step on how to correctly install and provision the OPNFV target
250 system to bare metal nodes.
252 Install Bare Metal Jumphost
253 ---------------------------
255 1a. If your Jumphost does not have CentOS 7 already on it, or you would like to do a fresh
256 install, then download the Apex bootable ISO from OPNFV artifacts <http://artifacts.opnfv.org/>.
258 1b. If your Jump host already has CentOS 7 with libvirt running on it then install the
259 opnfv-apex RPM from OPNFV artifacts <http://artifacts.opnfv.org/>.
261 2a. Boot the ISO off of a USB or other installation media and walk through installing OPNFV CentOS 7.
262 The ISO comes prepared to be written directly to a USB drive with dd as such:
264 ``dd if=opnfv-apex.iso of=/dev/sdX bs=4M``
266 Replace /dev/sdX with the device assigned to your usb drive. Then select the USB device as the
267 boot media on your Jumphost
269 2b. Install the RDO Release RPM and the opnfv-apex RPM:
271 ``sudo yum install -y https://www.rdoproject.org/repos/rdo-release.rpm opnfv-apex-{version}.rpm``
273 The RDO Project release repository is needed to install OpenVSwitch, which is a dependency of
274 opnfv-apex. If you do not have external connectivity to use this repository you need to download
275 the OpenVSwitch RPM from the RDO Project repositories and install it with the opnfv-apex RPM.
277 3. After the operating system and the opnfv-apex RPM are installed, login to your Jumphost as root.
279 4. Configure IP addresses on the interfaces that you have selected as your networks.
281 5. Configure the IP gateway to the Internet either, preferably on the public interface.
283 6. Configure your ``/etc/resolv.conf`` to point to a DNS server (8.8.8.8 is provided by Google).
285 Creating a Node Inventory File
286 ------------------------------
288 IPMI configuration information gathered in section `Execution Requirements (Bare Metal Only)`_ needs to be added to the ``instackenv.json`` file.
290 1. Make a copy of ``/var/opt/opnfv/instackenv.json.example`` into root's home directory: ``/root/instackenv.json``
292 2. Edit the file in your favorite editor.
294 3. The nodes dictionary contains a definition block for each baremetal host that will be deployed. 1 or more compute nodes and 3 controller nodes are required. (The example file contains blocks for each of these already). It is optional at this point to add more compute nodes into the dictionary.
296 4. Edit the following values for each node:
298 - ``pm_type``: Power Management driver to use for the node
299 - ``pm_addr``: IPMI IP Address
300 - ``pm_user``: IPMI username
301 - ``pm_password``: IPMI password
302 - ``capabilities``: Intended node role (profile:control or profile:compute)
303 - ``cpu``: CPU cores available
304 - ``memory``: Memory available in Mib
305 - ``disk``: Disk space available in Gb
306 - ``arch``: System architecture
307 - ``mac``: MAC of the interface that will PXE boot from Instack
309 5. Save your changes.
311 Creating a Network Environment File
312 -----------------------------------
314 Network environment information gathered in section `Network Requirements`_ needs to be added to the ``network-environment.yaml`` file.
316 1. Make a copy of ``/var/opt/opnfv/network-environment.yaml`` into root's home directory: ``/root/network-environment.yaml``
318 2. Edit the file in your favorite editor.
320 3. Update the information (TODO: More Cowbell please!)
322 Running ``opnfv-deploy``
323 ------------------------
325 You are now ready to deploy OPNFV! ``opnfv-deploy`` will use the instackenv.json and network-environment.yaml to deploy OPNFV.
326 The names of these files are important. ``opnfv-deploy`` will look for ``instackenv.json`` and
327 ``network-environment.yaml`` in the present working directory when it is run.
329 Follow the steps below to execute:
331 1. execute ``opnfv-deploy -i /path/to/instackenv.json -n /path/to/network-environment.yaml``
333 2. It will take about approximately 30 minutes to stand up instack, configure the deployment and execute the deployment. If something goes wrong during this part of the process, it is most likely a problem with the setup of your network or the information in your configuration files. You will also notice different outputs in your shell.
335 3. The message "Overcloud Deployed" will display when When the deployment is complete. Just above this message there
336 will be a URL that ends in port http://<host>:5000. This url is also the endpoint for the OPNFV Horizon Dashboard
337 if connected to on port 80.
342 Once the deployment has finished, the OPNFV deployment can be accessed via the Instack node. From
343 the jump host ssh to the instack host and become the stack user. Alternativly ssh keys have been
344 setup such that the root user on the jump host can ssh to Instack directly as the stack user.
346 | ``ssh root@192.0.2.1``
349 Once connected to Instack as the stack user look for two keystone files that can be used to
350 interact with the undercloud and the overcloud. Source the appropriate RC file to interact with
351 the respective OpenStack deployment.
353 | ``source stackrc`` (undercloud / Instack)
354 | ``source overcloudrc`` (overcloud / OPNFV)
356 The contents of these files include the credentials for the administrative user for Instack and
357 OPNFV respectivly. At this point both Instack and OPNFV can be interacted with just as any
358 OpenStack installation can be. Start by listing the nodes in the undercloud that were used
359 to deploy the overcloud.
362 | ``openstack server list``
364 The control and compute nodes will be listed in the output of this server list command. The IP
365 addresses that are listed are the control plane addresses that were used to provision the nodes.
366 Use these IP addresses to connect to these nodes. Initial authentication requires using the
369 | ``ssh heat-admin@192.0.2.7``
371 To begin creating users, images, networks, servers, etc in OPNFV source the overcloudrc file or
372 retrieve the admin user's credentials from the overcloudrc file and connect to the web Dashboard.
375 You are now able to follow the `OpenStack Verification`_ section.
377 OpenStack Verification
378 ----------------------
380 Once connected to the OPNFV Dashboard make sure the OPNFV target system is working correctly:
382 1. In the left pane, click Compute -> Images, click Create Image.
384 2. Insert a name "cirros", Insert an Image Location ``http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img``.
386 3. Select format "QCOW2", select Public, then click Create Image.
388 4. Now click Project -> Network -> Networks, click Create Network.
390 5. Enter a name "internal", click Next.
392 6. Enter a subnet name "internal_subnet", and enter Network Address ``172.16.1.0/24``, click Next.
394 7. Now go to Project -> Compute -> Instances, click Launch Instance.
396 8. Enter Instance Name "first_instance", select Instance Boot Source "Boot from image", and then select Image Name "cirros".
398 9. Click Launch, status will cycle though a couple states before becoming "Active".
400 10. Steps 7 though 9 can be repeated to launch more instances.
402 11. Once an instance becomes "Active" their IP addresses will display on the Instances page.
404 12. Click the name of an instance, then the "Console" tab and login as "cirros"/"cubswin:)"
406 13. To verify storage is working, click Project -> Compute -> Volumes, Create Volume
408 14. Give the volume a name and a size of 1 GB
410 15. Once the volume becomes "Available" click the dropdown arrow and attach it to an instance.
412 Congratulations you have successfully installed OPNFV!
414 Installation Guide - VM Deployment
415 ==================================
417 This section goes step-by-step on how to correctly install and provision the OPNFV target system to VM nodes.
422 Follow the instructions in the `Install Bare Metal Jumphost`_ section.
424 Running ``opnfv-deploy``
425 ------------------------
427 You are now ready to deploy OPNFV! ``opnfv-deploy`` has virtual deployment capability that includes all of the configuration nessesary to deploy OPNFV with no modifications.
429 If no modifications are made to the included configurations the target environment will deploy with the following architecture:
433 - The option of 3 control and 2 compute VMs (HA Deploy / default) or 1 control and 1 compute VM (Non-HA deploy / pass -n)
435 - 2 networks, one for provisioning, internal API, storage and tenant networking traffic and a second for the external network
437 Follow the steps below to execute:
439 1. ``opnfv-deploy --virtual [ --no-ha ]``
441 2. It will take approximately 30 minutes to stand up instack, define the target virtual machines, configure the deployment and execute the deployment. You will notice different outputs in your shell.
443 3. When the deployment is complete you will see "Overcloud Deployed"
445 Verifying the Setup - VMs
446 -------------------------
448 To verify the set you can follow the instructions in the `Verifying the Setup`_ section.
450 Before you get started following these instructions you will need to add IP addresses on the networks that have been
451 created for the External and provisioning networks. By default the External network is 192.168.37.0/24 and the
452 provisioning network is 192.0.2.0/24. To access these networks simply add an IP to brbm and brbm1 and set their link to
453 up. This will provide a route from the hypervisor into the virtual networks acting as OpenStack's underlay network in
454 the virtual deployment.
456 | ``ip addr add 192.0.2.252/24 dev brbm``
457 | ``ip link set up dev brbm``
458 | ``ip addr add 192.168.37.252/24 dev brbm1``
459 | ``ip link set up dev brbm1``
461 Once these IP addresses are assigned and the links are up the gateways on the overcloud's networks should be pingable
462 and read to be SSHed to.
465 | ``ping 192.168.37.1``
467 Now continue with the `Verifying the Setup`_ section.
469 OpenStack Verification - VMs
470 ----------------------------
472 Follow the steps in `OpenStack Verification`_ section.
474 Frequently Asked Questions
475 ==========================
480 All Apex and "common" entities are protected by the `Apache 2.0 License <http://www.apache.org/licenses/>`_.
488 `OPNFV Home Page <www.opnfv.org>`_
490 `OPNFV Genesis project page <https://wiki.opnfv.org/get_started>`_
492 `OPNFV Apex project page <https://wiki.opnfv.org/apex>`_
497 `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
499 `OpenStack documentation <http://docs.openstack.org>`_
504 Upstream OpenDaylight provides `a number of packaging and deployment options <https://wiki.opendaylight.org/view/Deployment>`_ meant for consumption by downstream projects like OPNFV.
506 Currently, OPNFV Apex uses `OpenDaylight's Puppet module <https://github.com/dfarrell07/puppet-opendaylight>`_, which in turn depends on `OpenDaylight's RPM <http://cbs.centos.org/repos/nfv7-opendaylight-3-candidate/x86_64/os/Packages/opendaylight-3.0.0-2.el7.noarch.rpm>`_.
511 `RDO Manager website <https://www.rdoproject.org/rdo-manager>`_
513 :Authors: Tim Rozet (trozet@redhat.com)
514 :Authors: Dan Radez (dradez@redhat.com)
517 **Documentation tracking**