docs/templates/release/installation/installation.instruction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ========
   5 Abstract
   6 ========
   7
   8 This document describes how to install <Component>, it's dependencies and required system resources.
   9
  10 .. contents::
  11    :depth: 3
  12    :local:
  13
  14 Version history
  15 ---------------------
  16
  17 +--------------------+--------------------+--------------------+--------------------+
  18 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  19 |                    |                    |                    |                    |
  20 +--------------------+--------------------+--------------------+--------------------+
  21 | 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |
  22 |                    |                    |                    |                    |
  23 +--------------------+--------------------+--------------------+--------------------+
  24 |                    | 0.1.1              |                    |                    |
  25 |                    |                    |                    |                    |
  26 +--------------------+--------------------+--------------------+--------------------+
  27 |                    | 1.0                |                    |                    |
  28 |                    |                    |                    |                    |
  29 |                    |                    |                    |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31
  32
  33 Introduction
  34 ============
  35 <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
  36
  37 <EXAMPLE>:
  38
  39 This document describes the supported software and hardware configurations for the
  40 Fuel OPNFV reference platform as well as providing guidelines on how to install and
  41 configure such reference system.
  42
  43 Although the available installation options gives a high degree of freedom in how the system is set-up,
  44 with what architecture, services and features, etc., not nearly all of those permutations provides
  45 a OPNFV compliant reference architecture. Following the guidelines in this document ensures
  46 a result that is OPNFV compliant.
  47
  48 The audience of this document is assumed to have good knowledge in network and Unix/Linux administration.
  49
  50
  51 Preface
  52 =======
  53 <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
  54
  55 <EXAMPLE>:
  56
  57 Before starting the installation of Fuel@OPNFV, some planning must preceed.
  58
  59 First of all, the Fuel@OPNFV .iso image needs to be retrieved,
  60 the Latest stable Arno release of Fuel@OPNFV can be found here: <www.opnfv.org/abc/def>
  61
  62 Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository:
  63 <git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis>
  64 Check-out the Arno release:
  65 <cd genesis; git checkout arno>
  66 Goto the fuel directory and build the .iso
  67 <cd fuel/build; make all>
  68
  69 Familiarize yourself with the Fuel 6.0.1 version by reading the following documents:
  70 - abc <http://wiki.openstack.org/abc>
  71 - def <http://wiki.openstack.org/def>
  72 - ghi <http://wiki.openstack.org/ghi>
  73
  74 Secondly, a number of deployment specific parameters must be collected, those are:
  75
  76 1.     Provider sub-net and gateway information
  77
  78 2.     Provider VLAN information
  79
  80 3.     Provider DNS addresses
  81
  82 4.     Provider NTP addresses
  83
  84 This information will be needed for the configuration procedures provided in this document.
  85
  86
  87 Hardware requirements
  88 =====================
  89 <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
  90
  91 <EXAMPLE>:
  92
  93 Following minimum hardware requirements must be met for installation of Fuel@OPNFV:
  94
  95 +--------------------+----------------------------------------------------+
  96 | **HW Aspect**      | **Requirement**                                    |
  97 |                    |                                                    |
  98 +--------------------+----------------------------------------------------+
  99 | **# of servers**   | Minimum 5 (3 for non redundant deployment)         |
 100 |                    | 1 Fuel deployment master (may be virtualized)      |
 101 |                    | 3(1) Controllers                                   |
 102 |                    | 1 Compute                                          |
 103 +--------------------+----------------------------------------------------+
 104 | **CPU**            | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz      |
 105 |                    |                                                    |
 106 +--------------------+----------------------------------------------------+
 107 | **RAM**            | Minimum 16GB/server (Depending on VNF work load)   |
 108 |                    |                                                    |
 109 +--------------------+----------------------------------------------------+
 110 | **Disk**           | Minimum 256GB 10kRPM spinning disks                |
 111 |                    |                                                    |
 112 +--------------------+----------------------------------------------------+
 113 | **NICs**           | 2(1)x10GE Niantec for Private/Public (Redundant)   |
 114 |                    |                                                    |
 115 |                    | 2(1)x10GE Niantec for SAN (Redundant)              |
 116 |                    |                                                    |
 117 |                    | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) |
 118 |                    |                                                    |
 119 +--------------------+----------------------------------------------------+
 120
 121
 122 Top of the rack (TOR) Configuration requirements
 123 ================================================
 124 <DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs>
 125
 126 <EXAMPLE>:
 127
 128 The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as
 129 for the tenant networks (East/West) and provider connectivity (North/South bound connectivity).
 130 The switching connectivity can (but does not need to) be fully redundant,
 131 in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as
 132 a 1GE switch pair for "infrastructure control-, management and administration"
 133
 134 The switches are **not** automatically configured from the OPNFV reference platform.
 135 All the networks involved in the OPNFV infra-structure as well as the provider networks
 136 and the private tenant VLANs needs to be manually configured.
 137
 138 This following sections guides through required black-box switch configurations.
 139
 140 VLAN considerations and blue-print
 141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 142
 143 IP Address plan considerations and blue-print
 144 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 145
 146
 147 OPNFV Software installation and deployment
 148 ==========================================
 149 <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT>
 150
 151 <EXAMPLE>:
 152
 153 This section describes the installation of the Fuel@OPNFV installation server (Fuel master)
 154 as well as the deployment of the full OPNFV reference platform stack across a server cluster.
 155 Etc.
 156
 157 Install Fuel master
 158 ^^^^^^^^^^^^^^^^^^^^^
 159
 160 Create an OPNV (Fuel Environment)
 161 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 162
 163 Configure the OPNFV environment
 164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 165
 166 Deploy the OPNFV environment
 167 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 168
 169
 170 Installation health-check
 171 =========================
 172 <DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL>
 173
 174 <EXAMPLE>:
 175
 176 Now that the OPNFV environment has been created, and before the post installation configurations is started,
 177 perform a system health check from the Fuel GUI:
 178
 179 - Select the "Health check" TAB.
 180 - Select all test-cases
 181 - And click "Run tests"
 182
 183 All test cases except the following should pass:
 184
 185 Post installation and deployment actions
 186 ------------------------------------------
 187 <DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED>
 188
 189 <EXAMPLE>:
 190 After the OPNFV deployment is completed, the following manual changes needs to be performed in order
 191 for the system to work according OPNFV standards.
 192
 193 **Change host OS password:**
 194 Change the Host OS password by......
 195
 196
 197 References
 198 ==========
 199 <PROVIDE NEEDED/USEFUL REFERENCES>
 200
 201 <EXAMPLES>:
 202
 203 OPNFV
 204 ^^^^^^^^^^
 205
 206 OpenStack
 207 ^^^^^^^^^^^
 208
 209 OpenDaylight
 210 ^^^^^^^^^^^^^^^