Skip to content

Commit

Permalink
dist-docs: Update OVN branch-23.06 manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Mar 1, 2024
1 parent a239ff8 commit cd7071a
Show file tree
Hide file tree
Showing 20 changed files with 80 additions and 78 deletions.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-appctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-architecture.7.pdf
Binary file not shown.
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-controller.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-ctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-detrace.1.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-ic-nb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-ic-nbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-ic-sb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-ic-sbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-ic.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-nb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-nbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-northd.8.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions src/static/support/dist-docs-branch-23.06/ovn-sb.5
Original file line number Diff line number Diff line change
Expand Up @@ -3206,7 +3206,7 @@ The destination port bindings for this IGMP group\[char46]
.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 @@ -3276,7 +3276,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 "\fBoptions : interval\fR: optional string, containing an integer"
The interval, in seconds, between service monitor checks\[char46]
.IP "\fBoptions : timeout\fR: optional string, containing an integer"
Expand Down
77 changes: 39 additions & 38 deletions src/static/support/dist-docs-branch-23.06/ovn-sb.5.html
Original file line number Diff line number Diff line change
Expand Up @@ -3692,7 +3692,7 @@
Each row in this table configures monitoring a service for its live‐
ness. The service can be an IPv4 TCP or UDP service. <b>o</b><b>v</b><b>n</b><b>-</b><b>c</b><b>o</b><b>n</b><b>t</b><b>r</b><b>o</b><b>l</b><b>l</b><b>e</b><b>r</b> pe‐
riodically sends out service monitor packets and updates the status of
the service. Service monitoring for IPv6 services is not supported.
the service.

<b>o</b><b>v</b><b>n</b><b>-</b><b>n</b><b>o</b><b>r</b><b>t</b><b>h</b><b>d</b> uses this feature to implement the load balancer health
check feature offered to the CMS through the northbound database.
Expand Down Expand Up @@ -3739,33 +3739,34 @@
Source Ethernet address to use in the service monitor packet.

<b>s</b><b>r</b><b>c</b><b>_</b><b>i</b><b>p</b>: string
Source IPv4 address to use in the service monitor packet.
Source IPv4 or IPv6 address to use in the service monitor
packet.

<b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b> <b>:</b> <b>i</b><b>n</b><b>t</b><b>e</b><b>r</b><b>v</b><b>a</b><b>l</b>: optional string, containing an integer
The interval, in seconds, between service monitor checks.

<b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b> <b>:</b> <b>t</b><b>i</b><b>m</b><b>e</b><b>o</b><b>u</b><b>t</b>: optional string, containing an integer
The time, in seconds, after which the service monitor check
The time, in seconds, after which the service monitor check
times out.

<b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b> <b>:</b> <b>s</b><b>u</b><b>c</b><b>c</b><b>e</b><b>s</b><b>s</b><b>_</b><b>c</b><b>o</b><b>u</b><b>n</b><b>t</b>: optional string, containing an integer
The number of successful checks after which the service is con‐
The number of successful checks after which the service is con‐
sidered <b>o</b><b>n</b><b>l</b><b>i</b><b>n</b><b>e</b>.

<b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b> <b>:</b> <b>f</b><b>a</b><b>i</b><b>l</b><b>u</b><b>r</b><b>e</b><b>_</b><b>c</b><b>o</b><b>u</b><b>n</b><b>t</b>: optional string, containing an integer
The number of failure checks after which the service is consid‐
The number of failure checks after which the service is consid‐
ered <b>o</b><b>f</b><b>f</b><b>l</b><b>i</b><b>n</b><b>e</b>.

<u>S</u><u>t</u><u>a</u><u>t</u><u>u</u><u>s</u> <u>R</u><u>e</u><u>p</u><u>o</u><u>r</u><u>t</u><u>i</u><u>n</u><u>g</u><u>:</u>

The <b>o</b><b>v</b><b>n</b><b>-</b><b>c</b><b>o</b><b>n</b><b>t</b><b>r</b><b>o</b><b>l</b><b>l</b><b>e</b><b>r</b> on the chassis that hosts the <b>l</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>p</b><b>o</b><b>r</b><b>t</b> updates
The <b>o</b><b>v</b><b>n</b><b>-</b><b>c</b><b>o</b><b>n</b><b>t</b><b>r</b><b>o</b><b>l</b><b>l</b><b>e</b><b>r</b> on the chassis that hosts the <b>l</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>p</b><b>o</b><b>r</b><b>t</b> updates
this column to report the service’s status.

