Skip to content

Commit 4e41124

Browse files
committed
feat: update README.md, fix links to outdated docs, fix sda-cli commands examples, remove unecessary header
1 parent a0b3e3e commit 4e41124

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ This document contains information on how to work with the Sensitive Data Archiv
66

77
The storage and interfaces software stack for the GDI-starter-kit consists of the following services:
88

9-
| Component | Description |
10-
|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
11-
| broker | RabbitMQ based message broker, [SDA-MQ](https://github.com/neicnordic/sensitive-data-archive/tree/main/rabbitmq). |
12-
| database | PostgreSQL database, [SDA-DB](https://github.com/neicnordic/sensitive-data-archive/tree/main/postgresql). |
13-
| storage | S3 object store, demo uses Minio S3. |
14-
| auth | OpenID Connect relaying party and authentication service, [SDA-auth](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda-auth). |
15-
| s3inbox | Proxy inbox to the S3 backend store, [SDA-S3Inbox](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda). |
16-
| download | Data out solution for downloading files from the SDA, [SDA-download](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda-download). |
17-
| SDA-pipeline | The ingestion pipeline of the SDA, [SDA-pipeline](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda). This comprises of the following core components: `ingest`, `verify`, `finalize` and `mapper`. |
18-
19-
Detailed documentation on the `sda-pipeline` can be found at: [https://neic-sda.readthedocs.io/en/latest/services/pipeline)](https://neic-sda.readthedocs.io/en/latest/services/pipeline).
9+
| Component | Description |
10+
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
11+
| broker | RabbitMQ based message broker, [SDA-MQ](https://github.com/neicnordic/sensitive-data-archive/tree/main/rabbitmq). |
12+
| database | PostgreSQL database, [SDA-DB](https://github.com/neicnordic/sensitive-data-archive/tree/main/postgresql). |
13+
| storage | S3 object store, demo uses Minio S3. |
14+
| auth | OpenID Connect relaying party and authentication service, [SDA-auth](https://github.com/neicnordic/sensitive-data-archive/tree/main/cmd/auth/auth.md). |
15+
| s3inbox | Proxy inbox to the S3 backend store, [SDA-S3Inbox](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda/cmd/s3inbox/s3inbox.md). |
16+
| download | Data out solution for downloading files from the SDA, [SDA-download](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda-download). |
17+
| SDA-pipeline | The ingestion pipeline of the SDA, [SDA-pipeline](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda/sda.md). This comprises of the following core components: `auth`, `ingest`, `verify`, `finalize`, `s3inbox`, and `mapper`. |
18+
19+
Detailed documentation on the `sda-pipeline` can be found at: [https://neic-sda.readthedocs.io/en/latest/services/sda)](https://neic-sda.readthedocs.io/en/latest/services/sda).
2020

2121
NeIC Sensitive Data Archive documentation can be found at: [https://neic-sda.readthedocs.io/en/latest/](https://neic-sda.readthedocs.io/en/latest/) .
2222

@@ -66,7 +66,7 @@ For an example of how to set up the `sda-pipeline` with TLS, see [TLS-example/RE
6666

6767
## Authentication for users with LS-AAI (mock or alive)
6868

69-
To interact with SDA services, users need to provide [JSON Web Token](https://jwt.io/) (JWT) authorization. Ultimately, tokens can be fetched by [LS-AAI](https://lifescience-ri.eu/ls-login/) upon user login to an OpenID Connect (OIDC) relaying party (RP) service that is [registered with LS-AAI](https://spreg-legacy.aai.elixir-czech.org/). An example of such an RP service is the [sda-auth](https://github.com/neicnordic/sda-auth), which is included in the present stack.
69+
To interact with SDA services, users need to provide [JSON Web Token](https://jwt.io/) (JWT) authorization. Ultimately, tokens can be fetched by [LS-AAI](https://lifescience-ri.eu/ls-login/) upon user login to an OpenID Connect (OIDC) relaying party (RP) service that is [registered with LS-AAI](https://spreg-legacy.aai.elixir-czech.org/). An example of such an RP service is the [sda-auth](https://github.com/neicnordic/sensitive-data-archive/tree/main/sda/cmd/auth), which is included in the present stack.
7070

7171
### sda-auth
7272

@@ -152,26 +152,26 @@ To start using the tool run:
152152
- Encrypt and upload a file to the SDA in one go:
153153

154154
```shell
155-
./sda-cli upload -config s3cmd.conf --encrypt-with-key <sda-c4gh-public-key> <unencrypted_file_to_upload>
155+
./sda-cli -config s3cmd.conf upload --encrypt-with-key <sda-c4gh-public-key> <unencrypted_file_to_upload>
156156
```
157157

158158
- Encrypt and upload a whole folder recursively to a specified path, which can be different from the source, in one go:
159159

160160
```shell
161-
./sda-cli upload -config s3cmd.conf --encrypt-with-key <sda-c4gh-public-key> -r <folder_1_to_upload> -targetDir <upload_folder>
161+
./sda-cli -config s3cmd.conf upload --encrypt-with-key <sda-c4gh-public-key> -r <folder_1_to_upload> -targetDir <upload_folder>
162162
```
163163

164164
- List all uploaded files in the user's bucket recursively:
165165

166166
```shell
167-
./sda-cli list -config s3cmd.conf
167+
./sda-cli -config s3cmd.conf list
168168
```
169169

170170
For detailed documentation on the tool's capabilities and usage please refer [here](https://github.com/NBISweden/sda-cli#usage).
171171

172172
### Downloading data
173173

174-
Users can directly download data from the SDA via `sda-download`, for more details see the service's [api reference](https://github.com/neicnordic/sda-download/blob/main/docs/API.md). In short, given a [valid JW token](#sda-auth), `$token`, a user can download the file with file ID, `$fileID` by issuing the following command:
174+
Users can directly download data from the SDA via `sda-download`, for more details see the service's [api reference](https://github.com/neicnordic/sensitive-data-archive/blob/main/sda-download/api/api.md). In short, given a [valid JW token](#sda-auth), `$token`, a user can download the file with file ID, `$fileID` by issuing the following command:
175175

176176
```shell
177177
curl --cacert <path-to-certificate-file> -H "Authorization: Bearer $token" https://<sda-download_DOMAIN_NAME>/files/$fileID -o <output-filename>
@@ -189,8 +189,6 @@ The `fileID` is a unique file identifier that can be obtained by calls to `sda-d
189189

190190
In order for a user to access a file, permission to access the dataset that the file belongs to is needed. This is granted through [REMS](https://github.com/CSCfi/rems) in the form of `GA4GH` visas. For details see [starter-kit documentation on REMS](https://github.com/GenomicDataInfrastructure/starter-kit-rems) and the links therein.
191191

192-
## How to perform common admin tasks
193-
194192
### The sda-admin tool
195193

196194
Within the scope of the starter-kit, it is up to the system administrator to curate incoming uploads to the Sensitive Data Archive. To ease this task, we have created the `sda-admin` tool which is a shell script that can perform all the necessary steps in order for an unencrypted file to end up properly ingested and archived by the SDA stack. The script can be found under `scripts/` and can be used to upload and ingest files as well as assigning accession ID to archived files and linking them to a dataset.
@@ -306,7 +304,7 @@ curl -s -H "Authorization: Bearer $token" "http://localhost:8443/metadata/datase
306304

307305
#### Download a specific encrypted file
308306

309-
The `sda-download` service offers multiple methods for downloading files through the API, with options for both encrypted and unencrypted results. Below, you will find an example illustrating each of these methods.
307+
The `sda-download` service offers a method for downloading files through the API, which will be encrypted with the public key provided in the request. Below, you will find an example illustrating each of this methods.
310308

311309
To download the file `htsnexus_test_NA12878.bam`, first obtain the respective `fileID` using the following command. The `datasetID`, which is `DATASET0001`, can be obtained by following the instructions at [List datasets](#list-datasets)
312310

0 commit comments

Comments
 (0)