| Info | ||
|---|---|---|
| ||
Please don't use this Tutorial for nowwith caution, we are currently updating it. |
| Metadata list | ||
|---|---|---|
| ||
|| workpackage | WP6 | || task | 2 | || document number | 007 | || document version | 0.15 | || document title | EPN-TAP Installation forRegistering your VESPA DataEPN-TAP Provider Tutorial — Part 2 | Server | || document type | TD | |
EPN2020-RI
EUROPLANET2020 Research Infrastructure
H2020-INFRAIA-2014-2015
Grant agreement no: 654208
Document: VESPA-
-taskMetadata from 1 workpackage
-Metadata from 1 task
-vMetadata from 1 document number
versionMetadata from 1 document
(-vtype current
page-versionMetadata (Metadata Plugin)-
)from
1 document version
| Metadata from | ||
|---|---|---|
|
Date:
| current-page-date |
|---|
Start date of project: 01 September 2015
Duration: 48 Months
Responsible WP Leader: OBSPARIS / Stéphane Erard
Project co-funded by the European Union's Horizon 2020 research and innovation programme | ||
Dissemination level | ||
PU | Public | |
PP | Restricted to other programme participants (including the Commission Service) | |
RE | Restricted to a group specified by the consortium (including the Commission Services) | |
CO | Confidential, only for members of the consortium (excluding the Commission Services) | |
Project Number | 654208 |
Project Title | EPN2020 - RI |
Project Duration | 48 months: 01 September 2015 – 30 August 2019 |
| Pagebreak |
|---|
Document Number | VESPA-
|
| |||||||||||||||||
Delivery date |
| |||||
Title of Document |
| ||||
Contributing Work package (s) |
| ||||
Dissemination level | PU | ||||
Author (s) |
Abstract: |
This tutorial describes first how to register your newly installed DaCHS server into the IVOA registry. It then introduces the various type of databases and links to corresponding tutorials. |
Document history (to be deleted before submission to Commission) | ||||||||||||||
Date | Version | Editor | Change | Status | ||||||||||
21 Jan 2016 | 0.1 | First issue |
| |||||||||||
| 0.2 | Added details |
| |||||||||||
| 0.3 | Small modifications |
| ||||||||||||
| 0.4 | Change name of document |
| |||||||||||
| 31 Dec 2018 |
| Refined procedure |
| |||||||||||
Table of Contents
| Table of Contents |
|---|
| Pagebreak |
|---|
1. Introduction
This document presents the configuration procedure of the VESPA service installed during the first art part of the tutorial. We propose here to set up the Registry configuration (Section 2), as well as a test TAP service (Section 3).
| Info |
|---|
In all this document, you will have to replace all text between
|
In order to prepare the installation, here is a table to be filled with the parameters of you installation:
| Parameter Name | Your Value | Example Value for tutorial |
|---|---|---|
my_servername |
| ................................................................................ | voparis-test |
my_domain |
| ................................................................................ | obspm.fr |
maintainer_email |
| ................................................................................ | vo.paris@obspm.fr |
authority-ivoid ( |
1) | ................................................................................ | ivo://vopdc.obspm |
creator_name ( |
2) | ................................................................................ | Pierre Le Sidaner |
logo_url ( |
3) | ................................................................................ | http://padc.obspm.fr/img/logo/padc.png |
authority_creationDate ( |
4) | ................................................................................ | 2014-06-03T08:59:09.697573Z |
authority_title |
| ................................................................................ | Paris Astronomical Data Centre |
authority_shortname |
| ................................................................................ | PADC |
authority_description |
| ................................................................................ ................................................................................ ................................................................................ ................................................................................ ................................................................................ |
|
authority_url |
| ................................................................................ | http://padc.obspm.fr |
organization_title |
| ................................................................................ | Observatoire de Paris |
organization_description |
| ................................................................................ ................................................................................ ................................................................................ ................................................................................ ................................................................................ ................................................................................ | Founded in 1667, the Observatoire de Paris is the largest national research center for astronomy. About 30% of all French astronomers are working in its five laboratories and its institute. Situated on the Paris, Meudon and Nançay campuses, they are all associated with the CNRS and, in many cases, with the major scientific universities in the Paris area. The research done at the Paris observatory covers all the fields of contemporary astronomy and astrophysics. |
organization_url |
| ................................................................................ | http://www.obspm.fr |
(1) This ivo-id is that of your naming authority. If your institution is not registered you should put ivo://<<authority_name>>/org (see Tutorial Part 1).
(2) May be different from the maintainer_email. Contact Name is the Data Center contact person, whereas the Creator Name is the contact for this specific server.
(3) The logo must have the following maximum dimensions: width = 120px and height = 60px.
(4) This date must be formatted in ISO-8901, see the example caution on format.
2. DaCHS Registry Configuration
The Registry is the Information System of the Virtual Observatory (the yellow pages where where all the services are registered). We describe a way to register your "authority ID" (description of the authority managing your resources) and the services provided by DaCHS. This operation shall The procedure described here (initial metadata declaration and RofR) only needs to be done only once. New services will be registered automatically The registration of data services/collections is described below.
First you need to create an identifier for your naming authority ID (ivo://myauthority_datacentername)
The following lines have to be placed into the file Then open the configuration file:
| Code Block | ||
|---|---|---|
| ||
sudo pico /var/gavo/etc/defaultmeta.txt |
...and edit it with the following lines (see Tutorial Part 1 for some keywords):
| Code Block | ||||
|---|---|---|---|---|
| ||||
publisher: <<my<<authority_datacenter>>name>> publisherID: <<my_datacenter<<authority-ivoid>> contact.name: <<contact_name>> contact.address: <<contact_address>> contact.email: <<contact_email>> contact.telephone: <<contact_telephone>> creator.name: <<creator_name>> creator.logo: <<logo_url>> authority.creationDate: <<authority_creationDate>> authority.title: <<authority_title>> authority.shortName: <<authority_shortname>> authority.descriptionmanagingOrg: <<authority<<my_description>>datacenter-ivoid>> authority.referenceURL: <<authority_url>> authority.managingOrgdescription: <<my<<authority_datacenter-ivoid>>description>> organization.title: <<organization_title>> organization.referenceURL: <<organization_url>> organization.description: <<organization_description>> organization.referenceURL: <<organization_url>> site.description:<<description of your site (data centre)>> |
Then you have to update the userconfig.rd file in the same directory. This file does not exist yet on a fresh installation, so you have to create it. You first need to switch to the root user, and then create the file:
| Code Block | ||
|---|---|---|
| ||
cd /var/gavo/etc/
su #root password is asked
gavo admin dumpDF //userconfig > userconfig.rd
exit |
Then open the registry-interfacerecords section of the userconfig.rd file for editing
| Code Block | ||
|---|---|---|
| ||
sudo pico userconfig.rd |
And in the file, remove the {UNCONFIGURED} text, so that the content is:
| Code Block | ||
|---|---|---|
| ||
[...]
<!-- ================================ Registry Interface ============ -->
<STREAM id="registry-interfacerecords">
<doc>
These are services and registry records for the registry interface
of this service.
Even if together with defaultmeta, this will just work, keep
these elements in your etc/userconfig.rd.
The metaString macros in here generally point into defaultmeta.
Replace them with whatever actual text applies to your site; we
will work to do away with defaultmeta.txt.
</doc>
<resRec id="authority"> <!-- ivo id of the authority is overridden in
nonservice.NonServiceResource -->
<meta>
creationDate: \\metaString{authority.creationDate}
title: \\metaString{authority.title}
shortName: \\metaString{authority.shortName}
subject: Authority
managingOrg: \\metaString{authority.managingOrg}
referenceURL: \\metaString{authority.referenceURL}
identifier: ivo://\getConfig{ivoa}{authority}
sets: ivo_managed
</meta>
<meta name="description">
\\metaString{authority.description}
</meta>
</resRec>
[...] |
Once this is done, we can publish your registry interface, by issuing the following command:
| Code Block | ||
|---|---|---|
| ||
dachs pub //services |
You will probably see warning to the effect of
** WARNING: Not reloading services RD on server since no admin password available
This is a reminder that to make your changes active, you have to restart the server (sudo service dachs restart). You can configure DaCHS to reload the changed resource automatically by setting an admin password http://docs.g-vo.org/DaCHS/tutorial.html#the-admin-passwordThis will declare your publishing registry, you can verify the content using http://<<dachs-server-address>>/oai.xml
Since this is speaking a protocol (OAI-PMH) and gets it wrong, there is an error message:
But if you click “All identifiers defined here“, you will see links to the records you will be publishing:
At this stage, you will see a lot fewer links on your band-new publishing registry; what you should see at this point, however, are your equivalents of ivo://padc.obspm.helio – that is your claim of the authority – and the ugly identifier ending in services/registry – that is your publishing registry itself.
Read http://docs.g-vo.org/DaCHS/opguide.html#defining-basic-metadata for more details
3. Registering the DaCHS server in Registry of Registry
Go there: http://rofr.ivoa.net/regvalidate/
Enter the URL: http://<<dachs-server-address>>/oai.xml
First step on registry validation result on failed tests have to be None Found
Then a "Step 2: Register your Registry" will be proposed on the web interface with a button Register
Once your registry is inside the list of publishing registries, you have to wait at least one day for the information to be harvested and to see your service available in clients such as TOPCAT
4. Publish your TAP service data collections
Each EPN-TAP table you define is a “data collection“ to the VO; it is such data collections that people will discover when they look for data relevant to them in the VO Registry. To make this work, you need to inform the Registry about your data collections. Each of these data collection will refer to the TAP service, which is what clients actually talk with.
Hence, first publish your TAP service (this only needs to happen once):
| Code Block | ||
|---|---|---|
| ||
dachs pub //tap |
The record for the TAP service should now be visible from http://<<dachs-server-address>>/oai.xml as ivo://<your-authority>/tap.
Each of your Vespa service need to be published to be visible in Topcat, Aladin, Taphandle ....
For each service you may have in the q.rd file, into the <table> tag
| Code Block | ||
|---|---|---|
| ||
<publish sets="local,ivo_managed"/> |
from the directory where the q.rd is use the following command
| Code Block | ||
|---|---|---|
| ||
dachs pub q
dachs serve restart |
each collection will appear at http://<<dachs-server-address>>/oai.xml
5. Unregistering a service
In case you build a test service and you register it by mistake, we describe how to set this service as inactive so it will no longer be visible in the registry.
In the q.rd file defining your service, remove the line
| Code Block | ||
|---|---|---|
| ||
<publish sets="local,ivo_managed"/> |
make under user dachsroot the command
| Code Block |
|---|
dachs pub q.rd
dachs serve restart |
to be sure that the declaration have been removed go to
| Code Block |
|---|
http://<<dachs-server-address>>/oai.xml/verb=ListIdentifiers&metadataPrefix=ivo_vor |
Your collection will appear in strike characters.
6. Assessing your dataset
Depending on your dataset (just a series of files, number for data processing levels, presence of metadata, format of data, existing relational database...) various processing may be required. In order to prepare the sharing with EPN-TAP, here is a check list of what you need:
- Public access to the data files you want to share: either on your server, or on a remote server with a publicly accessible URL (e.g., at NASA/PDS or ESA/PSA).
- Metadata (relevant for EPNcore) for each file
- Preview image for each file
Select a suitable data format if the current format is recommended by VESPA.
To be Continued...