1 .. This document is protected/licensed under the following conditions
2 .. (c) Jonas Bjurel (Ericsson AB)
3 .. Licensed under a Creative Commons Attribution 4.0 International License.
4 .. You should have received a copy of the license along with this work.
5 .. If not, see <http://creativecommons.org/licenses/by/4.0/>.
9 This section provides guidelines on how to install and
10 configure the Brahmaputra release of OPNFV when using Fuel as a
11 deployment tool including required software and hardware
14 For detailed instructions on how to install the Brahmaputra release using
15 Fuel, see *Reference 13* in section *"Fuel associated references"* below.
17 Pre-configuration activities
18 ----------------------------
20 Planning the deployment
22 Before starting the installation of the Brahmaputra release of
23 OPNFV when using Fuel as a deployment tool, some planning must be
26 Familiarize yourself with the Fuel by reading the
29 - Fuel planning guide, please see *Reference: 8* in section *"Fuel associated references"* below.
31 - Fuel user guide, please see *Reference: 9* in section *"Fuel associated references"* below.
33 - Fuel operations guide, please see *Reference: 10* in section *"Fuel associated references"* below.
35 - Fuel Plugin Developers Guide, please see *Reference: 11* in section *"Fuel associated references"* below.
37 Before the installation can start, a number of deployment specific parameters must be collected, those are:
39 #. Provider sub-net and gateway information
41 #. Provider VLAN information
43 #. Provider DNS addresses
45 #. Provider NTP addresses
47 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
49 #. Monitoring Options you want to deploy (Ceilometer, Syslog, etc.)
51 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
53 #. Other options not covered in the document are available in the links above
56 Retrieving the ISO image
57 ^^^^^^^^^^^^^^^^^^^^^^^^
58 First of all, the Fuel deployment ISO image needs to be retrieved, the
59 Fuel .iso image of the Brahmaputra release can be found at *Reference: 2*
61 Alternatively, you may build the .iso from source by cloning the
62 opnfv/fuel git repository. Detailed instructions on how to build
63 a Fuel OPNFV .iso can be found in *Reference: 14* at section *"Fuel associated references"* below.
67 Following high level hardware requirements must be met:
69 +--------------------+------------------------------------------------------+
70 | **HW Aspect** | **Requirement** |
72 +====================+======================================================+
73 | **# of nodes** | Minimum 5 (3 for non redundant deployment): |
75 | | - 1 Fuel deployment master (may be virtualized) |
77 | | - 3(1) Controllers (1 colocated mongo/ceilometer |
78 | | role, 2 Ceph-OSD roles) |
80 | | - 1 Compute (1 co-located Ceph-OSD role) |
82 +--------------------+------------------------------------------------------+
83 | **CPU** | Minimum 1 socket x86_AMD64 with Virtualization |
85 +--------------------+------------------------------------------------------+
86 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
88 +--------------------+------------------------------------------------------+
89 | **Disk** | Minimum 256GB 10kRPM spinning disks |
91 +--------------------+------------------------------------------------------+
92 | **Networks** | 4 Tagged VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) |
94 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
96 | | note: These can be run on single NIC - or spread out |
97 | | over other nics as your hardware supports |
98 +--------------------+------------------------------------------------------+
100 For information on compatible hardware types available for use, please see
101 *Reference: 11* in section *"Fuel associated references"* below.
103 Top of the rack (TOR) Configuration requirements
104 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
105 The switching infrastructure provides connectivity for the OPNFV
106 infrastructure operations, tenant networks (East/West) and provider
107 connectivity (North/South); it also provides needed
108 connectivity for the Storage Area Network (SAN). To avoid traffic
109 congestion, it is strongly suggested that three physically separated
110 networks are used, that is: 1 physical network for administration and
111 control, one physical network for tenant private and public networks,
112 and one physical network for SAN. The switching connectivity can (but
113 does not need to) be fully redundant, in such case it and comprises a
114 redundant 10GE switch pair for each of the three physically separated
117 The physical TOR switches are **not** automatically configured from
118 the OPNFV reference platform. All the networks involved in the OPNFV
119 infrastructure as well as the provider networks and the private tenant
120 VLANs needs to be manually configured.
122 Jumphost configuration
123 ----------------------
124 The Jumphost server, also known as the "Fuel master" provides needed
125 services/functions to deploy an OPNFV/OpenStack cluster as well functions
126 for cluster life-cycle management (extensions, repair actions and upgrades).
128 The Jumphost server requires 2 (4 if redundancy is required) Ethernet
129 interfaces - one for external management of the OPNFV installation,
130 and another for jump-host communication with the OPNFV cluster.
132 Install the Fuel jump-host
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^
134 Mount the Fuel Brahmaputra ISO file as a boot device to the jump host
135 server, reboot it, and install the Fuel Jumphost in accordance with installation instructions, see *Reference 13* in section *"Fuel associated references"*
139 Platform components configuration
140 ---------------------------------
144 Fuel plugins enable you to install and configure additional capabilities for
145 your Fuel OPNFV based cloud, such as additional storage types, networking
146 functionality, or NFV features developed by OPNFV.
148 Fuel offers an open source framework for creating these plugins, so there’s
149 a wide range of capabilities that you can enable Fuel to add to your OpenStack
152 The OPNFV Brahmaputra version of Fuel provides a set of pre-packaged plugins
155 +--------------------+------------------------------------------------------+
156 | **Plugin name** | **Short description** |
158 +====================+======================================================+
159 | OpenDaylight | OpenDaylight provides an open-source SDN Controller |
160 | | providing networking features such as L2 and L3 |
161 | | network control, "Service Function Chaining", |
162 | | routing, networking policies, etc. |
163 | | More information on OpenDaylight in the OPNFV |
164 | | Brahmaputra release can be found in a separate |
165 | | section in this document. |
166 +--------------------+------------------------------------------------------+
167 | ONOS | ONOS is another open-source SDN controller which |
168 | | in essense fill the same role as OpenDaylight. |
169 | | More information on ONOS in the OPNFV |
170 | | Brahmaputra release can be found in a separate |
171 | | section in this document. |
173 +--------------------+------------------------------------------------------+
174 | BGP-VPN | BGP-VPN provides an BGP/MPLS VPN service |
175 | | More information on BGP-VPN in the OPNFV |
176 | | Brahmaputra release can be found in a separate |
177 | | section in this document. |
179 +--------------------+------------------------------------------------------+
180 | OVS-NSH | OVS-NSH provides a variant of Open-vSwitch |
181 | | which supports "Network Service Headers" needed |
182 | | for the "Service function chaining" feature |
183 | | More information on "Service Function Chaining" |
184 | | in the OPNFV Brahmaputra release can be found in a |
185 | | in a separate section in this document. |
187 +--------------------+------------------------------------------------------+
188 | OVS-NFV | OVS-NFV provides a variant of Open-vSwitch |
189 | | with carrier grade characteristics essential for |
191 | | More information on OVS-NFV |
192 | | in the OPNFV Brahmaputra release can be found in a |
193 | | in a separate section in this document. |
195 +--------------------+------------------------------------------------------+
196 | KVM-NFV | KVM-NFV provides a variant of KVM with improved |
197 | | virtualization characteristics essential for NFV |
199 | | More information on KVM-NFV |
200 | | in the OPNFV Brahmaputra release can be found in a |
201 | | in a separate section in this document. |
203 +--------------------+------------------------------------------------------+
204 | VSPERF | VSPERF provides a networking characteristics test |
205 | | bench that facilitates characteristics/performance |
206 | | evaluation of vSwithches |
207 | | More information on VSPERF |
208 | | in the OPNFV Brahmaputra release can be found in a |
209 | | in a separate section in this document. |
211 +--------------------+------------------------------------------------------+
213 *Additional third-party plugins can be found here:*
214 *https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/*
215 **Note: Plugins are not necessarilly compatible with each other, see section
216 "Configuration options, OPNFV scenarios" for compatibility information**
218 The plugins come prepackaged, ready to install. To do so follow the
219 installation instructions provided in *Reference 13* provided in section
220 *"Fuel associated references"* below.
224 A Fuel environment is an OpenStack instance managed by Fuel,
225 one Fuel instance can manage several OpenStack instances/environments
226 with different configurations, etc.
228 To create a Fuel instance, follow the instructions provided in the installation
229 instructions, see *Reference 13* in section *"Fuel associated references"* below.
231 Provisioning of aditional features and services
232 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
233 Although the plugins have already previously been installed,
234 they are not per default enabled for the environment we just created.
235 The plugins of your choice need to be enabled and configured.
237 To enable a plugin, follow the installation instructions found in
238 *Reference 13*, provided in section *"Fuel associated references"* below.
240 For configuration of the plugins, please see section "Feature Configuration".
244 All the networking aspects need to be configured in terms of:
249 - User network segmentation (VLAN/VXLAN)
254 For guidelines on how to configure networking, please refer to the
255 installation instructions found in *Reference 13* provided in section
256 *"Fuel associated references"* below.
260 Now, it is time to allocate the nodes in your OPNFV cluster to OpenStack-,
261 SDN-, and other feature/service roles. Some roles may require redundancy,
262 while others don't; Some roles may be co-located with other roles, while
263 others may not. The Fuel GUI will guide you in the allocation of roles and
264 will not permit you to perform invalid allocations.
266 For detailed guide-lines on node allocation, please refer to the installation instructions found in *Reference 13*, provided in section *"Fuel associated references"* below.
270 The OPNFV Brahmaputra version of Fuel can be deployed using on-line upstream
271 repositories (default) or off-line using built-in local repositories on the
272 Fuel jump-start server.
274 For instructions on how to configure Fuel for off-line deployment, please
275 refer to the installation instructions found in, *Reference 13*, provided
276 in section *"Fuel associated references"* below.
280 You should now be ready to deploy your OPNFV Brahmaputra environment - but before doing so you may want to verify your network settings.
282 For further details on network verification and deployment, please refer to
283 the installation instructions found in, *Reference 13*, provided in section
284 *"Fuel associated references"* below.
286 Fuel associated references
287 --------------------------
292 1) `OPNFV Home Page <www.opnfv.org>`_
294 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
299 3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
301 4) `OpenStack documentation <http://docs.openstack.org>`_
306 5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
311 6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
313 7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-7.0/#guides>`_
315 8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_
317 9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
319 10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>`_
321 11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
323 12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
328 13) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
330 14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
332 15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool