LS Registration messages

From GEANT2-JRA1 Wiki

Contents 1 LS Registration messages 1.1 psservice definitions 1.2 Data field 2 Examples 2.1 Example 1(MA) 2.2 Example 2 (MA)

LS Registration messages

In the following the elements inside a LS registration message will be described. In order to register a perfSONAR service to an LS, various information is needed, while other information is not mandatory but helpful. There are also some elements needed by the gLS (global LS) to get summarized.

A registration message mainly contains two parts:

• psservice description (containing common information about your service)
• a data field containig metadata blocks providing information about the actual content/capabilities of your service

psservice definitions

See the rnc file for LS registration message, to find a definition for psservice elements: LSRegisterRequest.rnc

Data field

In the rnc file pointed to above, the following part allows for providing further information:

Data =
        element nmwg:data {
              Identifier &
              MetadataIdentifierRef &
              Metadata ?             
        }

As you can see, it is possible to register one or more metadata blocks. For a gLS, it is important to have certain kind of information provided in order to summarize these. If you like your service to be found globally, you should take care of that. In the following is a listing of possible elements in these metadata blocks:

This metadata block mainly is structured like metadata blocks in perfSONAR are generally structured:

• subject
• eventType
• parameters

In more detail:

• subject, containing topology information (see http://anonsvn.internet2.edu/svn/nmwg/trunk/nmwg/schema/rnc/topo/*.rnc), e.g:
  • node
  • interface
  • endpoint
  • endpointpair
    • src
    • dst
    • endpoint
  • domain
  • network
• eventType(s) (recommended) (all eventTypes which can be used with this service)
• parameters, e.g.:
  • parameter name=keyword (e.g. "GEANT2")
  • parameter name=supportedEventType (deprecated)
  • parameter name=eventType (deprecated)
  • parameter ...

There is a parameter called "keyword" which might be unfamilliar as it is not part of metadata blocks known from normal data requests to services so far. This keyword contains a string referring to the project or administrative group the data described by this metadata block belongs to. This is a field which enables users to find services with the gLS hosting potential useful data for them.

In general, it depends on the type of service (e.g. MA, MP or other), what exactly may be part of the metadata blocks. For an MA e,g, it makes sense to register a metadata block for each measurement stored in the MA. For MPs, it makes sense to register the node the MP is running on.

Examples

Example 1(MA)

<nmwg:metadata xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/" id="metadata.5">
  <owamp:subject xmlns:owamp="http://ggf.org/ns/nmwg/tools/owamp/2.0/" id="subject.5">
    <nmwgt:endPointPair xmlns:nmwgt="http://ggf.org/ns/nmwg/topology/2.0/">
       <nmwgt:src type="hostname" value="addressable.eecis.trap.edu"/>
       <nmwgt:dst type="hostname" value="dilled.vagrant.edu"/>
    </nmwgt:endPointPair>
  </owamp:subject>

  <nmwg:eventType>http://ggf.org/ns/nmwg/tools/owamp/2.0</nmwg:eventType>
  <nmwg:eventType>http://ggf.org/ns/nmwg/characteristic/delay/summary/20070921</nmwg:eventType>

  <nmwg:parameters id="parameters.5">
    <nmwg:parameter name="keyword">LHC</nmwg:parameter>     
    <nmwg:parameter name="keyword">Internet2</nmwg:parameter>
  </nmwg:parameters>
</nmwg:metadata>

Example 2 (MA)

<nmwg:metadata xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/" id="metadata.3">
  <iperf:subject xmlns:iperf="http://ggf.org/ns/nmwg/tools/iperf/2.0/" id="subject.3">
    <nmwgt:endPointPair xmlns:nmwgt="http://ggf.org/ns/nmwg/topology/2.0/">
      <nmwgt:src type="hostname" value="protoplasm.cis.trap.edu"/>
      <nmwgt:dst type="hostname" value="cray.eecis.padlocking.edu"/>
    </nmwgt:endPointPair>
  </iperf:subject>

  <nmwg:eventType>http://ggf.org/ns/nmwg/tools/iperf/2.0</nmwg:eventType>
  <nmwg:eventType>http://ggf.org/ns/nmwg/characteristics/bandwidth/acheiveable/2.0</nmwg:eventType>

  <nmwg:parameters id="parameters.3">
    <nmwg:parameter name="windowSize">1m</nmwg:parameter>
    <nmwg:parameter name="bufferLength">500</nmwg:parameter>
    <nmwg:parameter name="timeDuration">6</nmwg:parameter>
    <nmwg:parameter name="interval">2</nmwg:parameter>
    <nmwg:parameter name="protocol">UDP</nmwg:parameter>
    <nmwg:parameter name="bandwidthLimit">5m</nmwg:parameter>
    <nmwg:parameter name="keyword">LHC</nmwg:parameter>
    <nmwg:parameter name="keyword">Internet2</nmwg:parameter>
  </nmwg:parameters>
</nmwg:metadata>