Re: [ovs-dev] [PATCH] ovn-controller: Document southbound database use and graceful termination.

2018-02-02 Thread Ben Pfaff
On Fri, Feb 02, 2018 at 12:07:26PM -0800, Han Zhou wrote:
> On Fri, Feb 2, 2018 at 9:44 AM, Ben Pfaff  wrote:
> >
> > A lot of people seem to think that "kill" gracefully terminates
> > ovn-controller, but it doesn't, so this documentation at least provides
> > something to point to.
> >
> > Signed-off-by: Ben Pfaff 
> > ---
> >  ovn/controller/ovn-controller.8.xml | 47
> +
> >  1 file changed, 47 insertions(+)
> >
> > diff --git a/ovn/controller/ovn-controller.8.xml
> b/ovn/controller/ovn-controller.8.xml
> > index 0df59acd3c8b..96a58ddf358d 100644
> > --- a/ovn/controller/ovn-controller.8.xml
> > +++ b/ovn/controller/ovn-controller.8.xml
> > @@ -304,6 +304,53 @@
> >
> >  
> >
> > +OVN Southbound Database Usage
> > +
> > +
> > +  ovn-controller reads from much of the
> > +  OVN_Southbound database to guide its operation.
> > +  ovn-controller also writes to the following tables:
> > +
> > +
> > +
> > +  Chassis
> > +  
> > +Upon startup, ovn-controller creates a row in this
> table
> > +to represent its own chassis.  Upon graceful termination, e.g.
> with
> > +ovs-appctl -t ovn-controller exit (but not
> > +SIGTERM), ovn-controller removes its
> row.
> > +  
> > +
> > +  Encap
> > +  
> > +Upon startup, ovn-controller creates a row or rows
> in this
> > +table that represent the tunnel encapsulations by which its
> chassis can
> > +be reached, and points its Chassis row to them.
> Upon
> > +graceful termination, ovn-controller removes these
> rows.
> > +  
> > +
> > +  Port_Binding
> > +  
> > +At runtime, ovn-controller sets the
> chassis
> > +columns of ports that are resident on its chassis to point to its
> > +Chassis row, and, conversely, clears the
> > +chassis column of ports that point to its
> > +Chassis row but are no longer resident on its
> chassis.
> > +The chassis column has a weak reference type, so
> when
> > +ovn-controller gracefully exits and removes its
> > +Chassis row, the database server automatically
> clears any
> > +remaining references to that row.
> > +  
> > +
> > +  MAC_Binding
> > +  
> > +At runtime, ovn-controller updates the
> > +MAC_Binding table as instructed by
> put_arp
> > +and put_nd logical actions.  These changes persist
> beyond
> > +the lifetime of ovn-controller.
> > +  
> > +
> > +
> >  Runtime Management Commands
> >  
> >ovs-appctl can send commands to a running
> > --
> > 2.15.1
> >
> 
> Thanks Ben!
> 
> Acked-by: Han Zhou 

Thanks for the review!  I applied this to master.
___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev


Re: [ovs-dev] [PATCH] ovn-controller: Document southbound database use and graceful termination.

