Last modified by alexisdurieux on 2022/03/25 08:38
From version 7.1
edited by alexisdurieux
on 2021/01/06 11:34
Change comment: Uploaded new attachment "Screenshot_2021-01-06 FastAPI - Swagger UI.png", version {1}
To version 15.1
edited by alexisdurieux
on 2021/04/12 15:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,40 +2,53 @@
2 2  (((
3 3  (% class="container" %)
4 4  (((
5 +(% style="text-align: justify;" %)
5 5  = Data Proxy =
6 6  
7 -Documentation
8 +The data-proxy allows you to access CSCS Object Swift storage as an authenticated ebrains user without requiring a Fenix account.
8 8  )))
9 9  )))
10 10  
11 11  (% class="row" %)
12 12  (((
13 -(% class="col-xs-12 col-sm-4" %)
14 14  (((
15 +(% style="text-align: justify;" %)
15 15  The data proxy core is the application that acts as a proxy to the CSCS Swift storage.
16 16  
17 -==== Authentication ====
18 +(% style="text-align: justify;" %)
19 +=== Object Storage ===
18 18  
19 -The application itself is connected to the CSCS storage. The user is authenticated against the data-proxy application using an authorization headers. The user is then authenticated against the EBRAINS platform. That means the user only needs to have a ebrains account to access the data proxy and the swift storage capabilities
20 20  
22 +The documentation on the swift object storage can be found here: [[https:~~/~~/docs.openstack.org/swift/pike/admin/objectstorage-intro.html>>https://docs.openstack.org/swift/pike/admin/objectstorage-intro.html]]
23 +
24 +
25 +(% style="text-align: justify;" %)
26 +=== Authentication ===
27 +
28 +(% style="text-align: justify;" %)
29 +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
30 +
31 +(% style="text-align: justify;" %)
21 21  === Bucket system ===
22 22  
23 -We use the collaboratory authorization system for the buckets.
34 +(% style="text-align: justify;" %)
35 +We use the Collaboratory authorization system for the buckets.
24 24  
25 -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
37 +(% style="text-align: justify;" %)
38 +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
26 26  
27 27  (% border="3" %)
28 -|=Collab Right|=Available actions on bucket
29 -|Viewer|Read
30 -|Editor|Create, Read, Update, Delete
31 -|Admin|Create, Read, Update, Delete
32 -|Not a collab member|No actions
41 +|=(% style="text-align: justify;" %)Collab Right|=(% style="text-align: justify;" %)Available actions on bucket
42 +|(% style="text-align:justify" %)Viewer|(% style="text-align:justify" %)Read
43 +|(% style="text-align:justify" %)Editor|(% style="text-align:justify" %)Create, Read, Update, Delete
44 +|(% style="text-align:justify" %)Admin|(% style="text-align:justify" %)Create, Read, Update, Delete
45 +|(% style="text-align:justify" %)Not a collab member|(% style="text-align:justify" %)No actions
33 33  
34 -**Should the editor be able to create the bucket in the first place ?**
47 +(% class="wikigeneratedid" %)
48 +You can access the buckets in the "Buckets" menu in every collab
35 35  
50 +=== ===
36 36  
37 -=== **Api description** ===
38 -
39 -
52 +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".
40 40  )))
41 41  )))