Skip to content

Commit

Permalink
Improve SQAaS score
Browse files Browse the repository at this point in the history
  • Loading branch information
thebe14 committed Nov 29, 2024
1 parent 9416461 commit 3e44673
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 18 deletions.
10 changes: 5 additions & 5 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Authors
-----------
Levente Farkas <[email protected]>
# Authors

- Levente Farkas <[email protected]>

# Contributors

Contributors
------------
[All contributors](https://github.com/EGI-Federation/eosc-data-transfer/graphs/contributors)
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ title: "EOSC Data Transfer API"
version: 1.1.69
identifiers:
- type: doi
value: https://doi.org/10.5281/zenodo.7925514
value: 10.5281/zenodo.7925514
date-released: 2024-11-29
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ use the correct parser to retrieve the list of source files.
### Supported data repositories

The API supports parsing DOIs to the following data repositories:

- [Zenodo](https://zenodo.org/)
- [B2SHARE](https://eudat.eu/catalogue/B2SHARE)
- [European Synchrotron Radiation Facility](https://esrf.fr/)
Expand Down Expand Up @@ -277,7 +278,7 @@ API endpoints.
A **storage element** is where user's data is stored. It is a generic term meant to
hide the complexity of different types of storage technologies. It can mean both
an element of the storage system's hierarchy (directory, folder, container, bucket, etc.)
and the entity that stores the data (file, object, etc.).
and the entity that stores the data (file, object, etc.).

The API supports managing storage elements in a destination storage. Each data transfer
service that gets integrated can optionally implement this functionality. Moreover, data
Expand Down Expand Up @@ -331,6 +332,7 @@ You can review the metrics generated by the API at http://localhost:8081/metrics
## Running the API in dev mode

You can run your application in dev mode that enables live coding using:

```shell script
./mvnw compile quarkus:dev
```
Expand All @@ -343,6 +345,7 @@ Then open the Dev UI, which is available in dev mode only, at http://localhost:8
## Packaging and running the API

The application can be packaged using:

```shell script
./mvnw package
```
Expand All @@ -353,6 +356,7 @@ Be aware that it’s not an _über-jar_ as the dependencies are copied into the
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.

If you want to build an _über-jar_, execute the following command:

```shell script
./mvnw package -Dquarkus.package.type=uber-jar
```
Expand Down Expand Up @@ -382,17 +386,17 @@ The architecture and interaction between these containers is illustrated below:
Steps to run the API in a container:

1. Copy the file `src/main/docker/.env.template` to `src/main/docker/.env`, then:
* Provide the domain name and port where you will deploy the API in the environment
variables `SERVICE_DOMAIN` and `SERVICE_PORT`, respectively.
* Provide an email address in the environment variable `SERVICE_EMAIL` to be used,
together with the domain name, to automatically request a SSL certificate for the
SSL terminator.
* In the environment variable `FTS_KEY_STORE_FILE` provide a path to a
Java keystore file containing a new [EGI service account certificate](#configuration),
and in the environment variable `FTS_KEY_STORE_PASSWORD` provide the password for it.
* In the environment variable `TELEMETRY_PORT` provide the port on which to publish
the Grafana telemetry dashboard. This will be available on the same domain name as
the API itself.
- Provide the domain name and port where you will deploy the API in the environment
variables `SERVICE_DOMAIN` and `SERVICE_PORT`, respectively.
- Provide an email address in the environment variable `SERVICE_EMAIL` to be used,
together with the domain name, to automatically request a SSL certificate for the
SSL terminator.
- In the environment variable `FTS_KEY_STORE_FILE` provide a path to a
Java keystore file containing a new [EGI service account certificate](#configuration),
and in the environment variable `FTS_KEY_STORE_PASSWORD` provide the password for it.
- In the environment variable `TELEMETRY_PORT` provide the port on which to publish
the Grafana telemetry dashboard. This will be available on the same domain name as
the API itself.

2. Run the command `build.sh` (or `build.cmd` on Windows) to build and run the containers
that implement the EOSC Data Transfer API.
Expand Down

0 comments on commit 3e44673

Please sign in to comment.