fuel/docs/src/installation-instructions.rst

   1 :Authors: Jonas Bjurel (Ericsson AB)
   2 :Version: 0.0.3
   3
   4 ==================================================================================================
   5 OPNFV Installation instructions for the Arno release of OPNFV when using Fuel as a deployment tool
   6 ==================================================================================================
   7
   8 Abstract
   9 ========
  10
  11 This document describes how to install the Arno release of OPNFV when using Fuel as a deployment tool covering it's limitations, dependencies and required system resources.
  12
  13 License
  14 =======
  15 Arno release of OPNFV when using Fuel as a deployment tool Docs (c) by Jonas Bjurel (Ericsson AB)
  16
  17 Arno release of OPNFV when using Fuel as a deployment tool Docs are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>.
  18
  19
  20 **Contents**
  21
  22 1   Version history
  23
  24 2   Introduction
  25
  26 3   Preface
  27
  28 4   Hardware requirements
  29
  30 5   Top of the rack (TOR) Configuration requirements
  31
  32 6   OPNFV Software installation and deployment
  33
  34 7   Installation health-check
  35
  36 8   Post installation and deployment actions
  37
  38 9   References
  39
  40 1   Version history
  41 ===================
  42
  43 +--------------------+--------------------+--------------------+--------------------+
  44 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  45 |                    |                    |                    |                    |
  46 +--------------------+--------------------+--------------------+--------------------+
  47 | 2015-04-15         | 0.0.1              | Jonas Bjurel       | First draft        |
  48 |                    |                    | (Ericsson AB)      |                    |
  49 +--------------------+--------------------+--------------------+--------------------+
  50 | 2015-04-23         | 0.0.2              | Jonas Bjurel       | Minor changes      |
  51 |                    |                    | (Ericsson AB)      |                    |
  52 +--------------------+--------------------+--------------------+--------------------+
  53 | 2015-05-16         | 0.0.3              | Christopher Price  | Minor changes      |
  54 |                    |                    | (Ericsson AB)      |                    |
  55 +--------------------+--------------------+--------------------+--------------------+
  56
  57
  58 2   Introduction
  59 ================
  60
  61 This document describes the supported software and hardware configurations for the Arno release of OPNFV when using Fuel as a deployment tool as well as providing guidelines on how to install and configure such reference system.
  62
  63 Although the available installation options gives a high degree of freedom in how the system is set-up, with what architecture, services and features, etc., not nearly all of those permutations provides a OPNFV compliant reference architecture. Following the guidelines in this document ensures a result that is OPNFV R1 (Arno) compliant.
  64
  65 The audience of this document is assumed to have good knowledge in networking and Unix/Linux administration.
  66
  67 3   Preface
  68 ===========
  69
  70 Before starting the installation of Arno release of OPNFV when using Fuel as a deployment tool, some planning must preceed.
  71
  72 First of all, the Fuel@OPNFV .iso image needs to be retrieved, the Latest stable Arno release of OPNFV when using Fuel as a deployment tool can be found here: <www.opnfv.org/abc/def>
  73
  74 Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository:
  75
  76 <git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis>
  77
  78 Check-out the Arno release:
  79
  80 <cd genesis; git checkout arno>
  81
  82 Goto the fuel directory and build the .iso
  83
  84 <cd fuel/build; make all>
  85
  86 For more information on how to build, please see "OPNFV Build instructions for - Arno release of OPNFV when using Fuel as a deployment tool <http://www.opnfv.org/xyz>
  87
  88 Next, familiarize yourself with the Fuel 6.0.1 version by reading the following documents:
  89
  90 - Fuel planning guide <http://docs.mirantis.com/openstack/fuel/fuel-6.0/planning-guide.html#planning-guide>
  91
  92 - Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-6.0/user-guide.html#user-guide>
  93
  94 - Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-6.0/operations.html#operations-guide>
  95
  96
  97 A number of deployment specific parameters must be collected, those are:
  98
  99 1.     Provider sub-net and gateway information
 100
 101 2.     Provider VLAN information
 102
 103 3.     Provider DNS addresses
 104
 105 4.     Provider NTP addresses
 106
 107 This information will be needed for the configuration procedures provided in this document.
 108
 109 4   Hardware requirements
 110 =========================
 111
 112 Following minimum hardware requirements must be met for installation of Fuel@OPNFV:
 113
 114 +--------------------+------------------------------------------------------+
 115 | **HW Aspect**      | **Requirement**                                      |
 116 |                    |                                                      |
 117 +--------------------+------------------------------------------------------+
 118 | **# of servers**   | Minimum 5 (3 for non redundant deployment):          |
 119 |                    |                                                      |
 120 |                    | - 1 Fuel deployment master (may be virtualized)      |
 121 |                    |                                                      |
 122 |                    | - 3(1) Controllers                                   |
 123 |                    |                                                      |
 124 |                    | - 1 Compute                                          |
 125 +--------------------+------------------------------------------------------+
 126 | **CPU**            | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz        |
 127 |                    |                                                      |
 128 +--------------------+------------------------------------------------------+
 129 | **RAM**            | Minimum 16GB/server (Depending on VNF work load)     |
 130 |                    |                                                      |
 131 +--------------------+------------------------------------------------------+
 132 | **Disk**           | Minimum 256GB 10kRPM spinning disks                  |
 133 |                    |                                                      |
 134 +--------------------+------------------------------------------------------+
 135 | **NICs**           | - 2(1)x10GE Niantec for Private/Public (Redundant)   |
 136 |                    |                                                      |
 137 |                    | - 2(1)x10GE Niantec for SAN (Redundant)              |
 138 |                    |                                                      |
 139 |                    | - 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) |
 140 |                    |                                                      |
 141 +--------------------+------------------------------------------------------+
 142
 143 5   Top of the rack (TOR) Configuration requirements
 144 ====================================================
 145
 146 The switching infrastructure provides connectivity for the OPNFV infra-structure operations, tenant networks (East/West) and provider connectivity (North/South bound connectivity); it also provides needed connectivity for the storage Area Network (SAN). To avoid traffic congestion, it is strongly sugested that three physcally separated networks are used, that is: 1 physical network for administration and control, one physical network for tenant private and public networks, and one physical network for SAN. The switching connectivity can (but does not need to) be fully redundant, in such case it and comprises a redundant 10GE switch pair for each of the three physcally separated networks.
 147
 148 The physical TOR switches are **not** automatically configured from the OPNFV reference platform. All the networks involved in the OPNFV infra-structure as well as the provider networks and the private tenant VLANs needs to be manually configured.
 149
 150 Manual configuration of the Arno hardware platform should be carried out according to the Pharos specification <link>.
 151
 152
 153 6   OPNFV Software installation and deployment
 154 ==============================================
 155
 156 This section describes the installation of the Fuel@OPNFV installation server (Fuel master) as well as the deployment of the full OPNFV reference platform stack across a server cluster.
 157
 158 6.1 Install Fuel master
 159 -----------------------
 160 1. Mount the built .iso file (release/opnfv-<version>.iso) as a boot device to the jump host server.
 161
 162 2. Reboot the jump host to establish the Fuel server.
 163
 164    - The system now boots from the ISO image.
 165
 166 3. Change the grub boot parameters
 167
 168    - When the grub boot menu shows up - Press Tab to edit the kernel parameters
 169
 170    - Change <showmenu=no> to <showmenu=yes>.
 171
 172    - Change <netmask=255.255.255.0> to <netmask=255.255.0.0>.
 173
 174    - Press [Enter].
 175
 176 4  Wait until screen Fuel setup is shown (Note: This can take up to 30 minutes).
 177
 178 5. Select PXE Setup and change the following fields to appropriate values (example below):
 179
 180    - Static Pool Start 10.20.0.3
 181
 182    - Static Pool End 10.20.0.254
 183
 184    - DHCP Pool Start 10.20.128.3
 185
 186    - DHCP Pool End 10.20.128.254
 187
 188 6. Select DNS & Hostname and change the following fields to appropriate values:
 189
 190    - Hostname <CEE Region name>-fuel
 191
 192    - Domain <Domain Name>
 193
 194    - Search Domain <Search Domain Name>
 195
 196    - Hostname to test DNS <Hostname to test DNS>
 197
 198 7. Select Time Sync and change the following fields to appropriate values:
 199
 200    - NTP Server 1 <Customer NTP server 1>
 201
 202    - NTP Server 2 <Customer NTP server 2>
 203
 204    - NTP Server 3<Customer NTP server 3>
 205
 206    **Note: This step is only to pass the network sanity test, the actual ntp parameters will be set with the pre-deploy script.**
 207
 208 8. Start the installation.
 209
 210    - Select Quit Setup and press Save and Quit.
 211
 212    - Installation starts, wait until a screen with logon credentials is shown.
 213
 214    Note: This will take about 15 minutes.
 215
 216 6.2 Create an OPNV (Fuel Environment)
 217 -------------------------------------
 218
 219 9. Connect to Fuel with a browser towards port 8000
 220
 221 10. Create and name a new OpenStack environment, to be installed.
 222
 223 11. Select <Juno on Ubuntu> or <Juno on CentOS> as per your which in the "OpenStack Release" field.
 224
 225 12. Select deployment mode.
 226
 227     - Select the Multi-node with HA.
 228
 229 13. Select compute node mode.
 230
 231     - Select KVM as hypervisor (unless you're not deploying bare metal or nested KVM/ESXI).
 232
 233 14. Select network mode.
 234
 235     - Select Neutron with VLAN segmentation
 236
 237     ** Note: This will later be overridden to VXLAN by OpenDaylight.**
 238
 239 15. Select Storage Backends.
 240
 241     - Select Ceph for Cinder and default for glance.
 242
 243 16. Select additional services.
 244
 245     - Check option <Install Celiometer (OpenStack Telemetry)>.
 246
 247 17. Create the new environment.
 248
 249 6.3 Configure the OPNFV environment
 250 -----------------------------------
 251
 252 18. Enable PXE booting
 253
 254     - For every controller- and compute server: enable PXE Booting as the first boot device in the BIOS boot order menu, and hard disk as the second boot device in the same menu.
 255
 256 19. Reboot all the controller- and compute blades.
 257
 258 20. Wait for the availability of nodes showing up in the Fuel GUI.
 259
 260     - Wait until all nodes are displayed in top right corner of the Fuel GUI: <total number of server> TOTAL NODES and <total number of servers> UNALLOCATED NODES.
 261
 262 21. Open the environment you previously created.
 263
 264 22. Open the networks tab.
 265
 266 23. Update the public network configuration.
 267
 268     Change the following fields to appropriate values:
 269
 270     - IP Range Start to <Public IP Address start>
 271
 272     - IP Range End to <Public IP Address end>
 273
 274     - CIDR to <CIDR for Public IP Addresses>
 275
 276     - Gateway to <Gateway for Public IP Addresses>
 277
 278     - Check  VLAN tagging.
 279
 280     - Set appropriate VLAN id.
 281
 282 24. Update the management network configuration.
 283
 284     - Set CIDR to 172.16.255.128/25 (or as per your which).
 285
 286     - Check VLAN tagging.
 287
 288     - Set appropriate  VLAN id.
 289
 290 25. Update the Neutron L2 configuration.
 291
 292     - Set VLAN ID range.
 293
 294 26. Update the Neutron L3 configuration.
 295
 296     - Set Internal network CIDR to an appropriate value
 297
 298     - Set Internal network gateway to an appropriate value
 299
 300     - Set Floating IP ranges.
 301
 302     - Set DNS Servers
 303
 304 27. Save Settings.
 305
 306 28. Click "verify network" to check the network set-up consistency and connectivity
 307
 308 29. Update the storage configuration.
 309
 310 30. Open the nodes tab.
 311
 312 31. Assign roles.
 313
 314     - Check <Controller and Telemetry MongoDB>.
 315
 316     - Check the three servers you want to be installed as Controllesr in pane <Assign Role>.
 317
 318     - Click <Apply Changes>.
 319
 320     - Check <Compute>.
 321
 322     - Check nodes to be installed as Compute nodes in pane Assign Role.
 323
 324     - Click <Apply Changes>.
 325
 326 32. Configure interfaces.
 327
 328     - Check Select <All> to select all nodes with Control, Telemetry . MongoDB and Compute node roles.
 329
 330     - Click <Configure Interfaces>
 331
 332     - Screen Configure interfaces on number of <number of nodes> nodes is shown.
 333     - Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
 334
 335 6.4 Deploy the OPNFV environment
 336 --------------------------------
 337 **NOTE: Before the deployment is performed, the OPNFV pre-deploy script must be ran**
 338
 339 35. Run the pre-deploy script.
 340     Log on as root to the Fuel node.
 341     Print Fuel environment Id (fuel env)
 342     #> id | status | name | mode | release_id | changes <id>| new | <CEE Region name>| ha_compact | 2 | <ite specific information>
 343
 344 36. Run the pre-deployment script (/opt/opnfv/pre-deploy.sh <id>)
 345     As prompted for-, set the DNS servers to go into /etc/resolv.conf.
 346     As prompted for-, set any Hosts file additions for controllers and compute nodes. You will be prompted for name, FQDN and IP for each entry. Press return when prompted for a name when you have completed your input.
 347     As prompted for-, set NTP upstream configuration for controllers. You will be prompted for a NTP server each entry. Press return when prompted for a NTP server when you have completed your input.
 348
 349 37. Deploy the environment.
 350     In the Fuel GUI, click Deploy Changes.
 351
 352 7   Installation health-check
 353 =============================
 354
 355 Now that the OPNFV environment has been created, and before the post installation configurations is started, perform a system health check from the Fuel GUI:
 356
 357 - Select the “Health check” TAB.
 358 - Select all test-cases
 359 - And click “Run tests”
 360
 361 All test cases except the following should pass:
 362
 363 8  Post installation and deployment actions
 364 ============================================
 365 **-**
 366
 367 9  References
 368 =============
 369
 370 9.1    OPNFV
 371 -------------
 372
 373 9.2    OpenStack
 374 -----------------
 375
 376 9.3    OpenDaylight
 377 --------------------
 378
 379 9.4    Fuel
 380 ------------