Alert.png The wiki is deprecated and due to be decommissioned by the end of September 2022.
The content is being migrated to other supports, new updates will be ignored and lost.
If needed you can get in touch with EGI SDIS team using operations @ egi.eu.

Difference between revisions of "GOCDB/Transfer Data Format"

From EGIWiki
Jump to navigation Jump to search
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:Op menubar}}
{{Template:GOCDB_menubar}}
{{TOC_right}}
[[Category:GOCDB]]
= Introduction  =
= 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 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  =
= Example  =


This example shows a single site being synchronised. This site is either new or to be updated (operation=update).
This example shows a single site being synchronised. This is a new site.  


<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<gocdb_data>
<gocdb_data>
   <site scope="EGI" operation="Update">
   <site operation="add">
     <primary_key>4839G3</primary_key>
     <primary_key>4839G3</primary_key>
     <short_name>RAL-LCG2</short_name>
     <short_name>RAL-LCG2</short_name>
Line 19: Line 23:
     <production_status>production</production_status>
     <production_status>production</production_status>
     <domain>rl.ac.uk</domain>
     <domain>rl.ac.uk</domain>
    <!--
    Tags will be defined as nested enum collections and supported values can be propagated to
    the central GOCDB (centrally defined xsd:enum values).
    -->
    <tags>
      <tag>EGI.EU</tag>
      <tag>CentralVSiteA</tag>
    </tags>
   </site>
   </site>
</gocdb_data></source>  
</gocdb_data></source>


= Example 2  =
= Example 2  =


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


<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<gocdb_data>
<gocdb_data>
   <service_endpoint scope="EGI" operation="Update">
   <service_endpoint operation="update">
     <primary_key>449G3</primary_key>
     <primary_key>449G3</primary_key>
     <hostname>test.host.com</hostname>
     <hostname>test.host.com</hostname>
Line 34: Line 46:
     <ip>10.0.0.1</
     <ip>10.0.0.1</
     <site>RAL-LCG2</site>
     <site>RAL-LCG2</site>
    <tags>
      <tag>EGI.EU</tag>
    </tags>
   </service_endpoint>
   </service_endpoint>
   <user scope="EGI" operation="Update">
   <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>
   </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></source>
</gocdb_data></source>

Latest revision as of 12:33, 18 December 2012

Main EGI.eu operations services Support Documentation Tools Activities Performance Technology Catch-all Services Resource Allocation Security


GOC DB menu: Home Documentation Index


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 (centrally defined xsd:enum values). 
    --> 
    <tags> 
       <tag>EGI.EU</tag>
       <tag>CentralVSiteA</tag>
    </tags>
  </site>
</gocdb_data>

Example 2

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>