fuel/docs/src/installation-instructions.rst

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