1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Open Platform for NFV Project, Inc. and its contributors
9 This document describes how to install the Euphrates release of
10 OPNFV when using Fuel as a deployment tool, covering its usage,
11 limitations, dependencies and required system resources.
12 This is an unified documentation for both x86_64 and aarch64
13 architectures. All information is common for both architectures
14 except when explicitly stated.
20 This document provides guidelines on how to install and
21 configure the Euphrates release of OPNFV when using Fuel as a
22 deployment tool, including required software and hardware configurations.
24 Although the available installation options provide a high de.g.ee of
25 freedom in how the system is set up, including architecture, services
26 and features, etc., said permutations may not provide an OPNFV
27 compliant reference architecture. This document provides a
28 step-by-step guide that results in an OPNFV Euphrates compliant
31 The audience of this document is assumed to have good knowledge of
32 networking and Unix/Linux administration.
38 Before starting the installation of the Euphrates release of
39 OPNFV, using Fuel as a deployment tool, some planning must be
45 Prior to installation, a number of deployment specific parameters must be collected, those are:
47 #. Provider sub-net and gateway information
49 #. Provider VLAN information
51 #. Provider DNS addresses
53 #. Provider NTP addresses
55 #. Network overlay you plan to deploy (VLAN, VXLAN, FLAT)
57 #. How many nodes and what roles you want to deploy (Controllers, Storage, Computes)
59 #. Monitoring options you want to deploy (Ceilometer, Syslog, etc.).
61 #. Other options not covered in the document are available in the links above
64 This information will be needed for the configuration procedures
65 provided in this document.
67 =========================================
68 Hardware requirements for virtual deploys
69 =========================================
71 The following minimum hardware requirements must be met for the virtual
72 installation of Euphrates using Fuel:
74 +----------------------------+--------------------------------------------------------+
75 | **HW Aspect** | **Requirement** |
77 +============================+========================================================+
78 | **1 Jumpserver** | A physical node (also called Foundation Node) that |
79 | | hosts a Salt Master VM and each of the VM nodes in |
80 | | the virtual deploy |
81 +----------------------------+--------------------------------------------------------+
82 | **CPU** | Minimum 1 socket with Virtualization support |
83 +----------------------------+--------------------------------------------------------+
84 | **RAM** | Minimum 32GB/server (Depending on VNF work load) |
85 +----------------------------+--------------------------------------------------------+
86 | **Disk** | Minimum 100GB (SSD or SCSI (15krpm) highly recommended |
87 +----------------------------+--------------------------------------------------------+
90 ===========================================
91 Hardware requirements for baremetal deploys
92 ===========================================
94 The following minimum hardware requirements must be met for the baremetal
95 installation of Euphrates using Fuel:
97 +-------------------------+------------------------------------------------------+
98 | **HW Aspect** | **Requirement** |
100 +=========================+======================================================+
101 | **# of nodes** | Minimum 5 |
103 | | - 3 KVM servers which will run all the controller |
106 | | - 2 Compute nodes |
108 +-------------------------+------------------------------------------------------+
109 | **CPU** | Minimum 1 socket with Virtualization support |
110 +-------------------------+------------------------------------------------------+
111 | **RAM** | Minimum 16GB/server (Depending on VNF work load) |
112 +-------------------------+------------------------------------------------------+
113 | **Disk** | Minimum 256GB 10kRPM spinning disks |
114 +-------------------------+------------------------------------------------------+
115 | **Networks** | 4 VLANs (PUBLIC, MGMT, STORAGE, PRIVATE) - can be |
116 | | a mix of tagged/native |
118 | | 1 Un-Tagged VLAN for PXE Boot - ADMIN Network |
120 | | Note: These can be allocated to a single NIC - |
121 | | or spread out over multiple NICs |
122 +-------------------------+------------------------------------------------------+
123 | **1 Jumpserver** | A physical node (also called Foundation Node) that |
124 | | hosts the Salt Master and MaaS VMs |
125 +-------------------------+------------------------------------------------------+
126 | **Power management** | All targets need to have power management tools that |
127 | | allow rebooting the hardware and setting the boot |
128 | | order (e.g. IPMI) |
129 +-------------------------+------------------------------------------------------+
131 **NOTE:** All nodes including the Jumpserver must have the same architecture (either x86_64 or aarch64).
133 **NOTE:** For aarch64 deployments an UEFI compatible firmware with PXE support is needed (e.g. EDK2).
136 ===============================
137 Help with Hardware Requirements
138 ===============================
140 Calculate hardware requirements:
142 For information on compatible hardware types available for use, please see `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_.
144 When choosing the hardware on which you will deploy your OpenStack
145 environment, you should think about:
147 - CPU -- Consider the number of virtual machines that you plan to deploy in your cloud environment and the CPUs per virtual machine.
149 - Memory -- Depends on the amount of RAM assigned per virtual machine and the controller node.
151 - Storage -- Depends on the local drive space per virtual machine, remote volumes that can be attached to a virtual machine, and object storage.
153 - Networking -- Depends on the Choose Network Topology, the network bandwidth per virtual machine, and network storage.
155 ================================================
156 Top of the rack (TOR) Configuration requirements
157 ================================================
159 The switching infrastructure provides connectivity for the OPNFV
160 infrastructure operations, tenant networks (East/West) and provider
161 connectivity (North/South); it also provides needed connectivity for
162 the Storage Area Network (SAN).
163 To avoid traffic congestion, it is strongly suggested that three
164 physically separated networks are used, that is: 1 physical network
165 for administration and control, one physical network for tenant private
166 and public networks, and one physical network for SAN.
167 The switching connectivity can (but does not need to) be fully redundant,
168 in such case it comprises a redundant 10GE switch pair for each of the
169 three physically separated networks.
171 The physical TOR switches are **not** automatically configured from
172 the Fuel OPNFV reference platform. All the networks involved in the OPNFV
173 infrastructure as well as the provider networks and the private tenant
174 VLANs needs to be manually configured.
176 Manual configuration of the Euphrates hardware platform should
177 be carried out according to the `OPNFV Pharos Specification
178 <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_.
180 ==========================================
181 OPNFV Software installation and deployment
182 ==========================================
184 This section describes the process of installing all the components needed to
185 deploy the full OPNFV reference platform stack across a server cluster.
187 The installation is done with Mirantis Cloud Platform (MCP), which is based on
188 a reclass model. This model provides the formula inputs to Salt, to make the deploy
189 automatic based on deployment scenario.
190 The reclass model covers:
192 - Infrastucture node definition: Salt Master node (cfg01) and MaaS node (mas01)
193 - Openstack node defition: Controler nodes (ctl01, ctl02, ctl03) and Compute nodes (cmp001, cmp002)
194 - Infrastructure components to install (software packages, services etc.)
195 - Openstack components and services (rabbitmq, galera etc.), as well as all configuration for them
198 Automatic Installation of a Virtual POD
199 =======================================
201 For virtual deploys all the targets are VMs on the Jumpserver. The deploy script will:
203 - Create a Salt Master VM on the Jumpserver which will drive the installation
204 - Create the bridges for networking with virsh (only if a real bridge does not already exists for a given network)
205 - Install Openstack on the targets
206 - Leverage Salt to install & configure Openstack services
209 Automatic Installation of a Baremetal POD
210 =========================================
212 The baremetal installation process can be done by editing the information about
213 hardware and enviroment in the reclass files, or by using a Pod Descriptor File (PDF).
214 This file contains all the information about the hardware and network of the deployment
215 the will be fed to the reclass model during deployment.
217 The installation is done automatically with the deploy script, which will:
219 - Create a Salt Master VM on the Jumpserver which will drive the installation
220 - Create a MaaS Node VM on the Jumpserver which will provision the targets
221 - Install Openstack on the targets
222 - Leverage MaaS to provision baremetal nodes with the operating system
223 - Leverage Salt to configure the operatign system on the baremetal nodes
224 - Leverage Salt to install & configure Openstack services
227 Steps to start the automatic deploy
228 ===================================
230 These steps are common both for virtual and baremetal deploys.
232 #. Clone the Fuel code from gerrit
238 $ git clone https://git.opnfv.org/fuel
245 $ git clone https://git.opnfv.org/armband
248 #. Checkout the Euphrates release
252 $ git checkout opnfv-5.0.2
254 #. Start the deploy script
258 $ ci/deploy.sh -l <lab_name> \
260 -b <URI to the PDF file> \
262 -B <list of admin, public and management bridges>
270 $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
273 -s os-nosdn-nofeature-noha
277 A x86 deploy on pod1 from Ericsson lab
281 $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
284 -s os-nosdn-nofeature-ha \
287 An aarch64 deploy on pod5 from Arm lab
291 $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
294 -s os-nosdn-nofeature-ha \
302 Please refer to the :ref:`Release Notes <fuel-release-notes-label>` article.
310 1) `OPNFV Home Page <http://www.opnfv.org>`_
311 2) `OPNFV documentation <http://docs.opnfv.org>`_
312 3) `Software downloads <https://www.opnfv.org/software/download>`_
316 4) `OpenStack Ocata Release Artifacts <http://www.openstack.org/software/ocata>`_
317 5) `OpenStack Documentation <http://docs.openstack.org>`_
321 6) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
325 7) `Mirantis Cloud Platform Documentation <https://docs.mirantis.com/mcp/latest>`_
329 8) `Saltstack Documentation <https://docs.saltstack.com/en/latest/topics>`_
330 9) `Saltstack Formulas <http://salt-formulas.readthedocs.io/en/latest/develop/overview-reclass.html>`_
334 10) `Reclass model <http://reclass.pantsfullofunix.net>`_