summaryrefslogtreecommitdiff
path: root/ovn/controller-vtep/ovn-controller-vtep.8.xml
blob: ca9b082a087a8425b593a155eeb72beb031751f4 (plain)
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
<?xml version="1.0" encoding="utf-8"?>
<manpage program="ovn-controller-vtep" section="8" title="ovn-controller-vtep">
    <h1>Name</h1>
    <p>ovn-controller-vtep -- Open Virtual Network local controller for
       vtep enabled physical switches.
    </p>

    <h1>Synopsis</h1>
    <p><code>ovn-controller-vtep</code> [<var>options</var>]
    [<var>--vtep-db=vtep-database</var>] [<var>--ovnsb-db=ovnsb-database</var>]
    </p>

    <h1>Description</h1>
    <p>
      <code>ovn-controller-vtep</code> is the local controller daemon in
      OVN, the Open Virtual Network, for VTEP enabled physical switches.
      It connects up to the OVN Southbound database (see
      <code>ovn-sb</code>(5)) over the OVSDB protocol, and down to the VTEP
      database (see <code>vtep</code>(5)) over the OVSDB protocol.
    </p>

    <h2>PKI Options</h2>
    <p>
      PKI configuration is required in order to use SSL for the connections to
      the VTEP and Southbound databases.
    </p>
    <xi:include href="lib/ssl.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
    <xi:include href="lib/ssl-bootstrap.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
    <xi:include href="lib/ssl-peer-ca-cert.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>

    <h1>Configuration</h1>
    <p>
      <code>ovn-controller-vtep</code> retrieves its configuration
      information from both the ovnsb and the vtep database.  If the
      database locations are not given from command line, the default
      is the <code>db.sock</code> in local OVSDB's 'run' directory.
      The datapath location must take one of the following forms:
    </p>
    <ul>
      <li>
        <p>
          <code>ssl:<var>ip</var>:<var>port</var></code>
        </p>
        <p>
          The specified SSL <var>port</var> on the host at the given
          <var>ip</var>, which must be expressed as an IP address (not a DNS
          name) in IPv4 or IPv6 address format.  If <var>ip</var> is an IPv6
          address, then wrap <var>ip</var> with square brackets, e.g.:
          <code>ssl:[::1]:6640</code>.  The <code>--private-key</code>,
          <code>--certificate</code> and either of <code>--ca-cert</code>
          or <code>--bootstrap-ca-cert</code> options are mandatory when this
          form is used.
        </p>
      </li>
      <li>
        <p>
          <code>tcp:<var>ip</var>:<var>port</var></code>
        </p>
        <p>
          Connect to the given TCP <var>port</var> on <var>ip</var>, where
          <var>ip</var> can be IPv4 or IPv6 address. If <var>ip</var> is an
          IPv6 address, then wrap <var>ip</var> with square brackets, e.g.:
          <code>tcp:[::1]:6640</code>.
        </p>
      </li>
      <li>
        <p>
          <code>unix:<var>file</var></code>
        </p>
        <p>
          On POSIX, connect to the Unix domain server socket named
          <var>file</var>.
        </p>
        <p>
          On Windows, connect to a localhost TCP port whose value is written
          in <var>file</var>.
        </p>
      </li>
    </ul>
</manpage>