Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pulling dist-docs from OVN branch-23.03 #88

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-appctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-architecture.7.pdf
Binary file not shown.
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-controller.8.pdf
Binary file not shown.
2 changes: 0 additions & 2 deletions src/static/support/dist-docs-branch-23.03/ovn-ctl.8
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,6 @@ This program is intended to be invoked internally by Open Virtual Network startu
.PP
\fB\-\-ovn\-user=\fIUSER:GROUP\fB\fR
.PP
\fB\-\-ovs\-user=\fIUSER:GROUP\fB\fR
.PP
\fB\-h\fR | \fB\-\-help\fR
.SH "FILE LOCATION OPTIONS"
.PP
Expand Down
2 changes: 0 additions & 2 deletions src/static/support/dist-docs-branch-23.03/ovn-ctl.8.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,6 @@

<b>-</b><b>-</b><b>o</b><b>v</b><b>n</b><b>-</b><b>u</b><b>s</b><b>e</b><b>r</b><b>=</b><u>U</u><u>S</u><u>E</u><u>R</u><u>:</u><u>G</u><u>R</u><u>O</u><u>U</u><u>P</u>

<b>-</b><b>-</b><b>o</b><b>v</b><b>s</b><b>-</b><b>u</b><b>s</b><b>e</b><b>r</b><b>=</b><u>U</u><u>S</u><u>E</u><u>R</u><u>:</u><u>G</u><u>R</u><u>O</u><u>U</u><u>P</u>

<b>-</b><b>h</b> | <b>-</b><b>-</b><b>h</b><b>e</b><b>l</b><b>p</b>

<b>F</b><b>I</b><b>L</b><b>E</b> <b>L</b><b>O</b><b>C</b><b>A</b><b>T</b><b>I</b><b>O</b><b>N</b> <b>O</b><b>P</b><b>T</b><b>I</b><b>O</b><b>N</b><b>S</b>
Expand Down
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-ctl.8.pdf
Binary file not shown.
2 changes: 0 additions & 2 deletions src/static/support/dist-docs-branch-23.03/ovn-ctl.8.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,6 @@ OPTIONS

--ovn-user=USER:GROUP

--ovs-user=USER:GROUP

-h | --help

FILE LOCATION OPTIONS
Expand Down
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-detrace.1.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-ic-nb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-ic-nbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-ic-sb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-ic-sbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-ic.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-nb.5.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-nbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-northd.8.pdf
Binary file not shown.
17 changes: 16 additions & 1 deletion src/static/support/dist-docs-branch-23.03/ovn-sb.5
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" p
.\" -*- nroff -*-
.TH "ovn-sb" 5 " DB Schema 20.27.0" "Open vSwitch 23.03.4" "Open vSwitch Manual"
.TH "ovn-sb" 5 " DB Schema 20.30.0" "Open vSwitch 23.03.4" "Open vSwitch Manual"
.fp 5 L CR \\" Make fixed-width font available as \\fL.
.de TQ
. br
Expand Down Expand Up @@ -3169,6 +3169,9 @@ optional weak reference to \fBChassis\fR
.TQ 3.00in
\fBports\fR
set of weak reference to \fBPort_Binding\fRs
.TQ 3.00in
\fBchassis_name\fR
string
.SS "Details:
.IP "\fBaddress\fR: string"
Destination IPv4 address for the IGMP group\[char46]
Expand All @@ -3178,6 +3181,8 @@ Datapath to which this IGMP group belongs\[char46]
Chassis to which this IGMP group belongs\[char46]
.IP "\fBports\fR: set of weak reference to \fBPort_Binding\fRs"
The destination port bindings for this IGMP group\[char46]
.IP "\fBchassis_name\fR: string"
The chassis that inserted this record\[char46] This column is used for RBAC purposes only\[char46]
.bp
.SH "Service_Monitor TABLE"
.PP
Expand Down Expand Up @@ -3210,6 +3215,9 @@ string
\fBsrc_ip\fR
string
.TQ 2.75in
\fBchassis_name\fR
string
.TQ 2.75in
\fBoptions : interval\fR
optional string, containing an integer
.TQ 2.75in
Expand Down Expand Up @@ -3254,6 +3262,8 @@ The VIF of the logical port on which the service is running\[char46] The \fBovn\
Source Ethernet address to use in the service monitor packet\[char46]
.IP "\fBsrc_ip\fR: string"
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"
The interval, in seconds, between service monitor checks\[char46]
.IP "\fBoptions : timeout\fR: optional string, containing an integer"
Expand Down Expand Up @@ -3367,6 +3377,9 @@ integer
\fBdetect_mult\fR
integer
.TQ 2.75in
\fBchassis_name\fR
string
.TQ 2.75in
\fBoptions\fR
map of string-string pairs
.TQ 2.75in
Expand Down Expand Up @@ -3397,6 +3410,8 @@ This is the minimum interval, in milliseconds, that the local system would like
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\[char46] If this value is zero, the transmitting system does not want the remote system to send any periodic BFD Control packets\[char46]
.IP "\fBdetect_mult\fR: integer"
Detection time multiplier\[char46] The negotiated transmit interval, multiplied by this value, provides the Detection Time for the receiving system in Asynchronous mode\[char46]
.IP "\fBchassis_name\fR: string"
The name of the chassis where the logical port is bound\[char46]
.IP "\fBoptions\fR: map of string-string pairs"
Reserved for future use\[char46]
.IP "\fBexternal_ids\fR: map of string-string pairs"
Expand Down
97 changes: 55 additions & 42 deletions src/static/support/dist-docs-branch-23.03/ovn-sb.5.html

Large diffs are not rendered by default.

