Difference between revisions of "GOCDB/Release4/Regionalisation/Data Transfer Format"

From EGIWiki
Jump to: navigation, search
Line 23: Line 23:
 
     <!--
 
     <!--
 
     Tags will be defined as nested enum collections and supported values can be propagated to  
 
     Tags will be defined as nested enum collections and supported values can be propagated to  
     the central GOCDB (centrally defined xsd:enum values).  
+
     the central GOCDB while NGI specific tags will be ignored (centrally defined xsd:enum values).  
 
     -->  
 
     -->  
 
     <tags>  
 
     <tags>  
       <tag>EGI.EU</tag>
+
       <tag>EGI.EU</tag>          <!-- recognized by central GOCDB -->
       <tag>CentralVSiteA</tag>
+
       <tag>CentralVSiteA</tag>    <!-- recognized by central GOCDB (if tag has been declared centrally) -->
 +
      <tag>LocalCustomTagB</tag>  <!-- ignored by central GOCDB -->
 
     </tags>
 
     </tags>
 
   </site>
 
   </site>
</gocdb_data></source>
+
</gocdb_data>
 +
</source>
  
 
= Example 2  =
 
= Example 2  =
 +
 +
<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
 +
<gocdb_data>
 +
  <site operation="add">
 +
    <primary_key>4839G3</primary_key>
 +
    <short_name>NGS-SiteA</short_name>
 +
    <description>STFC, e-Science, DL</description>
 +
    <country>UK</country>
 +
    <ngi>UKI</ngi>
 +
    <timezone>GMT</timezone>
 +
    <certification_status>certified</certification_status>
 +
    <production_status>production</production_status>
 +
    <domain>dl.ac.uk</domain>
 +
    <!--
 +
    This centrally supported tag denotes a site that is published to the central GOCDB, but
 +
    remains out of the 'EGI.EU' scope.
 +
    -->
 +
    <tags>
 +
      <tag>REGIONAL.PUBLISHED</tag>         
 +
    </tags>
 +
  </site>
 +
</gocdb_data>
 +
</source>
 +
 +
= Example 3  =
  
 
This example shows a service endpoint being updated and a downtime being added. It also shows a user being deleted.  
 
This example shows a service endpoint being updated and a downtime being added. It also shows a user being deleted.  

Revision as of 14:09, 24 June 2011

Back to GOCDB/Documentation_Index
Back to GOCDB/Release4/Regionalisation

Introduction

The format of data transferred between a regional and central GOCDB instance is documented here. This will be a single XML document containing all objects that have been inserted, updated or deleted. The document will be constrained by a strongly typed XML schema that will also be published here (defining xsd:enums and xsd:patterns to validate element and attribute values).

Example

This example shows a single site being synchronised. This is a new site.

<?xml version="1.0" encoding="UTF-8"?>
<gocdb_data>
  <site operation="add">
    <primary_key>4839G3</primary_key>
    <short_name>RAL-LCG2</short_name>
    <description>STFC, e-Science, RAL</description>
    <country>UK</country>
    <ngi>UKI</ngi>
    <timezone>GMT</timezone>
    <certification_status>certified</certification_status>
    <production_status>production</production_status>
    <domain>rl.ac.uk</domain>
    <!--
    Tags will be defined as nested enum collections and supported values can be propagated to 
    the central GOCDB while NGI specific tags will be ignored (centrally defined xsd:enum values). 
    --> 
    <tags> 
       <tag>EGI.EU</tag>           <!-- recognized by central GOCDB -->
       <tag>CentralVSiteA</tag>    <!-- recognized by central GOCDB (if tag has been declared centrally) -->
       <tag>LocalCustomTagB</tag>  <!-- ignored by central GOCDB -->
    </tags>
  </site>
</gocdb_data>

Example 2

<?xml version="1.0" encoding="UTF-8"?>
<gocdb_data>
  <site operation="add">
    <primary_key>4839G3</primary_key>
    <short_name>NGS-SiteA</short_name>
    <description>STFC, e-Science, DL</description>
    <country>UK</country>
    <ngi>UKI</ngi>
    <timezone>GMT</timezone>
    <certification_status>certified</certification_status>
    <production_status>production</production_status>
    <domain>dl.ac.uk</domain>
    <!--
    This centrally supported tag denotes a site that is published to the central GOCDB, but 
    remains out of the 'EGI.EU' scope. 
    --> 
    <tags> 
       <tag>REGIONAL.PUBLISHED</tag>           
    </tags>
  </site>
</gocdb_data>

Example 3

This example shows a service endpoint being updated and a downtime being added. It also shows a user being deleted.

<?xml version="1.0" encoding="UTF-8"?>
<gocdb_data>
  <service_endpoint operation="update">
    <primary_key>449G3</primary_key>
    <hostname>test.host.com</hostname>
    <service_type>APEL</service_type>
    <ip>10.0.0.1</
    <site>RAL-LCG2</site>
    <tags> 
       <tag>EGI.EU</tag>
    </tags> 
  </service_endpoint>
  <user operation="delete">
    <primary_key>392G3</primary_key>
    <forename>Steven<forename>
    <surname>Newhouse</surname>
    <email>steve@egi.eu</email>
    <certificate_dn>/DC=com/DC=quovadisglobal/DC=grid/DC=switch/DC=users/C=CH/O=SWITCH/CN=Steven Newhouse</certificate_dn>
    <tags><tag>EGI.EU</tag></tags> 
  </user>
  <downtime operation="add">
    <primary_key>371G3</primary_key>
    <hosntame>test.host.com</hostname>
    <service_type>APEL</service_type>
    <endpoint>test.host.comAPEL</endpoint>
    <severity>OUTAGE</severity>
    <insert_date>1261486602</insert_date>
    <start_date>1261486500</start_date>
    <end_date>1261497600</end_date>
    <tags><tag>EGI.EU</tag></tags> 
  </downtime>
</gocdb_data>