[ovs-dev] [PATCH 2/5] vswitch: Break out XenServer-specific external ids

[Ben Pfaff]

On Wed, Aug 25, 2010 at 04:10:20PM -0700, Justin Pettit wrote:
> As we move to new platforms, not all external identifiers will be
> universally unique, but the "-uuid" suffix seemingly prevents their use.
> Create new identifiers without the "-uuid" suffix.  Change the existing
> XenServer-specific external identifiers to contain a "xs-" prefix.  This
> also allows a XenServer integrator to define identifiers different from
> the XenServer UUIDs, but still leave them in the config database to be
> used by other programs.
> ---
>  vswitchd/vswitch.xml |   60 ++++++++++++++++++++++++++++++-------------------
>  1 files changed, 37 insertions(+), 23 deletions(-)
> 
> diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
> index 5789964..a415e76 100644
> --- a/vswitchd/vswitch.xml
> +++ b/vswitchd/vswitch.xml
> @@ -32,11 +32,19 @@
>          choose key names that are likely to be unique.  The currently
>          defined common key-value pairs are:
>          <dl>
> -          <dt><code>system-uuid</code></dt>
> -          <dd>A universally unique identifier for the Open vSwitch's
> -            physical host.  The form of the identifier depends on the
> -            type of the host.  On a Citrix XenServer, this is the host
> -            UUID displayed by, e.g., <code>xe host-list</code>.</dd>
> +          <dt><code>system-type</code></dt>
> +          <dd>An identifier for the switch type, such as "XenServer"
> +            or "KVM".</dd>

Most other places we give examples in <code></code> instead of "quotes".

> +          <dt><code>system-version</code></dt>
> +          <dd>The version of the switch software.</dd>

Might be good to give an example.

> @@ -187,13 +195,15 @@
>          integrators should either use the Open vSwitch development
>          mailing list to coordinate on common key-value definitions, or
>          choose key names that are likely to be unique.  The currently
> -        defined common key-value pairs are:
> +        defined key-value pairs are:
>          <dl>
> -          <dt><code>network-uuids</code></dt>
> +          <dt><code>bridge-id</code></dt>
> +          <dd>A unique identifer of the bridge.  On Citrix XenServer this 

"identifier"

> +            will commonly be the same as <code>xs-network-uuids</code>.</dd>
> +          <dt><code>xs-network-uuids</code></dt>
>            <dd>Semicolon-delimited set of universally unique identifier(s) for
> -            the network with which this bridge is associated.  The form of the
> -            identifier(s) depends on the type of the host.  On a Citrix
> -            XenServer host, the network identifiers are RFC 4122 UUIDs as
> +            the network with which this bridge is associated on a Citrix
> +            Xenserver host.  The network identifiers are RFC 4122 UUIDs as

"XenServer" I think.

>              displayed by, e.g., <code>xe network-list</code>.</dd>
>          </dl>
>        </column>

The rest looks OK.

I'm a little worried that this menagerie of identifiers will confuse
other people, since it confuses me.