Updates docs for SR1 with final revision
[genesis.git] / fuel / build / f_example_control_bond / README
1 ##############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
3 # stefan.k.berg@ericsson.com
4 # jonas.bjurel@ericsson.com
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
9 ##############################################################################
10
11 This is an example of a modification of the bridge and bonding of interfaces.
12 Rationale: Fuel currently don't support bonding of the "Admin" network, which
13 becomes a problem if you want to co-locate the single "Admin" and the redundant
14 bonded "Management" network on one and the same physical network in order to minimize
15 number of NICs, switches and cables.
16 This example show how you can modify the bridge and bonding settings and scripts to
17 achieve co-location. Of course the FUEL GUI becomes shorted in this respect, I.e.
18 the "admin" and "management" network cant be dragged across the NICs in the GUI.
19
20 The f_example_control_bond has the following structure:
21 .
22 +--------+----------+-----------+
23          |          |           |
24       puppet/    Makefile     README
25          |                  (this file)
26          |
27          |
28       modules/
29          |
30          |
31          |
32        opnfv/
33          |
34          +--------------+
35          |              |
36        files/        manifests/
37          |              |
38          |              |
39          |              |
40     control-bond  control-bond.pp
41
42 Makefile:
43 Invoked by the git root Makefile, copies the files up to the release build
44 directory.
45
46 control-bond:
47 The control-bond file is the .init file orchestrating the interface-, bridge-
48 and bond actions required for enabling the control bond
49
50 control-bond.pp:
51 The control-bond.pp is the pupet manifest orchestrating the placement and
52 configuration of the control-bond shell script file.
53
54 To activate this example feature, add "SUBDIRS += f_example_control_bond" in the git root Makefile.
55
56