rhel: Add Red Hat network scripts integration.
[sliver-openvswitch.git] / rhel / README.RHEL
1 Red Hat network scripts integration
2 -----------------------------------
3
4 The RPM packages for Open vSwitch provide some integration with Red
5 Hat's network scripts.  Using this integration is optional.
6
7 To use the integration for a Open vSwitch bridge or interface named
8 <name>, create or edit /etc/sysconfig/network-scripts/ifcfg-<name>.
9 This is a shell script that consists of a series of VARIABLE=VALUE
10 assignments.  The following OVS-specific variable names are supported:
11
12     - DEVICETYPE: Always set to "ovs".
13
14     - TYPE: If this is "OVSBridge", then this file represents an OVS
15       bridge named <name>.  Otherwise, it represents a port on an OVS
16       bridge and TYPE must have one of the following values:
17
18         * "OVSPort", if <name> is a physical port (e.g. eth0) or
19           virtual port (e.g. vif1.0).
20
21         * "OVSIntPort", if <name> is an internal port (e.g. a tagged
22           VLAN).
23
24         * "OVSBond", if <name> is an OVS bond.
25
26     - OVS_BRIDGE: If TYPE is anything other than "OVSBridge", set to
27       the name of the OVS bridge to which the port should be attached.
28
29     - OVS_OPTIONS: Optionally, extra options to set in the "Port"
30       table when adding the port to the bridge, as a sequence of
31       column[:key]=value options.  For example, "tag=100" to make the
32       port an access port for VLAN 100.  See the documentation of
33       "add-port" in ovs-vsctl(8) for syntax and the section on the
34       Port table in ovs-vswitchd.conf.db(5) for available options.
35
36     - OVS_EXTRA: Optionally, additional ovs-vsctl commands, separated
37       by "--" (double dash).
38
39     - BOND_IFACES: For "OVSBond" interfaces, a list of physical
40       interfaces to bond together.
41
42 Note
43 ----
44
45 "ifdown" on a bridge will not bring individual ports on the bridge
46 down.  "ifup" on a bridge will not add ports to the bridge.  This
47 behavior should be compatible with standard bridges (with
48 TYPE=Bridge).
49
50 Examples
51 --------
52
53 Standalone bridge:
54
55 ==> ifcfg-ovsbridge0 <==
56 DEVICE=ovsbridge0
57 ONBOOT=yes
58 DEVICETYPE=ovs
59 TYPE=OVSBridge
60 BOOTPROTO=static
61 IPADDR=A.B.C.D
62 NETMASK=X.Y.Z.0
63 HOTPLUG=no
64
65
66 Adding physical eth0 to ovsbridge0 described above:
67
68 ==> ifcfg-eth0 <==
69 DEVICE=eth0
70 ONBOOT=yes
71 DEVICETYPE=ovs
72 TYPE=OVSPort
73 OVS_BRIDGE=internet
74 BOOTPROTO=none
75 HOTPLUG=no
76
77
78 Tagged VLAN interface on top of ovsbridge0:
79
80 ==> ifcfg-vlan100 <==
81 DEVICE=vlan100
82 ONBOOT=yes
83 DEVICETYPE=ovs
84 TYPE=OVSIntPort
85 BOOTPROTO=static
86 IPADDR=A.B.C.D
87 NETMASK=X.Y.Z.0
88 OVS_BRIDGE=ovsbridge0
89 OVS_OPTIONS="tag=100"
90 OVS_EXTRA="set Interface $DEVICE external-ids:iface-id=$(hostname -s)-$DEVICE-vif"
91 HOTPLUG=no
92
93
94 Bonding:
95
96 ==> ifcfg-bond0 <==
97 DEVICE=bond0
98 ONBOOT=yes
99 DEVICETYPE=ovs
100 TYPE=OVSBond
101 OVS_BRIDGE=ovsbridge0
102 BOOTPROTO=none
103 BOND_IFACES="gige-1b-0 gige-1b-1 gige-21-0 gige-21-1"
104 OVS_OPTIONS="bond_mode=balance-tcp lacp=active"
105 HOTPLUG=no
106
107 ==> ifcfg-gige-* <==
108 DEVICE=gige-*
109 ONBOOT=yes
110 HOTPLUG=no
111
112 Reporting Bugs
113 --------------
114
115 Please report problems to bugs@openvswitch.org.