<b>s</b><b>t</b><b>a</b><b>t</b><b>u</b><b>s</b>: optional string, one of <b>e</b><b>r</b><b>r</b><b>o</b><b>r</b>, <b>o</b><b>f</b><b>f</b><b>l</b><b>i</b><b>n</b><b>e</b>, or <b>o</b><b>n</b><b>l</b><b>i</b><b>n</b><b>e</b>
For TCP service, <b>o</b><b>v</b><b>n</b><b>-</b><b>c</b><b>o</b><b>n</b><b>t</b><b>r</b><b>o</b><b>l</b><b>l</b><b>e</b><b>r</b> sends a SYN to the service and
For TCP service, <b>o</b><b>v</b><b>n</b><b>-</b><b>c</b><b>o</b><b>n</b><b>t</b><b>r</b><b>o</b><b>l</b><b>l</b><b>e</b><b>r</b> sends a SYN to the service and
expects an ACK response to consider the service to be <b>o</b><b>n</b><b>l</b><b>i</b><b>n</b><b>e</b>.

For UDP service, <b>o</b><b>v</b><b>n</b><b>-</b><b>c</b><b>o</b><b>n</b><b>t</b><b>r</b><b>o</b><b>l</b><b>l</b><b>e</b><b>r</b> sends a UDP packet to the ser‐
For UDP service, <b>o</b><b>v</b><b>n</b><b>-</b><b>c</b><b>o</b><b>n</b><b>t</b><b>r</b><b>o</b><b>l</b><b>l</b><b>e</b><b>r</b> sends a UDP packet to the ser‐
vice and doesn’t expect any reply. If it receives an ICMP reply,
then it considers the service to be <b>o</b><b>f</b><b>f</b><b>l</b><b>i</b><b>n</b><b>e</b>.

Expand All @@ -3792,40 +3793,40 @@

<b>D</b><b>e</b><b>t</b><b>a</b><b>i</b><b>l</b><b>s</b><b>:</b>
<b>n</b><b>a</b><b>m</b><b>e</b>: string
A name for the load balancer. This name has no special meaning
or purpose other than to provide convenience for human interac‐
A name for the load balancer. This name has no special meaning
or purpose other than to provide convenience for human interac‐
tion with the ovn-nb database.

