[ovs-dev] [PATCH 5/6] ovn: add rbac tables to ovn southbound schema

[Ben Pfaff]

On Mon, May 01, 2017 at 10:13:27AM -0400, Lance Richardson wrote:
> Add rbac "roles" and "permissions" tables to ovn southbound
> database schema, add support to ovn-northd for managing these
> tables.
> 
> Signed-off-by: Lance Richardson <lrichard at redhat.com>

Thanks for writing this up!

One tip for database documentation is that it is usually unnecessary to
indicate the type of a column in the text itself, because the
documentation generator does that automatically.  For example,

    <column name="insert_delete">
        Boolean value, if "true" then row insertions and authorized row
        deletions are allowed.
    </column>

will render as:

       insert_delete: boolean
              Boolean  value, if "true" then row insertions and authorized row
              deletions are allowed.

which is somewhat redundant, so I'd tend to instead write:

    <column name="insert_delete">
        If <code>true</code>, then row insertions and authorized row
        deletions are allowed.
    </column>

and so on.

The first part of the new documentation in ovn-architecture describes
how RBAC works in general for OVSDB.  This might be suitable for central
documentation for OVSDB generally, for example in ovsdb-server(1).  Then
ovn-architecture could simply refer to it.