Newer
Older
# Table of Contents
1. [Overview](#overview)
2. [Autosubmit Big Picture](#autosubmit-big-picture)
3. [Installation](#installation)
4. [Configuration options](#configuration-options)
Autosubmit API is a package that consumes the information generated by Autosubmit and serves it as an API.
## Autosubmit Big Picture
![Autosubmit Big Picture](/docs/Total_Autosubmit_Diagram.png)
In this image you can see the flow of information in the **Autosubmit environment**.
* **Autosubmit**: Machines running Autosubmit.
* **Remote Platforms**: Platforms (HPCs in most cases) to which Autosubmit connects to run jobs.
* **Experiment Database**: Starting from Autosubmit `3.13.0`, each experiment generates a set of databases that save important (reusable) information about it. We have the `historical database`, `graph database`, `structures database`.
* **File System**: The file system where the experiment files are stored.
* **Data Process Workers**: **Autosubmit API** implements a set of workers that periodically collect information from the experiments or complement that information. In the current **BSC** implementation, these workers are running no `bscesweb04` under `webadmin` user.
* **Main Database**: **Autosubmit API** uses a centralized database to keep track of important experiment information. The **workers** fill this information. **Autosubmit** also writes into this database.
* **Autosubmit API**: See [Autosubmit API](https://earth.bsc.es/gitlab/es/autosubmit_api). Currently, under **BSC** implementation, this API is running on `bscesweb04` under `webadmin` user. This API exposes a set of requests that **Autosubmit GUI** consumes and serves to the users through the front end.
* **Autosubmit GUI**: This project.
* **Authentication Server**: **BSC Central Authentication Service**.
* **Users**: Users that access the GUI through their web browsers from any device. The current implementation requires that an user generates a token using the Authentication server once every 5 days.
Autosubmit API can be easily installed via pip
```sh
pip install autosubmit-api # >=4.0 (recommended)
autosubmit_api start -h
```
Start the server:
```sh
autosubmit_api start
```
## Configuration options
The Autosubmit API have some configuration options that can be modified by setting their specific environment variable before starting the server:
* **`PROTECTION_LEVEL`**: Default `ALL`. Possible values `ALL`, `WRITEONLY`, `NONE`.
* If set to `ALL`, all the endpoints will be protected by needing a valid token inside the `Authorization` header of the request.
* If set to `WRITEONLY`, only a subset of the endpoints will be protected.
* If set to `NONE`, none of the endpoints will be protected.
* **`SECRET_KEY`**: The secret key to encode the JWT tokens from the Authorization Module. **Important to be set up on production.**
* **`CAS_SERVER_URL`**: CAS Protocol server base URL to request a ticket and verify it. Used for `/v4` endpoints.
* **`CAS_LOGIN_URL`**: CAS Protocol URL to request a ticket. Used for `/v3` endpoints.
* **`CAS_VERIFY_URL`**: CAS Protocol URL to verify a given ticket. Used for `/v3` endpoints.
### Install pytest
```bash
pip install -U pytest pytest-cov
```
### Run tests:
```bash
pytest tests/*
```
### Run tests with coverage HTML report:
```bash
pytest --cov=autosubmit_api --cov-config=.coveragerc --cov-report=html tests/*
```
You will find the report in `htmlcov/index.html`