<b>v</b><b>i</b><b>p</b><b>s</b>: map of string-string pairs
A map of virtual IP addresses (and an optional port number with
<b>:</b> as a separator) associated with this load balancer and their
corresponding endpoint IP addresses (and optional port numbers
A map of virtual IP addresses (and an optional port number with
<b>:</b> as a separator) associated with this load balancer and their
corresponding endpoint IP addresses (and optional port numbers
with <b>:</b> as separators) separated by commas.

<b>p</b><b>r</b><b>o</b><b>t</b><b>o</b><b>c</b><b>o</b><b>l</b>: optional string, one of <b>s</b><b>c</b><b>t</b><b>p</b>, <b>t</b><b>c</b><b>p</b>, or <b>u</b><b>d</b><b>p</b>
Valid protocols are <b>t</b><b>c</b><b>p</b>, <b>u</b><b>d</b><b>p</b>, or <b>s</b><b>c</b><b>t</b><b>p</b>. This column is useful
when a port number is provided as part of the <b>v</b><b>i</b><b>p</b><b>s</b> column. If
this column is empty and a port number is provided as part of
Valid protocols are <b>t</b><b>c</b><b>p</b>, <b>u</b><b>d</b><b>p</b>, or <b>s</b><b>c</b><b>t</b><b>p</b>. This column is useful
when a port number is provided as part of the <b>v</b><b>i</b><b>p</b><b>s</b> column. If
this column is empty and a port number is provided as part of
<b>v</b><b>i</b><b>p</b><b>s</b> column, OVN assumes the protocol to be <b>t</b><b>c</b><b>p</b>.

<b>d</b><b>a</b><b>t</b><b>a</b><b>p</b><b>a</b><b>t</b><b>h</b><b>s</b>: set of <b>D</b><b>a</b><b>t</b><b>a</b><b>p</b><b>a</b><b>t</b><b>h</b><b>_</b><b>B</b><b>i</b><b>n</b><b>d</b><b>i</b><b>n</b><b>g</b>s
Datapaths to which this load balancer applies to.

<b>d</b><b>a</b><b>t</b><b>a</b><b>p</b><b>a</b><b>t</b><b>h</b><b>_</b><b>g</b><b>r</b><b>o</b><b>u</b><b>p</b>: optional <b>L</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>D</b><b>P</b><b>_</b><b>G</b><b>r</b><b>o</b><b>u</b><b>p</b>
The group of datapaths to which this load balancer applies to.
This means that the same load balancer applies to all datapaths
The group of datapaths to which this load balancer applies to.
This means that the same load balancer applies to all datapaths
in a group.

<u>L</u><u>o</u><u>a</u><u>d</u><b>_</b><u>B</u><u>a</u><u>l</u><u>a</u><u>n</u><u>c</u><u>e</u><u>r</u> <u>o</u><u>p</u><u>t</u><u>i</u><u>o</u><u>n</u><u>s</u><u>:</u>

<b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b> <b>:</b> <b>h</b><b>a</b><b>i</b><b>r</b><b>p</b><b>i</b><b>n</b><b>_</b><b>s</b><b>n</b><b>a</b><b>t</b><b>_</b><b>i</b><b>p</b>: optional string
IP to be used as source IP for packets that have been hair-
pinned after load balancing. This value is automatically popu‐
IP to be used as source IP for packets that have been hair-
pinned after load balancing. This value is automatically popu‐
lated by <b>o</b><b>v</b><b>n</b><b>-</b><b>n</b><b>o</b><b>r</b><b>t</b><b>h</b><b>d</b>.

<b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b> <b>:</b> <b>h</b><b>a</b><b>i</b><b>r</b><b>p</b><b>i</b><b>n</b><b>_</b><b>o</b><b>r</b><b>i</b><b>g</b><b>_</b><b>t</b><b>u</b><b>p</b><b>l</b><b>e</b>: optional string, either <b>t</b><b>r</b><b>u</b><b>e</b> or <b>f</b><b>a</b><b>l</b><b>s</b><b>e</b>
This value is automatically set to <b>t</b><b>r</b><b>u</b><b>e</b> by <b>o</b><b>v</b><b>n</b><b>-</b><b>n</b><b>o</b><b>r</b><b>t</b><b>h</b><b>d</b> when orig‐
inal destination IP and transport port of the load balanced
inal destination IP and transport port of the load balanced
packets are stored in registers <b>r</b><b>e</b><b>g</b><b>1</b><b>,</b> <b>r</b><b>e</b><b>g</b><b>2</b><b>,</b> <b>x</b><b>x</b><b>r</b><b>e</b><b>g</b><b>1</b>.

<u>C</u><u>o</u><u>m</u><u>m</u><u>o</u><u>n</u> <u>C</u><u>o</u><u>l</u><u>u</u><u>m</u><u>n</u><u>s</u><u>:</u>
Expand Down Expand Up @@ -3855,12 +3856,12 @@
<u>C</u><u>o</u><u>n</u><u>f</u><u>i</u><u>g</u><u>u</u><u>r</u><u>a</u><u>t</u><u>i</u><u>o</u><u>n</u><u>:</u>

<b>s</b><b>r</b><b>c</b><b>_</b><b>p</b><b>o</b><b>r</b><b>t</b>: integer, in range 49,152 to 65,535
udp source port used in bfd control packets. The source port
udp source port used in bfd control packets. The source port
MUST be in the range 49152 through 65535 (RFC5881 section 4).

<b>d</b><b>i</b><b>s</b><b>c</b>: integer
A unique, nonzero discriminator value generated by the transmit‐
ting system, used to demultiplex multiple BFD sessions between
ting system, used to demultiplex multiple BFD sessions between
the same pair of systems.

<b>l</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>p</b><b>o</b><b>r</b><b>t</b>: string
Expand All @@ -3870,20 +3871,20 @@
BFD peer IP address.

<b>m</b><b>i</b><b>n</b><b>_</b><b>t</b><b>x</b>: integer
This is the minimum interval, in milliseconds, that the local
system would like to use when transmitting BFD Control packets,
This is the minimum interval, in milliseconds, that the local
system would like to use when transmitting BFD Control packets,
less any jitter applied. The value zero is reserved.

<b>m</b><b>i</b><b>n</b><b>_</b><b>r</b><b>x</b>: integer
This is the minimum interval, in milliseconds, between received
BFD Control packets that this system is capable of supporting,
less any jitter applied by the sender. If this value is zero,
the transmitting system does not want the remote system to send
This is the minimum interval, in milliseconds, between received
BFD Control packets that this system is capable of supporting,
less any jitter applied by the sender. If this value is zero,
the transmitting system does not want the remote system to send
any periodic BFD Control packets.

<b>d</b><b>e</b><b>t</b><b>e</b><b>c</b><b>t</b><b>_</b><b>m</b><b>u</b><b>l</b><b>t</b>: integer
Detection time multiplier. The negotiated transmit interval,
multiplied by this value, provides the Detection Time for the
Detection time multiplier. The negotiated transmit interval,
multiplied by this value, provides the Detection Time for the
receiving system in Asynchronous mode.

<b>o</b><b>p</b><b>t</b><b>i</b><b>o</b><b>n</b><b>s</b>: map of string-string pairs
Expand All @@ -3905,12 +3906,12 @@

• <b>u</b><b>p</b>
<b>F</b><b>D</b><b>B</b> <b>T</b><b>A</b><b>B</b><b>L</b><b>E</b>
This table is primarily used to learn the MACs observed on a VIF (or a
localnet port with ’localnet_learn_fdb’ enabled) which belongs to a
<b>L</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>S</b><b>w</b><b>i</b><b>t</b><b>c</b><b>h</b><b>_</b><b>P</b><b>o</b><b>r</b><b>t</b> record in <b>O</b><b>V</b><b>N</b><b>_</b><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> whose port security is
disabled and ’unknown’ address set. If port security is disabled on a
<b>L</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>S</b><b>w</b><b>i</b><b>t</b><b>c</b><b>h</b><b>_</b><b>P</b><b>o</b><b>r</b><b>t</b> record, OVN should allow traffic with any source
mac from the VIF. This table will be used to deliver a packet to the
This table is primarily used to learn the MACs observed on a VIF (or a
localnet port with ’localnet_learn_fdb’ enabled) which belongs to a
<b>L</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>S</b><b>w</b><b>i</b><b>t</b><b>c</b><b>h</b><b>_</b><b>P</b><b>o</b><b>r</b><b>t</b> record in <b>O</b><b>V</b><b>N</b><b>_</b><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> whose port security is
disabled and ’unknown’ address set. If port security is disabled on a
<b>L</b><b>o</b><b>g</b><b>i</b><b>c</b><b>a</b><b>l</b><b>_</b><b>S</b><b>w</b><b>i</b><b>t</b><b>c</b><b>h</b><b>_</b><b>P</b><b>o</b><b>r</b><b>t</b> record, OVN should allow traffic with any source
mac from the VIF. This table will be used to deliver a packet to the
VIF, If a packet’s <b>e</b><b>t</b><b>h</b><b>.</b><b>d</b><b>s</b><b>t</b> is learnt.

<b>S</b><b>u</b><b>m</b><b>m</b><b>a</b><b>r</b><b>y</b><b>:</b>
Expand Down Expand Up @@ -3955,7 +3956,7 @@
The logical datapath to which the logical router port belongs.

<b>C</b><b>h</b><b>a</b><b>s</b><b>s</b><b>i</b><b>s</b><b>_</b><b>T</b><b>e</b><b>m</b><b>p</b><b>l</b><b>a</b><b>t</b><b>e</b><b>_</b><b>V</b><b>a</b><b>r</b> <b>T</b><b>A</b><b>B</b><b>L</b><b>E</b>
Each record represents the set of template variable instantiations for
Each record represents the set of template variable instantiations for
a given chassis and is populated by <b>o</b><b>v</b><b>n</b><b>-</b><b>n</b><b>o</b><b>r</b><b>t</b><b>h</b><b>d</b> from the contents of the
<b>O</b><b>V</b><b>N</b><b>_</b><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><b>.</b><b>C</b><b>h</b><b>a</b><b>s</b><b>s</b><b>i</b><b>s</b><b>_</b><b>T</b><b>e</b><b>m</b><b>p</b><b>l</b><b>a</b><b>t</b><b>e</b><b>_</b><b>V</b><b>a</b><b>r</b> table.

Expand Down
Binary file modified src/static/support/dist-docs-branch-23.06/ovn-sb.5.pdf
Binary file not shown.
Loading

0 comments on commit cd7071a

Please sign in to comment.