fuel/docs/src/installation-instructions.rst

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