CloWM Resource Service
Description
This is the Resource service of the CloWM service.
Environment Variables
Mandatory / Recommended Variables
| Variable | Default | Value | Description |
|---|---|---|---|
PUBLIC_KEY_VALUE / PUBLIC_KEY_FILE
|
randomly generated | Public Key / Path to Public Key | Public part of RSA Key in PEM format to verify JWTs |
DB_HOST |
unset | <db hostname / IP> | IP or Hostname Address of DB |
DB_PORT |
3306 | Number | Port of the database |
DB_USER |
unset | <db username> | Username of the database user |
DB_PASSWORD |
unset | <db password> | Password of the database user |
DB_DATABASE |
unset | <db name> | Name of the database |
OBJECT_GATEWAY_URI |
unset | HTTP URL | HTTP URL of the Ceph Object Gateway |
BUCKET_CEPH_ACCESS_KEY |
unset | <access key> | S3 access key with admin privileges |
BUCKET_CEPH_SECRET_KEY |
unset | <secret key> | S3 secret key with admin privileges |
OPA_URI |
unset | HTTP URL | HTTP URL of the OPA service |
SLURM_ENDPOINT |
unset | HTTP URL | HTTP URL to communicate with the Slurm cluster |
SLURM_TOKEN |
unset | <JWT> | JWT for communication with the Slurm REST API. Should belong to the user SLURM_USER
|
Optional Variables
| Variable | Default | Value | Description |
|---|---|---|---|
API_PREFIX |
/api/workflow-service |
URL path | Prefix before every URL path |
SQLALCHEMY_VERBOSE_LOGGER |
False |
<"True"|"False"> |
Enables verbose SQL output. Should be false in production |
RESOURCE_BUCKET |
clowm-resources |
Bucket name | Bucket where to save the resources. |
SLURM_USER |
slurm |
string | User on the slurm cluster who should run the job. Should be the user of the SLURM_TOKEN
|
SLURM_WORKING_DIRECTORY |
/tmp |
Path on slurm cluster | Working directory for the slurm job with the nextflow command |
RESOURCE_CLUSTER_PATH |
/vol/data/databases |
Path on slurm cluster | Directory on the cluster where the resources should be downloaded to |
RESOURCE_CONTAINER_PATH |
/vol/resources |
Path on slurm cluster | Directory in the container where al resources are readonly available |
OPA_POLICY_PATH |
/clowm/authz/allow |
URL path | Path to the OPA Policy for Authorization |
OTLP_GRPC_ENDPOINT |
unset | <hostname / IP> | OTLP compatible endpoint to send traces via gRPC, e.g. Jaeger |
License
The API is licensed under the Apache 2.0 license. See the License file for more information.