Binary file modified src/static/support/dist-docs-branch-23.03/ovn-sb.5.pdf
Binary file not shown.
97 changes: 55 additions & 42 deletions src/static/support/dist-docs-branch-23.03/ovn-sb.5.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3641,6 +3641,7 @@ IGMP_Group TABLE
ing
chassis optional weak reference to Chassis
ports set of weak reference to Port_Bindings
chassis_name string

Details:
address: string
Expand All @@ -3655,13 +3656,17 @@ IGMP_Group TABLE
ports: set of weak reference to Port_Bindings
The destination port bindings for this IGMP group.

chassis_name: string
The chassis that inserted this record. This column is used for
RBAC purposes only.

Service_Monitor TABLE
Each row in this table configures monitoring a service for its live‐
Each row in this table configures monitoring a service for its live‐
ness. The service can be an IPv4 TCP or UDP service. ovn-controller pe‐
riodically sends out service monitor packets and updates the status of
riodically sends out service monitor packets and updates the status of
the service.

ovn-northd uses this feature to implement the load balancer health
ovn-northd uses this feature to implement the load balancer health
check feature offered to the CMS through the northbound database.

Summary:
Expand All @@ -3672,12 +3677,13 @@ Service_Monitor TABLE
logical_port string
src_mac string
src_ip string
chassis_name string
options : interval optional string, containing an integer
options : timeout optional string, containing an integer
options : success_count optional string, containing an integer
options : failure_count optional string, containing an integer
Status Reporting:
status optional string, one of error, offline,
status optional string, one of error, offline,
or online
Common Columns:
external_ids map of string-string pairs
Expand Down Expand Up @@ -3706,34 +3712,37 @@ Service_Monitor TABLE
Source Ethernet address to use in the service monitor packet.

src_ip: string
Source IPv4 or IPv6 address to use in the service monitor
Source IPv4 or IPv6 address to use in the service monitor
packet.

chassis_name: string
The name of the chassis where the logical port is bound.

options : interval: optional string, containing an integer
The interval, in seconds, between service monitor checks.

options : timeout: 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.

options : success_count: 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 online.

options : failure_count: 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 offline.

Status Reporting:

The ovn-controller on the chassis that hosts the logical_port updates
The ovn-controller on the chassis that hosts the logical_port updates
this column to report the service’s status.

status: optional string, one of error, offline, or online
For TCP service, ovn-controller sends a SYN to the service and
For TCP service, ovn-controller sends a SYN to the service and
expects an ACK response to consider the service to be online.

For UDP service, ovn-controller sends a UDP packet to the ser‐
For UDP service, ovn-controller 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 offline.

Expand All @@ -3760,40 +3769,40 @@ Load_Balancer TABLE

Details:
name: 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.

vips: map of string-string pairs
A map of virtual IP addresses (and an optional port number with
: 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
: as a separator) associated with this load balancer and their
corresponding endpoint IP addresses (and optional port numbers
with : as separators) separated by commas.

protocol: optional string, one of sctp, tcp, or udp
Valid protocols are tcp, udp, or sctp. This column is useful
when a port number is provided as part of the vips column. If
this column is empty and a port number is provided as part of
Valid protocols are tcp, udp, or sctp. This column is useful
when a port number is provided as part of the vips column. If
this column is empty and a port number is provided as part of
vips column, OVN assumes the protocol to be tcp.

datapaths: set of Datapath_Bindings
Datapaths to which this load balancer applies to.

datapath_group: optional Logical_DP_Group
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.

Load_Balancer options:

options : hairpin_snat_ip: 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 ovn-northd.

options : hairpin_orig_tuple: optional string, either true or false
This value is automatically set to true by ovn-northd 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 reg1, reg2, xxreg1.

Common Columns:
Expand All @@ -3813,6 +3822,7 @@ BFD TABLE
min_tx integer
min_rx integer
detect_mult integer
chassis_name string
options map of string-string pairs
external_ids map of string-string pairs
Status Reporting:
Expand All @@ -3823,12 +3833,12 @@ BFD TABLE
Configuration:

src_port: 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).

disc: 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.

logical_port: string
Expand All @@ -3838,22 +3848,25 @@ BFD TABLE
BFD peer IP address.

min_tx: 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.

min_rx: 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.

detect_mult: 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.

chassis_name: string
The name of the chassis where the logical port is bound.

options: map of string-string pairs
Reserved for future use.

Expand All @@ -3873,12 +3886,12 @@ BFD TABLE

• up
FDB TABLE
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
Logical_Switch_Port record in OVN_Northbound whose port security is
disabled and ’unknown’ address set. If port security is disabled on a
Logical_Switch_Port 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
Logical_Switch_Port record in OVN_Northbound whose port security is
disabled and ’unknown’ address set. If port security is disabled on a
Logical_Switch_Port 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 eth.dst is learnt.

Summary:
Expand Down Expand Up @@ -3923,7 +3936,7 @@ Static_MAC_Binding TABLE
The logical datapath to which the logical router port belongs.

Chassis_Template_Var TABLE
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 ovn-northd from the contents of the
OVN_Northbound.Chassis_Template_Var table.

Expand All @@ -3938,4 +3951,4 @@ Chassis_Template_Var TABLE
variables: map of string-string pairs
The set of variable values for a given chassis.

Open vSwitch 23.03.4 DB Schema 20.27.0 ovn-sb(5)
Open vSwitch 23.03.4 DB Schema 20.30.0 ovn-sb(5)
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-sbctl.8.pdf
Binary file not shown.
Binary file modified src/static/support/dist-docs-branch-23.03/ovn-trace.8.pdf
Binary file not shown.