1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
Compass4nfv configuration
=========================
This document describes providing guidelines on how to install and
configure the Brahmaputra release of OPNFV when using Compass as a
deployment tool including required software and hardware
configurations.
Installation and configuration of host OS, OpenStack, OpenDaylight,
ONOS, Ceph etc. can be supported by Compass on VMs or Bare Metal
nodes.
The audience of this document is assumed to have good knowledge in
networking and Unix/Linux administration.
-------------
Preconditions
-------------
Before starting the installation of the Brahmaputra release of OPNFV,
some planning must be done.
Retrieving the installation ISO image
-------------------------------------
First of all, The installation ISO is needed for deploying your OPNFV
environment, it included packages of Compass, OpenStack, OpenDaylight, ONOS
and so on.
The stable release ISO can be retrieved via `OPNFV software download page <https://www.opnfv.org/software/>`_
The daily build ISO can be retrieved via OPNFV artifacts repository:
http://artifacts.opnfv.org/
NOTE: Search the keyword "Compass4nfv/Brahmaputra" to locate the ISO image.
E.g.
compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.iso
compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.properties
The name of iso image includes the time of iso building, you can get the daily
ISO according the building time.
The git url and sha1 of Compass4nfv are recorded in properties files,
According these, the corresponding deployment scripts can be retrieved.
Getting the deployment scripts
------------------------------
To retrieve the repository of Compass4nfv on Jumphost use the following command:
- git clone https://gerrit.opnfv.org/gerrit/compass4nfv
To get stable/brahmaputra release, you can use the following command:
- git checkout brahmaputra.1.0
NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY.
If you don't have a Linux foundation user id, get it first by the url:
https://wiki.opnfv.org/developer/getting_started
If you want to use a daily release ISO, please checkout the corresponding sha1 to
get the deployment scripts:
E.g.
Git sha1 in file "opnfv-2016-01-16_15-03-18.properties" is
d5a13ce7cc2ce89946d34b0402ecf33c1d291851
- git checkout d5a13ce7cc2ce89946d34b0402ecf33c1d291851
Preparing the installation environment
--------------------------------------
If you have only 1 Bare Metal server, Virtual deployment is recommended. if more
than or equal 3 servers, the Bare Metal deployment is recommended. The minimum number of
servers for Bare metal deployment is 3, 1 for JumpServer(Jumphost), 1 for controller,
1 for compute.
------------------
Setup Requirements
------------------
Jumphost Requirements
---------------------
The Jumphost requirements are outlined below:
1. Ubuntu 14.04 (Pre-installed).
2. Root access.
3. libvirt virtualization support.
4. Minimum 2 NICs.
- PXE installation Network (Receiving PXE request from nodes and providing OS provisioning)
- IPMI Network (Nodes power control and set boot PXE first via IPMI interface)
- External Network (Optional: Internet access)
5. 16 GB of RAM for a Bare Metal deployment, 64 GB of RAM for a VM deployment.
6. Minimum 100G storage.
Bare Metal Node Requirements
----------------------------
Bare Metal nodes require:
1. IPMI enabled on OOB interface for power control.
2. BIOS boot priority should be PXE first then local hard disk.
3. Minimum 3 NICs.
- PXE installation Network (Broadcasting PXE request)
- IPMI Network (Receiving IPMI command from Jumphost)
- External Network (OpenStack mgmt/external/storage/tenant network)
Network Requirements
--------------------
Network requirements include:
1. No DHCP or TFTP server running on networks used by OPNFV.
2. 2-6 separate networks with connectivity between Jumphost and nodes.
- PXE installation Network
- IPMI Network
- Openstack mgmt Network*
- Openstack external Network*
- Openstack tenant Network*
- Openstack storage Network*
3. Lights out OOB network access from Jumphost with IPMI node enabled (Bare Metal deployment only).
4. External network has Internet access, meaning a gateway and DNS availability.
**The networks with(*) can be share one NIC(Default configuration) or use an exclusive**
**NIC(Reconfigurated in network.yml).**
Execution Requirements (Bare Metal Only)
----------------------------------------
In order to execute a deployment, one must gather the following information:
1. IPMI IP addresses for the nodes.
2. IPMI login information for the nodes (user/pass).
3. MAC address of Control Plane / Provisioning interfaces of the Bare Metal nodes.
----------------------------------
Installation Guide (BM Deployment)
----------------------------------
Nodes Configuration (BM Deployment)
-----------------------------------
The bellow file is the inventory template of deployment nodes:
"compass4nfv/deploy/conf/hardware_environment/huawei_us_lab/pod1/dha.yml"
You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
- ipmiVer -- IPMI interface version for deployment node support. IPMI 1.0
or IPMI 2.0 is available.
- ipmiIP -- IPMI IP address for deployment node. Make sure it can access
from Jumphost.
- ipmiUser -- IPMI Username for deployment node.
- ipmiPass -- IPMI Password for deployment node.
- mac -- MAC Address of deployment node PXE NIC .
- name -- Host name for deployment node after installation.
- roles -- Components deployed.
**Assignment of different roles to servers**
E.g. Openstack only deployment roles setting
.. code-block:: yaml
hosts:
- name: host1
roles:
- controller
- ha
- name: host2
roles:
- compute
NOTE:
IF YOU SELECT MUTIPLE NODES AS CONTROLLER, THE 'ha' role MUST BE SELECT, TOO.
E.g. Openstack and ceph deployment roles setting
.. code-block:: yaml
hosts:
- name: host1
roles:
- controller
- ha
- ceph-adm
- ceph-mon
- name: host2
roles:
- compute
- ceph-osd
E.g. Openstack and ODL deployment roles setting
.. code-block:: yaml
hosts:
- name: host1
roles:
- controller
- ha
- odl
- name: host2
roles:
- compute
E.g. Openstack and ONOS deployment roles setting
.. code-block:: yaml
hosts:
- name: host1
roles:
- controller
- ha
- onos
- name: host2
roles:
- compute
Network Configuration (BM Deployment)
-------------------------------------
Before deployment, there are some network configuration to be checked based on your network topology.
Compass4nfv network default configuration file is "compass4nfv/deploy/conf/network_cfg.yaml".
You can write your own reference to it.
**The following figure shows the default network configuration.**
.. code-block:: console
+--+ +--+ +--+
| | | | | |
| | +------------+ | | | |
| +------+ Jumphost +------+ | | |
| | +------+-----+ | | | |
| | | | | | |
| | +------------+ +-----+ |
| | | | | |
| | +------------+ | | | |
| +------+ host1 +------+ | | |
| | +------+-----+ | | | |
| | | | | | |
| | +------------+ +-----+ |
| | | | | |
| | +------------+ | | | |
| +------+ host2 +------+ | | |
| | +------+-----+ | | | |
| | | | | | |
| | +------------+ +-----+ |
| | | | | |
| | +------------+ | | | |
| +------+ host3 +------+ | | |
| | +------+-----+ | | | |
| | | | | | |
| | +------------+ +-----+ |
| | | | | |
| | | | | |
+-++ ++-+ +-++
^ ^ ^
| | |
| | |
+-+-------------------------+ | |
| External Network | | |
+---------------------------+ | |
+-----------------------+---+ |
| IPMI Network | |
+---------------------------+ |
+-------------------------+-+
| PXE(Installation) Network |
+---------------------------+
Start Deployment (BM Deployment)
--------------------------------
1. Set PXE/Installation NIC for Jumphost. (set eth1 E.g.)
.. code-block:: bash
export INSTALL_NIC=eth1
2. Set OS version for nodes provisioning. (set Ubuntu14.04 E.g.)
.. code-block:: bash
export OS_VERSION=trusty
3. Set OpenStack version for deployment nodes. (set liberty E.g.)
.. code-block:: bash
export OPENSTACK_VERSION=liberty
4. Set ISO image that you want to deploy
.. code-block:: bash
export ISO_URL=file:///${YOUR_OWN}/compass.iso
or
export ISO_URL=http://artifacts.opnfv.org/compass4nfv/brahmaputra/opnfv-release.iso
5. Run ``deploy.sh`` with inventory and network configuration
.. code-block:: bash
./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
|
