docs/templates/installation-instructions.rst

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