Changes between Version 11 and Version 12 of GeniApiIdentifiers


Ignore:
Timestamp:
03/28/14 10:06:47 (9 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GeniApiIdentifiers

    v11 v12  
    4848
    4949''toplevelauthority''
    50  is an internationalized domain name (which must match the one in the certificate of the authority which issued the object name)
     50 is unique across the GENI federation and tied to a specific authority instance. By convention it should be an internationalized domain name (which must then match the one in the certificate of the authority which issued the object name)
    5151''sub-authority''
    52  is an internationalized domain name (which must match the one in the certificate of the authority which issued the object name)
     52 is unique within the "toplevelauthority" and by convention is often an internationalized domain name (which should then match the one in the certificate of the authority which issued the object name)
    5353''resource-type''
    5454 is a string describing the type of the named object (the set of strings is described [#Type below])
    5555''resource-name''
    56  should uniquely identify the object among any other resources with identical ''toplevelauthority'' and ''resource-type''. It is important to realize that the GENI API attaches no other significance to this field, and in particular, no relation is implied between objects with identical ''resource-name'' but differing ''toplevelauthority'' or ''resource-type''. However, individual authorities may choose to define additional semantics for resource names.
     56 should uniquely identify the object among any other resources with identical ''toplevelauthority''+"sub-authority" and ''resource-type''. It is important to realize that the GENI API attaches no other significance to this field, and in particular, no relation is implied between objects with identical ''resource-name'' but differing ''toplevelauthority'' or ''resource-type''. However, individual authorities may choose to define additional semantics for resource names.
    5757
    5858=== Examples and Usage ===
     
    8484Authority strings are to be treated as case insensitive for comparison purposes, though they should be case sensitive for display purposes (i.e. case preserving). This is consistent with the DNS standard as these are generally hostnames.
    8585
     86The authority in a URN should follow certain conventions for different URN types. The authority section of a URN issued by an authority must match the authority section of the URN of the authority that issued the URN, which is the authority that manages the existence of these objects. In particular
     87 - slice URNs are issued by a slice authority ("+authority+sa"), so the authority section of the slice URN matches that of the slice authority
     88 - user URNs are issued by a member authority or slice authority or clearinghouse ("+ma", "+sa"+, "+ch")
     89 - sliver URNs are issued by an aggregate ("+authority+am")
     90 - component URNs ("node" or "link" types for example) are issued by an aggregate or a component manager ("+authority+am" or "+authority+cm")
     91
    8692=== Type ===
    8793The <type> string has not yet been completely specified, but is used to identify the kind of resource being identified. Many APIs require use of URNs with particular types.  Use the defined types below, unless they simply do not fit for you.  In which case, please [mailto:help@geni.net contact the GPO] to inform them of your new type.
    8894
    8995`authority`
    90  A GENI service (i.e. an XMLRPC server). By convention, `resource-name` is am for an aggregate manager, sa for a slice authority. In principle, other names could be used for authorities.
     96 A GENI service (i.e. an XMLRPC server). By convention, `resource-name` is `am` for an aggregate manager, `sa` for a slice authority. In principle, other names could be used for authorities.
    9197`interface`
    92  A component which is an interface (an endpoint for links). The `toplevelauthority` must match that of the aggregate manager.
     98 A component which is an interface (an endpoint for links). The `toplevelauthority` must match that of the aggregate manager (or component manager).
    9399`link`
    94100 A component which is a network link (a connection between two or more interfaces). The `toplevelauthority` must match that of the aggregate manager.
     
    100106 A collection of resources which has been instantiated within a slice at a single aggregate. The `toplevelauthority` must match that of the aggregate manager; the corresponding slice is not identified in the sliver URN.
    101107`user`
    102  A GENI end user. Users are associated with slice authorities, but not unique slices; the slice to user correspondence is potentially many-to-many. The `toplevelauthority` must match that of the issuing authority.
     108 A GENI end user. Users are associated with slice or member authorities, but not unique slices; the slice to user correspondence is potentially many-to-many. The `toplevelauthority` must match that of the issuing authority.
    103109`vlan`
    104110 A shared VLAN, that may cross slices. This VLAN may or may not cross aggregates, as in the GENI openflow mesoscale. VLAN URNs should name the VLAN, not identify the specific VLAN tag, as that may vary across aggregates and switches.
     
    162168|| '%' || '%25 ||
    163169
    164 === FIXME ===
    165  - pointers to spots in gcf codebase
    166170}}}