Skip to content

Commit

Permalink
Update readme files with config changes (#53)
Browse files Browse the repository at this point in the history
* adapt readme to configs

* add missing selected_storage_alias to upload config
  • Loading branch information
dontseyit authored Aug 6, 2024
1 parent 8515f06 commit 4353b14
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
2 changes: 2 additions & 0 deletions ingest_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@
- **`map_files_fields`** *(array)*: Names of the accession map fields for looking up the alias->accession mapping. Default: `["study_files"]`.

- **Items** *(string)*

- **`selected_storage_alias`** *(string)*: Alias of the selected storage node/location. Has to match the backend configuration and must also be present in the local storage configuration. During the later ingest phase, the alias will be validated by the File Ingest Service.
27 changes: 19 additions & 8 deletions s3_upload_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,8 @@

## Properties


- **`s3_endpoint_url`** *(string, format: password)*: URL of the local data hub's S3 server.

- **`s3_access_key_id`** *(string, format: password)*: This parameter plus the s3_secret_access_key serve as credentials for accessing the internal staging bucket (as in `bucket_id`) on the local data hub's S3 server with s3:GetObject and s3:PutObject privileges. These credentials should never be shared with GHGA Central.

- **`s3_secret_access_key`** *(string, format: password)*: Secret access key corresponding to the `s3_access_key_id`.

- **`bucket_id`** *(string)*: Bucket ID of the internal staging bucket of the local data hub's S3 systemwhere the encrypted files are uploaded to.
- **`object_storages`** *(object)*: Configuration for one specific object storage node and one bucket in it. Contains additional properties.
- **Additional properties**: Refer to *[#/$defs/S3ObjectStorageNodeConfig](#%24defs/S3ObjectStorageNodeConfig)*.

- **`part_size`** *(integer)*: Upload part size in MiB. Has to be between 5 and 5120. Default: `16`.

Expand All @@ -22,3 +16,20 @@
- **`secret_ingest_pubkey`** *(string)*: Public key provided by GHGA Central used to encrypt the communication with GHGA Central.

- **`secret_ingest_baseurl`** *(string)*: Base URL under which the /ingest_secret endpoint is available. This is an endpoint exposed by GHGA Central. This value is provided by GHGA Central on demand.

- **`selected_storage_alias`** *(string)*: Alias of the selected storage node/location. Has to match the backend configuration and must also be present in the local storage configuration. During the later ingest phase, the alias will be validated by the File Ingest Service.

## Definitions

- <a id="$defs/S3Config"></a>**`S3Config`** *(object)*: S3 server specific config params.

- **`s3_access_key_id`** *(string, format: password)*: This parameter plus the s3_secret_access_key serve as credentials for accessing the internal staging bucket (as in `bucket_id`) on the local data hub's S3 server with s3:GetObject and s3:PutObject privileges. These credentials should never be shared with GHGA Central.

- **`s3_secret_access_key`** *(string, format: password)*: Secret access key corresponding to the `s3_access_key_id`.


- <a id="$defs/S3ObjectStorageNodeConfig"></a>**`S3ObjectStorageNodeConfig`** *(object)*: Configuration for one specific object storage node and one bucket in it.

- **`bucket_id`** *(string)*: Bucket ID of the internal staging bucket of the local data hub's S3 systemwhere the encrypted files are uploaded to.

- **`credentials`**: Refer to *[#/$defs/S3Config](#%24defs/S3Config)*.

0 comments on commit 4353b14

Please sign in to comment.