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