]>
Commit | Line | Data |
---|---|---|
1 | <?xml version="1.0" encoding="utf-8"?> | |
2 | <manpage program="ovn-controller" section="8" title="ovn-controller"> | |
3 | <h1>Name</h1> | |
4 | <p>ovn-controller -- Open Virtual Network local controller</p> | |
5 | ||
6 | <h1>Synopsis</h1> | |
7 | <p><code>ovn-controller</code> [<var>options</var>] [<var>ovs-database</var>]</p> | |
8 | ||
9 | <h1>Description</h1> | |
10 | <p> | |
11 | <code>ovn-controller</code> is the local controller daemon for | |
12 | OVN, the Open Virtual Network. It connects up to the OVN | |
13 | Southbound database (see <code>ovn-sb</code>(5)) over the OVSDB | |
14 | protocol, and down to the Open vSwitch database (see | |
15 | <code>ovs-vswitchd.conf.db</code>(5)) over the OVSDB protocol and | |
16 | to <code>ovs-vswitchd</code>(8) via OpenFlow. Each hypervisor and | |
17 | software gateway in an OVN deployment runs its own independent | |
18 | copy of <code>ovn-controller</code>; thus, | |
19 | <code>ovn-controller</code>'s downward connections are | |
20 | machine-local and do not run over a physical network. | |
21 | </p> | |
22 | ||
23 | <h1>Configuration</h1> | |
24 | <p> | |
25 | <code>ovn-controller</code> retrieves most of its configuration | |
26 | information from the local Open vSwitch's ovsdb-server instance. | |
27 | The default is the <code>db.sock</code> in local Open vSwitch's | |
28 | "run" directory. <var>ovs-database</var> must take one of the | |
29 | following forms: | |
30 | </p> | |
31 | <ul> | |
32 | <li> | |
33 | <p> | |
34 | <code>ssl:<var>ip</var>:<var>port</var></code> | |
35 | </p> | |
36 | <p> | |
37 | The specified SSL <var>port</var> on the host at the given | |
38 | <var>ip</var>, which must be expressed as an IP address (not a DNS | |
39 | name) in IPv4 or IPv6 address format. If <var>ip</var> is an IPv6 | |
40 | address, then wrap <var>ip</var> with square brackets, e.g.: | |
41 | <code>ssl:[::1]:6640</code>. The <code>--private-key</code>, | |
42 | <code>--certificate</code>, and <code>--ca-cert</code> options are | |
43 | mandatory when this form is used. | |
44 | </p> | |
45 | </li> | |
46 | <li> | |
47 | <p> | |
48 | <code>tcp:<var>ip</var>:<var>port</var></code> | |
49 | </p> | |
50 | <p> | |
51 | Connect to the given TCP <var>port</var> on <var>ip</var>, where | |
52 | <var>ip</var> can be IPv4 or IPv6 address. If <var>ip</var> is an | |
53 | IPv6 address, then wrap <var>ip</var> with square brackets, e.g.: | |
54 | <code>tcp:[::1]:6640</code>. | |
55 | </p> | |
56 | </li> | |
57 | <li> | |
58 | <p> | |
59 | <code>unix:<var>file</var></code> | |
60 | </p> | |
61 | <p> | |
62 | On POSIX, connect to the Unix domain server socket named | |
63 | <var>file</var>. | |
64 | </p> | |
65 | <p> | |
66 | On Windows, connect to a localhost TCP port whose value is written | |
67 | in <var>file</var>. | |
68 | </p> | |
69 | </li> | |
70 | </ul> | |
71 | <p> | |
72 | <code>ovn-controller</code> assumes it gets configuration | |
73 | information from the following keys in the <code>Open_vSwitch</code> | |
74 | table of the local OVS instance: | |
75 | <ul> | |
76 | <li> | |
77 | <p> | |
78 | <code>external_ids:system-id</code> specifies the chassis | |
79 | name to use in the Chassis table. | |
80 | </p> | |
81 | </li> | |
82 | <li> | |
83 | <p> | |
84 | <code>external_ids:ovn-bridge</code> specifies the | |
85 | integration bridge to which logical ports are attached. | |
86 | The default is <code>br-int</code>. | |
87 | </p> | |
88 | </li> | |
89 | <li> | |
90 | <p> | |
91 | <code>external_ids:ovn-remote</code> specifies the OVN | |
92 | database that this system should connect to for its | |
93 | configuration. | |
94 | </p> | |
95 | </li> | |
96 | <li> | |
97 | <p> | |
98 | <code>external_ids:ovn-encap-type</code> specifies the | |
99 | encapsulation type that a chassis should use to connect to | |
100 | this node. Supported tunnel types for connecting | |
101 | hypervisors are <code>geneve</code> and <code>stt</code>. | |
102 | Gateways may use <code>geneve</code>, <code>vxlan</code>, | |
103 | or <code>stt</code>. | |
104 | </p> | |
105 | </li> | |
106 | <li> | |
107 | <p> | |
108 | <code>external_ids:ovn-encap-ip</code> specifies the IP | |
109 | address that a chassis should use to connect to this node | |
110 | using encapsulation type specified by | |
111 | <code>external_ids:ovn-encap-ip</code>. | |
112 | </p> | |
113 | </li> | |
114 | </ul> | |
115 | <p> | |
116 | Currently, <code>ovn-controller</code> does not support changing | |
117 | the chassis name, integration bridge, or OVN database mid-run. | |
118 | If these values need to change, the daemon must be restarted. | |
119 | This behavior should be changed. | |
120 | </p> | |
121 | </p> | |
122 | </manpage> |