388907ea6eb582774b3e033e477cb3c6b5531776
[genesis.git] / fuel / docs / src / installation-instructions.rst
1 :Authors: Jonas Bjurel (Ericsson)
2 :Version: 0.1
3
4 ================================================================
5 OPNFV Installation instructions for - < Component denomination >
6 ================================================================
7
8 Abstract
9 ========
10
11 This document describes how to install <Component>, it's dependencies and required system resources.
12
13 License
14 =======
15 <WORK'S NAME> (c) by <AUTHOR'S NAME>
16
17 <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/>.
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-14         | 0.1.0              | Jonas Bjurel       | First draft        |
48 |                    |                    |                    |                    |
49 +--------------------+--------------------+--------------------+--------------------+
50 |                    | 0.1.1              |                    |                    |
51 |                    |                    |                    |                    |
52 +--------------------+--------------------+--------------------+--------------------+
53 |                    | 1.0                |                    |                    |
54 |                    |                    |                    |                    |
55 |                    |                    |                    |                    |
56 +--------------------+--------------------+--------------------+--------------------+
57
58 2   Introduction
59 ================
60 <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
61
62 <EXAMPLE>:
63
64 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
65 configure such reference system.
66
67 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
68 a result that is OPNFV compliant.
69
70 The audience of this document is assumed to have good knowledge in network and Unix/Linux administration.
71
72 3   Preface
73 ===========
74 <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
75
76 <EXAMPLE>:
77
78 Before starting the installation of Fuel@OPNFV, some planning must preceed.
79
80 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>
81
82 Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository:
83 <git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis>
84 Check-out the Arno release:
85 <cd genesis; git checkout arno>
86 Goto the fuel directory and build the .iso
87 <cd fuel/build; make all>
88
89 Familiarize yourself with the Fuel 6.0.1 version by reading the following documents:
90 - abc <http://wiki.openstack.org/abc>
91 - def <http://wiki.openstack.org/def>
92 - ghi <http://wiki.openstack.org/ghi>
93
94 Secondly, 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 <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
109
110 <EXAMPLE>:
111
112 Following minimum hardware requirements must be met for installation of Fuel@OPNFV:
113
114 +--------------------+----------------------------------------------------+
115 | **HW Aspect**      | **Requirement**                                    |
116 |                    |                                                    |
117 +--------------------+----------------------------------------------------+
118 | **# of servers**   | Minimum 5 (3 for non redundant deployment)         |
119 |                    | 1 Fuel deployment master (may be virtualized)      |
120 |                    | 3(1) Controllers                                   |
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 <DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs>
143
144 <EXAMPLE>:
145
146 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”
147
148 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.
149
150 This following sections guides through required black-box switch configurations.
151
152 5.1 VLAN considerations and blue-print
153 --------------------------------------
154
155 5.2 IP Address plan considerations and blue-print
156 -------------------------------------------------
157
158 6   OPNFV Software installation and deployment
159 ==============================================
160 <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT>
161
162 <EXAMPLE>:
163
164 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.
165 Etc.
166
167 6.1 Install Fuel master
168 -----------------------
169
170 6.2 Create an OPNV (Fuel Environment)
171 -------------------------------------
172
173 6.3 Configure the OPNFV environment
174 -----------------------------------
175
176 6.4 Deploy the OPNFV environment
177 --------------------------------
178
179 7   Installation health-check
180 ============================
181 <DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL>
182
183 <EXAMPLE>:
184
185 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:
186
187 - Select the “Health check” TAB.
188 - Select all test-cases
189 - And click “Run tests”
190
191 All test cases except the following should pass:
192
193 8  Post installation and deployment actions
194 ============================================
195 <DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED>
196
197 <EXAMPLE>:
198 After the OPNFV deployment is completed, the following manual changes needs to be performed in order for the system to work according OPNFV standards.
199
200 **Change host OS password:**
201 Change the Host OS password by......
202
203 9  References
204 =============
205 <PROVIDE NEEDED/USEFUL REFERENCES>
206
207 <EXAMPLES>:
208
209 9.1    OPNFV
210 -------------
211
212 9.2    OpenStack
213 -----------------
214
215 9.3    OpenDaylight
216 --------------------
217
218 9.4    Fuel
219 ------------