https://github.com/esipfed/provisium
Implementation of the W3C PROV-AQ note
https://github.com/esipfed/provisium
esip-lab
Last synced: 10 months ago
JSON representation
Implementation of the W3C PROV-AQ note
- Host: GitHub
- URL: https://github.com/esipfed/provisium
- Owner: ESIPFed
- Created: 2017-10-23T20:52:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-05T10:57:41.000Z (over 7 years ago)
- Last Synced: 2024-03-18T07:00:50.823Z (about 2 years ago)
- Topics: esip-lab
- Language: Go
- Homepage: https://provisium.io
- Size: 48.6 MB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Provisium (THROUGHPUT revision)
## Update
This a fork of the Provisium code started under
ESIP (https://github.com/ESIPFed/provisium). It is
dramatically different to apply lessons learned. It has
been updated as part of EarthCube THROUGHPUT.
The plan will be to merge these changes back into the ESIP
version to synchronize the two code bases back into one.
The search and a few things like a resource display need to
be implemented still. All the plumbing is there though, just need
time to flesh out some templates and structures.
## Running
Provisium has two run time dependencies. These can be launched
via a Docker compose file locate in deployments. Later this package
will build to a docker file and one compose file will bring up the
entire service.
The package currently builds to a docker container now. We need
to push that out and modify the compose file to reflect that.
You also need to set three environment variables for this code.
You can use something like the script setenvs.sh in the scripts
directory to do this. These are the settings for the Minio
system and the location of your SPARQL endpoint.
Once set up a simple
```
go run cmd/provisium/main.go
```
will get you started. I need to get some more details here though.
This is rather sketch on how to get started.
### Dependency: Jena/Fuseki (Triplestore)
An instance of Jena Fuseki in Docker that can be used for Provisium.
Note any SPARQL 1.1 (including update) compliant triples store should
work.
* https://cloud.docker.com/u/fcore/repository/docker/fcore/jena
* https://www.w3.org/TR/sparql11-update/
* https://www.w3.org/TR/sparql11-protocol/
### Dependency: Minio/S3 (Objectstore)
An instance of Minio to supply S3 API compliant object store.
Note any S3 compliant system such as OpenStack Swift or even
AWS S3 itself will work.
* https://hub.docker.com/r/minio/minio
* https://wiki.openstack.org/wiki/Swift
* https://aws.amazon.com/s3/
## Notes
### Points
* All submissions come in and get put in an object store (minio)
with basic metadata about them (requester info) and the package
* RDF packages are validated prior to archiving. Once in the object
store, they move into the graph (Jena)
* Non-RDF package are validated prior to archiving. These are likely
just URL lists as defined by the PROV-AQ spec.
* Non-RDF input is also stored in a separate named graph with sufficient triples
to allow query across the default graph to work for both types of
submissions.
### Known Issues
```
Request "hosting" a prov record (require RDF for this one) (ttl, nt, json-ld)
Load to graph with a unique QUAD (what if it comes with quads?)
Don't allow quads :) screw your graph! (can't allow JSON-LD then...)
Section 2 Access Section and 3 Locating Prov records
direct access with 303 redirection
In this case doc/id is really a page about the hosted PROVURI
it could give examples of link or query header or RDF graph
also the pingback ID
Section 4 query service (direct and SPARQL)
NOTE this needs a ?q= or more and we need to support SPARQL too
Section 5 pingback (URI list, or has query service or RDF)
Due to the nature of pingback we can simply hold the POST in an object store.
If we did accept RDF, we could place that in a graph, but it would be incomplete and care
would need to be taken to include the other info. That pingback bundle could be
converted to RDF but we need to ensure a singable or deterministic serialization
text/uri-list (which is doable)
Though not part of the Note, a GET service can be called to present past pingbacks
Potentially, this might be restricted to the authors of a resource, though here no
authentication or authorization is imposed. Simple OpenID for ID with some auth policy
could be built in.
```