2018-02-02 Thread Han Zhou
On Fri, Feb 2, 2018 at 9:44 AM, Ben Pfaff  wrote:
>
> A lot of people seem to think that "kill" gracefully terminates
> ovn-controller, but it doesn't, so this documentation at least provides
> something to point to.
>
> Signed-off-by: Ben Pfaff 
> ---
>  ovn/controller/ovn-controller.8.xml | 47
+
>  1 file changed, 47 insertions(+)
>
> diff --git a/ovn/controller/ovn-controller.8.xml
b/ovn/controller/ovn-controller.8.xml
> index 0df59acd3c8b..96a58ddf358d 100644
> --- a/ovn/controller/ovn-controller.8.xml
> +++ b/ovn/controller/ovn-controller.8.xml
> @@ -304,6 +304,53 @@
>
>  
>
> +OVN Southbound Database Usage
> +
> +
> +  ovn-controller reads from much of the
> +  OVN_Southbound database to guide its operation.
> +  ovn-controller also writes to the following tables:
> +
> +
> +
> +  Chassis
> +  
> +Upon startup, ovn-controller creates a row in this
table
> +to represent its own chassis.  Upon graceful termination, e.g.
with
> +ovs-appctl -t ovn-controller exit (but not
> +SIGTERM), ovn-controller removes its
row.
> +  
> +
> +  Encap
> +  
> +Upon startup, ovn-controller creates a row or rows
in this
> +table that represent the tunnel encapsulations by which its
chassis can
> +be reached, and points its Chassis row to them.
Upon
> +graceful termination, ovn-controller removes these
rows.
> +  
> +
> +  Port_Binding
> +  
> +At runtime, ovn-controller sets the
chassis
> +columns of ports that are resident on its chassis to point to its
> +Chassis row, and, conversely, clears the
> +chassis column of ports that point to its
> +Chassis row but are no longer resident on its
chassis.
> +The chassis column has a weak reference type, so
when
> +ovn-controller gracefully exits and removes its
> +Chassis row, the database server automatically
clears any
> +remaining references to that row.
> +  
> +
> +  MAC_Binding
> +  
> +At runtime, ovn-controller updates the
> +MAC_Binding table as instructed by
put_arp
> +and put_nd logical actions.  These changes persist
beyond
> +the lifetime of ovn-controller.
> +  
> +
> +
>  Runtime Management Commands
>  
>ovs-appctl can send commands to a running
> --
> 2.15.1
>

Thanks Ben!

Acked-by: Han Zhou 
___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev


[ovs-dev] [PATCH] ovn-controller: Document southbound database use and graceful termination.

2018-02-02 Thread Ben Pfaff
A lot of people seem to think that "kill" gracefully terminates
ovn-controller, but it doesn't, so this documentation at least provides
something to point to.

Signed-off-by: Ben Pfaff 
---
 ovn/controller/ovn-controller.8.xml | 47 +
 1 file changed, 47 insertions(+)

diff --git a/ovn/controller/ovn-controller.8.xml 
b/ovn/controller/ovn-controller.8.xml
index 0df59acd3c8b..96a58ddf358d 100644
--- a/ovn/controller/ovn-controller.8.xml
+++ b/ovn/controller/ovn-controller.8.xml
@@ -304,6 +304,53 @@
   
 
 
+OVN Southbound Database Usage
+
+
+  ovn-controller reads from much of the
+  OVN_Southbound database to guide its operation.
+  ovn-controller also writes to the following tables:
+
+
+
+  Chassis
+  
+Upon startup, ovn-controller creates a row in this table
+to represent its own chassis.  Upon graceful termination, e.g. with
+ovs-appctl -t ovn-controller exit (but not
+SIGTERM), ovn-controller removes its row.
+  
+
+  Encap
+  
+Upon startup, ovn-controller creates a row or rows in this
+table that represent the tunnel encapsulations by which its chassis can
+be reached, and points its Chassis row to them.  Upon
+graceful termination, ovn-controller removes these rows.
+  
+
+  Port_Binding
+  
+At runtime, ovn-controller sets the chassis
+columns of ports that are resident on its chassis to point to its
+Chassis row, and, conversely, clears the
+chassis column of ports that point to its
+Chassis row but are no longer resident on its chassis.
+The chassis column has a weak reference type, so when
+ovn-controller gracefully exits and removes its
+Chassis row, the database server automatically clears any
+remaining references to that row.
+  
+
+  MAC_Binding
+  
+At runtime, ovn-controller updates the
+MAC_Binding table as instructed by put_arp
+and put_nd logical actions.  These changes persist beyond
+the lifetime of ovn-controller.
+  
+
+
 Runtime Management Commands
 
   ovs-appctl can send commands to a running
-- 
2.15.1

___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev