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