Changes between Version 11 and Version 12 of TopdlLibrary

Timestamp:

Oct 8, 2012 9:11:31 AM (12 years ago)

Author:

faber

Comment:

--

TopdlLibrary

@@ -166 +166 @@
  {{{name}}}::
    A string, the unique name of the substrate.
- {{{capacity}}::
+ {{{capacity}}}::
    A [TopdlLibrary#CapacityClass Capacity object] that gives the default capacity of the substrate.  It may be None, incdicating that there is no default.
- {{{latency}}::
+ {{{latency}}}::
    A [TopdlLibrary#LatencyClass Latency object] that gives the default latency of the substrate.  It may be None, incdicating that there is no default.
  {{{attribute}}}::
@@ -317 +317 @@
 The constructor will take the member names as named parameters.
 
+== Testbed Class ==
+
+This class represents a testbed that has allocated resources or from which an allocation is requested.  While it is primarily used internally by the federation system, some other applications include a {{{Testbed}}} as a place to attach attributes that pertain to the whole topology.
+
+It includes the following members:
+
+ {{{uri}}}::
+  A string containing the URI on which the testbed can be contacted.  Usually a fedd URI.
+ {{{type}}::
+  A string indicating the underlying type of the testbed.  Values include "deter," "emulab," and "protoGENI".
+ {{{interface}}}::
+   A list of [TopdlLibrary#InterfaceClass Interface objects] that describe connections of the Testbed to communications substrates.  The list may be empty, meaning that the testbed is not connected to any substrates.
+ {{{attribute}}}::
+   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the Testbed.  The list may be empty.
+ {{{localname}}}::
+   A list of strings giving alternative names for the testbed. The list may be empty, meaning no such alternatives exist.
+ {{{status}}}::
+   A string indicating the current status of the Testbed (if any).  It may also be None, indicating no status is reported.  Valid values are
+     * "empty" - no allocation of resources has been attempted - generally not applied to Testbeds
+     * "active" - Testbed is functioning as part of an experiment
+     * "inactive" - Testbed is allocated, but not functioning
+     * "starting" - Testbed is transitioning from "inactive" to "active"
+     * "terminating" - Testbed is transitioning from "active" to "inactive"
+     * "failed" - an allocation of resources has failed - generally not applied to Testbed
+ {{{service}}}::
+   A list of [TopdlLibrary#ServiceClass Service objects] that describe the services this Testbed uses or supplies.  These are generally used by the federation system, and their definition is somewhat in flux. The list may be empty.
+ {{{operation}}}::
+   A list of strings that describe the valid operations on the Testbed.  These are generally used by the federation system, and their definition is somewhat in flux.The list may be empty.
+
+The constructor takes the member names as named parameters.
+
+== Segment Class ==
+
+This class represents a sub-experiment of a federated experiment about which the details are unknown except for its interfaces.  It is primarily used internally by teh federation system.
+
+It has the following members:
+
+ {{{id}}}::
+  An [TopdlLibrary#IDClass ID object] that identifies this segment.
+ {{{type}}}::
+  A string indicating the underlying type of the testbed.  Values include "deter," "emulab," and "protoGENI".
+ {{{interface}}}::
+   A list of [TopdlLibrary#InterfaceClass Interface objects] that describe connections of the segment to communications substrates.  The list may be empty, meaning that the segment is not connected to any substrates.
+ {{{attribute}}}::
+   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the segment.  The list may be empty.
+
+== ID Class ==
+
+This class represents a polymorphic identifier as used by the federation system.  At most one of its members is set.
+
+Those members are:
+
+ {{{fedid}}}::
+   A fedid object, representing the hash of a principal key.  This represents a [FeddAbout#GlobalIdentifiers:Fedids fedid].
+ {{{uuid}}}::
+   A string holding a UUID URI.
+ {{{uri}}}::
+   A string holding a generic URI
+ {{{localname}}}::
+   A string holding a locally scoped name
+ {{{kerberosUsername}}::
+   A kerberos user name.
+
+The constructor accepts the member names as named parameters.
+
+== Other Class ==
+
+This class represents a topology element that is not captured above.  It is a set of interfaces and a place to hang attributes, for use encoding kinds of elements unknown when topdl was specified.
+
+The members are:
+
+ {{{interface}}}::
+   A list of [TopdlLibrary#InterfaceClass Interface objects] that describe connections of the element to communications substrates.  The list may be empty, meaning that the element is not connected to any substrates.
+ {{{attribute}}}::
+   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the element.  The list may be empty.
+
+The constructor accepts the member names as named parameters.
 
 = Examples =