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/Data Scoping"

From EGIWiki
Jump to navigation Jump to search
Line 337: Line 337:
<div style="mso-element:para-border-div;border:none;border-bottom:solid #4F81BD 1.0pt;
<div style="mso-element:para-border-div;border:none;border-bottom:solid #4F81BD 1.0pt;
padding:0cm 0cm 4.0pt 0cm">
padding:0cm 0cm 4.0pt 0cm">
= <span lang="EN-GB">EGI Data Scoping</span> =
= <span lang="EN-GB">
 
</span><span lang="EN-GB">Introduction</span> =
== <span lang="EN-GB">Introduction</span> ==


<span lang="EN-GB">To mark data within GOCDB as EGI data a new
<span lang="EN-GB">To mark data within GOCDB as EGI data a new
tagging system will be implemented. Such a tagging system will allow other
tagging system will be implemented. Such a tagging system will allow other
types of tags to be defined in future. These other tags can be used by NGIs
types of tags to be defined in future. These other tags can be used by NGIs
wishing to customise their GOCDB instance.</span>
wishing to customise their GOCDB instance.</span>  


== <span lang="EN-GB">Underlying Implementation</span> ==
= <span lang="EN-GB">Underlying Implementation</span> =


<span lang="EN-GB">A new PROM class called Tag will be
<span lang="EN-GB">A new PROM class called Tag will be
Line 353: Line 352:
SE, downtime, user or user role has a PROM link to the EGI tag then the object
SE, downtime, user or user role has a PROM link to the EGI tag then the object
will be exposed to the EGI infrastructure through the PI. If such an object
will be exposed to the EGI infrastructure through the PI. If such an object
isn’t tagged it won’t be exposed to the production infrastructure.</span>
isn’t tagged it won’t be exposed to the production infrastructure.</span>  


== <span lang="EN-GB">PI</span> ==
= <span lang="EN-GB">PI</span> =


<span lang="EN-GB">A regional GOCDB should provide a scope
<span lang="EN-GB">A regional GOCDB should provide a scope
Line 361: Line 360:
downtime, user or user role. This scope parameter will return objects only if
downtime, user or user role. This scope parameter will return objects only if
they are marked with the specific tag. In this use case the tag will always be
they are marked with the specific tag. In this use case the tag will always be
EGI.</span>
EGI.</span>  


<span lang="EN-GB">e.g. [https://goc.egi.eu/gocdbpi/private/?method=get_site&scope=egi https://goc.egi.eu/gocdbpi/private/?method=get_site&amp;scope=egi]</span>
<span lang="EN-GB">e.g. [https://goc.egi.eu/gocdbpi/private/?method=get_site&scope=egi https://goc.egi.eu/gocdbpi/private/?method=get_site&amp;scope=egi]</span>  


<span lang="EN-GB">A tag can also be used to include or
<span lang="EN-GB">A tag can also be used to include or
Line 369: Line 368:
intended for this functionality to be used as such in the future. The intention
intended for this functionality to be used as such in the future. The intention
is for a new set of PI queries to expose only EGI data. This data will then be
is for a new set of PI queries to expose only EGI data. This data will then be
read by the central GOCDB.</span>
read by the central GOCDB.</span>  


== <span lang="EN-GB">Scoping Rules</span>  ==
= <span lang="EN-GB">Scoping Rules</span>  =


<span lang="EN-GB">An EGI child must have an EGI parent (e.g.
<span lang="EN-GB">An EGI child must have an EGI parent (e.g.
an EGI SE must have a parent EGI site, an EGI role must have a parent EGI user
an EGI SE must have a parent EGI site, an EGI role must have a parent EGI user
etc).</span>
etc).</span>  


== <span lang="EN-GB">User Interface</span>  ==
= <span lang="EN-GB">User Interface</span>  =


<span lang="EN-GB">[[Image:DataScopingUI.PNG]]
<span lang="EN-GB">[[Image:DataScopingUI.PNG]]

Revision as of 17:31, 15 June 2011

= Introduction =

To mark data within GOCDB as EGI data a new tagging system will be implemented. Such a tagging system will allow other types of tags to be defined in future. These other tags can be used by NGIs wishing to customise their GOCDB instance.

Underlying Implementation

A new PROM class called Tag will be introduced that can be linked to sites, service endpoints, downtimes, users and user roles. We will create an instance of this tag class called EGI. If a site, SE, downtime, user or user role has a PROM link to the EGI tag then the object will be exposed to the EGI infrastructure through the PI. If such an object isn’t tagged it won’t be exposed to the production infrastructure.

PI

A regional GOCDB should provide a scope query parameter for all PI queries that can show data about a site, SE, downtime, user or user role. This scope parameter will return objects only if they are marked with the specific tag. In this use case the tag will always be EGI.

e.g. https://goc.egi.eu/gocdbpi/private/?method=get_site&scope=egi

A tag can also be used to include or exclude data from a regional to central GOCDB transfer mechanism. It is intended for this functionality to be used as such in the future. The intention is for a new set of PI queries to expose only EGI data. This data will then be read by the central GOCDB.

Scoping Rules

An EGI child must have an EGI parent (e.g. an EGI SE must have a parent EGI site, an EGI role must have a parent EGI user etc).

User Interface

DataScopingUI.PNG

The question mark button can be replaced with something more appropriate, however it should lead to a page explaining that marking data as EGI will send that data to the central GOCDB portal.

The user interface should enforce the scoping rules set out above. The UI should also automatically de/select the EGI tick box for new objects depending on whether their parents are EGI objects. For example, when adding a new service endpoint to an EGI site the EGI box in the Add New Service Endpoint form should be ticked by default. Similarly if a downtime is to be added to a set of non-EGI service endpoints the EGI box shouldn’t be ticked by default.

The web portal should be modified so that viewing a list of sites, SEs, downtimes and search results can be filtered by EGI / non-EGI.