+ The Aruna Object Storage (AOS) is a storage service for the German initiative for a national research data infrastructure (NFDI). Before you can start using AOS, you have to sign up for a user account on the website. +
+ ++ While the connection to AOS can be established via the same S3 protocol that is described above, the setup and configuration works a little differently. Here is a description of the S3 options for AOS: +
+ ++ The name of your AOS project. +
+
+ The endpoint is the URL https://<bucket>.data.gi.aruna-storage.org where <bucket> is replaced with the bucket name above.
+
+ The "AccessKey" that is provided with new data proxy credentials. +
++ The "SecretKey" that is provided with new data proxy credentials. +
++ Detailed setup instructions: +
+ ++ Log in to the AOS dashboard, select "Explore" and then "Resources" in the menu at the top. +
++ Click on the "Create new" button and create a new project (we call it "myproject" here). The project name is the value of the Bucket name field that is required to create the new storage disk. With the project name you can also fill the Endpoint field. +
++ Now select "Access" and then "Data proxies" in the AOS menu at the top. Choose a data proxy where you would like to store your data. There, click on the "Create Credential" button. The AccessKey is the value of the Access key field and the SecretKey is the value of the Secret key field that is required to create the new storage disk. +
++ Now you have the values for all fields that are required to create the new storage disk. However, one more step is required before you can annotate your data without restrictions in BIIGLE. You have to configure "Cross-origin resource sharing (CORS)". This is done as follows: +
+ +
+ Install s3cmd and run s3cmd --configure. Enter the access key and secret key from above. Don't change the default region. Enter the S3 endpoint data.gi.aruna-storage.org and the bucket template %(bucket)s.data.gi.aruna-storage.org. Leave the remaining options unchanged. Don't run the test with the supplied credentials and save the settings.
+
+ Create a file called cors.xml with the following content:
+
+<CORSConfiguration>
+ <CORSRule>
+ <AllowedOrigin>{{url('/')}}</AllowedOrigin>
+ <AllowedMethod>GET</AllowedMethod>
+ <AllowedHeader>*</AllowedHeader>
+ <MaxAgeSeconds>30</MaxAgeSeconds>
+ </CORSRule>
+</CORSConfiguration>
+
+
+ Then run the following command: s3cmd setcors cors.xml s3://myproject (you should replace "myproject" with the actual name of your project). That's it. Now CORS is configured for your project.
+
+ Here is a brief example for how you can upload files to your project. This is also done with s3cmd;
+
+ Make sure s3cmd is configured as described above.
+
+ Now navigate to the parent of the directory that you want to upload. Upload the whole directory with the following command (replace "mydir" with the name of the directory to upload and "myproject" with the name of your project): +
+s3cmd put -r mydir s3://myproject/+
+ The directory will be created as a new dataset as part of your AOS project. In BIIGLE, you will see it as a directory in the file browser. +
+- The Aruna Object Storage (AOS) is a storage service for the German initiative for a national research data infrastructure (NFDI). Before you can start using AOS, you have to sign up for a user account on the website. -
- -- An AOS storage disk has the following options: -
- -- The ID of the AOS collection as returned by the API. -
-- The name of the collection bucket which consists of the collection version (or "latest"), the collection name and the project name joined with dots. -
-
- The endpoint is the URL https://<bucket>.data.gi.aruna-storage.org where <bucket> is replaced with the bucket name above.
-
- The "S3 access key" that is provided with a new access token. -
-- The "S3 secret key" that is provided with a new access token. -
-- The "secret" that is provided with a new access token. -
-- Detailed setup instructions: -
- -- Log in to the AOS dashboard and note down the ID (ULID) of your project. -
-- Create a new token with the "project" token type, choose a name, enter the project ULID, choose "MODIFY" permissions and click "Create". The note down the "secret". -
-
- Create a new collection in the project with the following cURL request to the API (choose your own collection name and description and replace PROJECT_ULID with the project ID and TOKEN with the token secret):
-
-curl -d '
- {
- "name": "mycollection",
- "description": "This is my collection.",
- "projectId": "PROJECT_ULID",
- "dataclass": "DATA_CLASS_PRIVATE"
- }' \
- -H 'Authorization: Bearer TOKEN' \
- -H 'Content-Type: application/json' \
- -X POST https://api.aruna-storage.org/v1/collection
-
-
- The returned collectionID is the value of the Collection ID field that is required to create a new AOS storage disk.
-
- The value of the Bucket name field can be determined now, too. It consists of the collection version (or "latest"), the collection name and the project name joined with dots (example: latest.mycollection.myproject).
-
- Finally, the value of the Endpoint field can be determined. It is the URL https://<bucket>.data.gi.aruna-storage.org where <bucket> is replaced with the bucket name above.
-
- Now go back to the dashboard and create a new token. This time it should have the token type "collection". Enter the collection ULID and choose "READ" permissions. This token provides the "S3 access key" as the value of the Access key field, the "S3 secret key" as the value of the Secret key field and the "Secret" as the value of the API secret field that are required to create a new AOS storage disk. -
-- Now you have the values for all fields that are required to create a new AOS storage disk. Here is a brief example for how you can upload files to your collection using the S3 protocol in a command line: -
- -- Go to the AOS dashboard and create a new token. It should have the token type "collection". Enter the collection ULID and choose "MODIFY" permissions. Note down the "S3 access key" and "S3 secret key". -
-
- Install `s3cmd` and run `s3cmd --configure`. Enter the access key and secret key. Don't change the default region. Enter the S3 endpoint data.gi.aruna-storage.org and the bucket template %(bucket)s.data.gi.aruna-storage.org. Leave the remaining options unchanged. Don't run the test with the supplied credentials and save the settings.
-
- Now navigate to the directory of files that you want to upload. Currently, no subdirectories can be uploaded via S3. Upload all files of the current directory with the command (replace mycollection and myproject with the names of your AOS collection and project, respectively):
-
s3cmd put * s3://latest.mycollection.myproject/-
{{$message}}
- @enderror -{{$message}}
- @enderror -- The bucket name consists of the collection version (or "latest"), the collection name and the project name joined with dots. -
-{{$message}}
- @enderror -
- The endpoint is the URL https://<bucket>.data.gi.aruna-storage.org where <bucket> is replaced with the bucket name above.
-
{{$message}}
- @enderror -{{$message}}
- @enderror -{{$message}}
- @enderror -- The access credentials are stored in the BIIGLE database and minimum permissions reduce risk in case of exposure. -
-{{$message}}
- @enderror -{{$message}}
- @enderror -- The bucket name consists of the collection version (or "latest"), the collection name and the project name joined with dots. -
-{{$message}}
- @enderror -
- The endpoint is the URL https://<bucket>.data.gi.aruna-storage.org where <bucket> is replaced with the bucket name above.
-
{{$message}}
- @enderror -{{$message}}
- @enderror -{{$message}}
- @enderror -