Skip to content

Commit

Permalink
dist-docs: Update OVN main manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Mar 12, 2024
1 parent 916538b commit 271c134
Show file tree
Hide file tree
Showing 26 changed files with 1,789 additions and 1,760 deletions.
Binary file modified src/static/support/dist-docs/ovn-appctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-architecture.7.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-controller-vtep.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-controller.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-ctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-detrace.1.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-ic-nb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-ic-nbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-ic-sb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-ic-sbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs/ovn-ic.8.pdf
Binary file not shown.
5 changes: 5 additions & 0 deletions src/static/support/dist-docs/ovn-nb.5
Original file line number Diff line number Diff line change
Expand Up @@ -1088,6 +1088,9 @@ optional string
.TQ 2.50in
\fBoptions : hostname\fR
optional string
.TQ 2.50in
\fBoptions : pkt_clone_type\fR
optional string, must be \fBmc_unknown\fR
.TQ .25in
\fIVIF Plugging Options:\fR
.RS .25in
Expand Down Expand Up @@ -1342,6 +1345,8 @@ If set, indicates the maximum rate for data sent from this interface, in bit/s\[
If set, indicates the maximum burst size for data sent from this interface, in bits\[char46]
.IP "\fBoptions : hostname\fR: optional string"
If set, indicates the DHCPv4 option \(dqHostname\(dq (option code 12) associated for this Logical Switch Port\[char46] If DHCPv4 is enabled for this Logical Switch Port, hostname dhcp option will be included in DHCP reply\[char46]
.IP "\fBoptions : pkt_clone_type\fR: optional string, must be \fBmc_unknown\fR"
If set to mc_unknown, packets going to this VIF get cloned to all unknown ports connected to the same Logical Switch\[char46]
.ST "VIF Plugging Options:"
.PP
.IP "\fBoptions : vif-plug-type\fR: optional string"
Expand Down
1,673 changes: 839 additions & 834 deletions src/static/support/dist-docs/ovn-nb.5.html

Large diffs are not rendered by default.

Binary file modified src/static/support/dist-docs/ovn-nb.5.pdf
Binary file not shown.
1,673 changes: 839 additions & 834 deletions src/static/support/dist-docs/ovn-nb.5.txt

Large diffs are not rendered by default.

Binary file modified src/static/support/dist-docs/ovn-nbctl.8.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions src/static/support/dist-docs/ovn-northd.8
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ Priority\-50 flows that match ARP requests to each known IP address \fIA\fR of e
.fi
.IP
These flows are omitted for logical ports (other than router ports or \fBlocalport\fR ports) that are down (unless \fB
ignore_lsp_down\fR is configured as true in \fBoptions\fR column of \fBNB_Global\fR table of the \fBNorthbound\fR database), for logical ports of type \fBvirtual\fR, for logical ports with \(cqunknown\(cq address set and for logical ports of a logical switch configured with \fBother_config:vlan\-passthru=true\fR\[char46]
ignore_lsp_down\fR is configured as true in \fBoptions\fR column of \fBNB_Global\fR table of the \fBNorthbound\fR database), for logical ports of type \fBvirtual\fR, for logical ports with \(cqunknown\(cq address set, for logical ports with the \fBoptions:disable_arp_nd_rsp=true\fR and for logical ports of a logical switch configured with \fBother_config:vlan\-passthru=true\fR\[char46]
.IP
The above ARP responder flows are added for the list of IPv4 addresses if defined in \fBoptions:arp_proxy\fR column of \fBLogical_Switch_Port\fR table for logical switch ports of type \fBrouter\fR\[char46]
.IP \(bu
Expand Down Expand Up @@ -1100,7 +1100,7 @@ A priority\-72 flow that outputs all ARP requests and ND packets with an Etherne
.IP \(bu
A priority\-70 flow that outputs all packets with an Ethernet broadcast or multicast \fBeth\[char46]dst\fR to the \fBMC_FLOOD\fR multicast group\[char46]
.IP \(bu
One priority\-50 flow that matches each known Ethernet address against \fBeth\[char46]dst\fR\[char46] Action of this flow outputs the packet to the single associated output port if it is enabled\[char46] \fBdrop;\fR action is applied if LSP is disabled\[char46]
One priority\-50 flow that matches each known Ethernet address against \fBeth\[char46]dst\fR\[char46] Action of this flow outputs the packet to the single associated output port if it is enabled\[char46] \fBdrop;\fR action is applied if LSP is disabled\[char46] If the logical switch port of type VIF has the option \fBoptions:pkt_clone_type\fR is set to the value \fBmc_unknown\fR, then the packet is also forwarded to the \fBMC_UNKNOWN\fR multicast group\[char46]
.IP
For the Ethernet address on a logical switch port of type \fBrouter\fR, when that logical switch port\(cqs \fBaddresses\fR column is set to \fBrouter\fR and the connected logical router port has a gateway chassis:
.RS
Expand Down
12 changes: 9 additions & 3 deletions src/static/support/dist-docs/ovn-northd.8.html
Original file line number Diff line number Diff line change
Expand Up @@ -1251,8 +1251,10 @@
<b>i</b><b>g</b><b>n</b><b>o</b><b>r</b><b>e</b><b>_</b><b>l</b><b>s</b><b>p</b><b>_</b><b>d</b><b>o</b><b>w</b><b>n</b> is configured as true in <b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b> column
of <b>N</b><b>B</b><b>_</b><b>G</b><b>l</b><b>o</b><b>b</b><b>a</b><b>l</b> table of the <b>N</b><b>o</b><b>r</b><b>t</b><b>h</b><b>b</b><b>o</b><b>u</b><b>n</b><b>d</b> database), for logi‐
cal ports of type <b>v</b><b>i</b><b>r</b><b>t</b><b>u</b><b>a</b><b>l</b>, for logical ports with ’un‐
known’ address set and for logical ports of a logical
switch configured with <b>o</b><b>t</b><b>h</b><b>e</b><b>r</b><b>_</b><b>c</b><b>o</b><b>n</b><b>f</b><b>i</b><b>g</b><b>:</b><b>v</b><b>l</b><b>a</b><b>n</b><b>-</b><b>p</b><b>a</b><b>s</b><b>s</b><b>t</b><b>h</b><b>r</b><b>u</b><b>=</b><b>t</b><b>r</b><b>u</b><b>e</b>.
known’ address set, for logical ports with the <b>o</b><b>p</b>‐‐
<b>t</b><b>i</b><b>o</b><b>n</b><b>s</b><b>:</b><b>d</b><b>i</b><b>s</b><b>a</b><b>b</b><b>l</b><b>e</b><b>_</b><b>a</b><b>r</b><b>p</b><b>_</b><b>n</b><b>d</b><b>_</b><b>r</b><b>s</b><b>p</b><b>=</b><b>t</b><b>r</b><b>u</b><b>e</b> and for logical ports of a
logical switch configured with <b>o</b><b>t</b><b>h</b><b>e</b><b>r</b><b>_</b><b>c</b><b>o</b><b>n</b>‐‐
<b>f</b><b>i</b><b>g</b><b>:</b><b>v</b><b>l</b><b>a</b><b>n</b><b>-</b><b>p</b><b>a</b><b>s</b><b>s</b><b>t</b><b>h</b><b>r</b><b>u</b><b>=</b><b>t</b><b>r</b><b>u</b><b>e</b>.

The above ARP responder flows are added for the list of
IPv4 addresses if defined in <b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b><b>:</b><b>a</b><b>r</b><b>p</b><b>_</b><b>p</b><b>r</b><b>o</b><b>x</b><b>y</b> column of
Expand Down Expand Up @@ -1644,7 +1646,11 @@
• One priority-50 flow that matches each known Ethernet ad‐
dress against <b>e</b><b>t</b><b>h</b><b>.</b><b>d</b><b>s</b><b>t</b>. Action of this flow outputs the
packet to the single associated output port if it is en‐
abled. <b>d</b><b>r</b><b>o</b><b>p</b><b>;</b> action is applied if LSP is disabled.
abled. <b>d</b><b>r</b><b>o</b><b>p</b><b>;</b> action is applied if LSP is disabled. If the
logical switch port of type VIF has the option <b>o</b><b>p</b>‐‐
<b>t</b><b>i</b><b>o</b><b>n</b><b>s</b><b>:</b><b>p</b><b>k</b><b>t</b><b>_</b><b>c</b><b>l</b><b>o</b><b>n</b><b>e</b><b>_</b><b>t</b><b>y</b><b>p</b><b>e</b> is set to the value <b>m</b><b>c</b><b>_</b><b>u</b><b>n</b><b>k</b><b>n</b><b>o</b><b>w</b><b>n</b>, then
the packet is also forwarded to the <b>M</b><b>C</b><b>_</b><b>U</b><b>N</b><b>K</b><b>N</b><b>O</b><b>W</b><b>N</b> multicast
group.

For the Ethernet address on a logical switch port of type
<b>r</b><b>o</b><b>u</b><b>t</b><b>e</b><b>r</b>, when that logical switch port’s <b>a</b><b>d</b><b>d</b><b>r</b><b>e</b><b>s</b><b>s</b><b>e</b><b>s</b> column
Expand Down
Binary file modified src/static/support/dist-docs/ovn-northd.8.pdf
Binary file not shown.
12 changes: 9 additions & 3 deletions src/static/support/dist-docs/ovn-northd.8.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1250,8 +1250,10 @@ LOGICAL FLOW TABLE STRUCTURE
ignore_lsp_down is configured as true in options column
of NB_Global table of the Northbound database), for logi‐
cal ports of type virtual, for logical ports with ’un‐
known’ address set and for logical ports of a logical
switch configured with other_config:vlan-passthru=true.
known’ address set, for logical ports with the op�‐
tions:disable_arp_nd_rsp=true and for logical ports of a
logical switch configured with other_con�‐
fig:vlan-passthru=true.

The above ARP responder flows are added for the list of
IPv4 addresses if defined in options:arp_proxy column of
Expand Down Expand Up @@ -1643,7 +1645,11 @@ LOGICAL FLOW TABLE STRUCTURE
• One priority-50 flow that matches each known Ethernet ad‐
dress against eth.dst. Action of this flow outputs the
packet to the single associated output port if it is en‐
abled. drop; action is applied if LSP is disabled.
abled. drop; action is applied if LSP is disabled. If the
logical switch port of type VIF has the option op�‐
tions:pkt_clone_type is set to the value mc_unknown, then
the packet is also forwarded to the MC_UNKNOWN multicast
group.

For the Ethernet address on a logical switch port of type
router, when that logical switch port’s addresses column
Expand Down
4 changes: 2 additions & 2 deletions src/static/support/dist-docs/ovn-sb.5
Original file line number Diff line number Diff line change
Expand Up @@ -3225,7 +3225,7 @@ The chassis that inserted this record\[char46] This column is used for RBAC purp
.PP
.PP
.PP
Each row in this table configures monitoring a service for its liveness\[char46] The service can be an IPv4 TCP or UDP service\[char46] \fBovn\-controller\fR periodically sends out service monitor packets and updates the status of the service\[char46] Service monitoring for IPv6 services is not supported\[char46]
Each row in this table configures monitoring a service for its liveness\[char46] The service can be an IPv4 TCP or UDP service\[char46] \fBovn\-controller\fR periodically sends out service monitor packets and updates the status of the service\[char46]
.PP
.PP
\fBovn\-northd\fR uses this feature to implement the load balancer health check feature offered to the CMS through the northbound database\[char46]
Expand Down Expand Up @@ -3298,7 +3298,7 @@ The VIF of the logical port on which the service is running\[char46] The \fBovn\
.IP "\fBsrc_mac\fR: string"
Source Ethernet address to use in the service monitor packet\[char46]
.IP "\fBsrc_ip\fR: string"
Source IPv4 address to use in the service monitor packet\[char46]
Source IPv4 or IPv6 address to use in the service monitor packet\[char46]
.IP "\fBchassis_name\fR: string"
The name of the chassis where the logical port is bound\[char46]
.IP "\fBoptions : interval\fR: optional string, containing an integer"
Expand Down
Loading

0 comments on commit 271c134

Please sign in to comment.