Last modified by alexisdurieux on 2022/03/25 08:38
From version 26.1
edited by alexisdurieux
on 2022/01/28 14:23
Change comment: There is no comment for this version
To version 14.1
edited by alexisdurieux
on 2021/04/06 14:45
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Data Proxy & Human Data Gateway
1 +Data Proxy
Content
... ... @@ -3,53 +3,35 @@
3 3  (% class="container" %)
4 4  (((
5 5  (% style="text-align: justify;" %)
6 -= Data Proxy & HDG =
6 += Data Proxy =
7 7  
8 -The Data Proxy is an application that allows authenticated EBRAINS users to access Swift Object storage without a Fenix user account.
9 -This application has 2 main use cases:
10 -
11 -* (((
12 -It provides a dedicated optional swift container to every Collab. We call it the Collab Bucket.
8 +Functional documentation
13 13  )))
14 -* (((
15 -It allows users to access and visualize Knowledge Graph datasets. It provides an additional layer for datasets whose access is controlled: the Human Data Gateway (HDG).
16 16  )))
17 -)))
18 -)))
19 19  
20 20  (% class="row" %)
21 21  (((
22 22  (((
23 23  (% style="text-align: justify;" %)
24 -The data proxy core is the application that acts as a proxy to the object storage (Swift).
16 +The data proxy core is the application that acts as a proxy to the CSCS Swift storage.
25 25  
26 26  (% style="text-align: justify;" %)
27 -=== Object Storage ===
19 +==== Authentication ====
28 28  
29 -The documentation of Swift object storage can be found here:
30 -
31 -[[https:~~/~~/docs.openstack.org/swift/pike/admin/objectstorage-intro.html>>https://docs.openstack.org/swift/pike/admin/objectstorage-intro.html]]
32 -
33 33  (% style="text-align: justify;" %)
34 -=== Authentication ===
22 +The application itself is connected to the CSCS storage. The user is authenticated against the data-proxy application using authorization headers. The user is then authenticated against the EBRAINS platform. That means the user only needs to have an EBRAINS account to access the data proxy and the Swift storage capabilities
35 35  
36 36  (% style="text-align: justify;" %)
37 -The Data Proxy authenticates its users with the EBRAINS (Collaboratory) IAM service.
25 +=== Bucket system ===
38 38  
39 39  (% style="text-align: justify;" %)
40 -Prior to the availability of the Data Proxy, EBRAINS users had to request a Fenix user account in order to access object storage capabilities on the Fenix infrastructure. With the Data Proxy, a user only needs to have an EBRAINS account to access the data stored on the same Fenix object storage. Data stored in this way is held in the name of the data proxy service account on Fenix, and the Data Proxy tracks who has access to which data.
28 +We use the Collaboratory authorization system for the buckets.
41 41  
42 42  (% style="text-align: justify;" %)
43 -=== Permissions ===
31 +For every collab, it is possible to access a Swift container as a user. The action the user can perform on the buckets depend on the rights the user has in the collab
44 44  
45 -(% style="text-align: justify;" %)
46 -We use the Collaboratory authorization system to manage permissions in the Data Proxy.
47 -
48 -(% style="text-align: justify;" %)
49 -A Swift object container can be associated to each collab. Object containers are also known as "buckets"  to avoid confusion with other containers (e.g. Docker containers). An EBRAINS user can perform the following actions on a bucket depending on the user's permissions (as defined by the collab's Team) in the collab associated with the bucket.
50 -
51 51  (% border="3" %)
52 -|=(% style="text-align: justify;" %)Team permissions of a collab|=(% style="text-align: justify;" %)Available actions on that collab's bucket
34 +|=(% style="text-align: justify;" %)Collab Right|=(% style="text-align: justify;" %)Available actions on bucket
53 53  |(% style="text-align:justify" %)Viewer|(% style="text-align:justify" %)Read
54 54  |(% style="text-align:justify" %)Editor|(% style="text-align:justify" %)Create, Read, Update, Delete
55 55  |(% style="text-align:justify" %)Admin|(% style="text-align:justify" %)Create, Read, Update, Delete
... ... @@ -56,14 +56,11 @@
56 56  |(% style="text-align:justify" %)Not a collab member|(% style="text-align:justify" %)No actions
57 57  
58 58  (% class="wikigeneratedid" %)
59 -You can access the buckets in the "Bucket" navigation element in every collab.
41 +You can access the buckets in the "Buckets" menu in every collab
60 60  
61 -=== Collaboratory bucket vs drive ===
43 +(% class="wikigeneratedid" %)
44 +=== ===
62 62  
63 -A collab offers 2 main locations to store files: a drive and a bucket. The drive offers more advanced features like recognition of file formats (Office, Markdown, PDF) with applications specific to each, simplified version control, smart links. The bucket on the other hand offers larger storage capacity and better bandwidth. The bucket is recommended for datasets (brain scans, EEG, derived data) and videos (including for streaming).
64 -
65 -=== API ===
66 -
67 -The API is self-documented using Swagger UI. You can access it here: [[https:~~/~~/data-proxy.ebrains.eu/api/docs>>https://data-proxy.ebrains.eu/api/docs]] or in the [[API Documentation>>doc:API Documentation]] wiki page of this collab.
46 +The API is self-documentated using Swagger UI. You can access it here: [[https:~~/~~/data-proxy.ebrains.eu/api/docs>>https://data-proxy.ebrains.eu/api/docs]] or in the "API Documentation".
68 68  )))
69 69  )))
Screenshot_2021-01-06 FastAPI - Swagger UI.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexisdurieux
Size
... ... @@ -1,0 +1,1 @@
1 +38.4 KB
Content
Collaboratory.Apps.Collab.Code.CollabClass[0]
Description
... ... @@ -1,4 +1,1 @@
1 -The Data Proxy is an application that allows authenticated EBRAINS users to access Swift Object storage without a Fenix user account.
2 -This application has 2 main use cases:
3 - - It provides a dedicated optional swift container to every Collab. We call it the Collab Bucket.
4 - - It allows users to access and visualize Knowledge Graph datasets. It provides an additional layer for dataset whose access is controlled: the Human Data Gateway (HDG).
1 +Description and specification around the data proxy project.
Public
... ... @@ -1,1 +1,1 @@
1 -Yes
1 +No
XWiki.XWikiRights[5]
Allow/Deny
... ... @@ -1,1 +1,0 @@
1 -Allow
Levels
... ... @@ -1,1 +1,0 @@
1 -view
Users
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
XWiki.XWikiRights[6]
Allow/Deny
... ... @@ -1,1 +1,0 @@
1 -Allow
Groups
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiAllGroup
Levels
... ... @@ -1,1 +1,0 @@
1 -view