Skao Staging Service Documentation

β€œTo Boldly go where no staging service has gone before

MDV 20/01/25 - 2 AM β€œ

Welcome to the skao-staging-service documentation. This service stages data for SKAO analysis. The service code is distributed through GitHUb and available at the following Link

Below are the main components and features of the repository:

  • FastAPI code: Located in app/staging_service.py

  • Staing Methods code: Located in app/staging_methods.py

  • Tests: Available in tests/test_staging_service.py

  • Docker configuration: Defined in Dockerfile

  • Helm chart: Found in charts/my-staging-service/

  • React frontend: Located in frontend/

  • Sphinx docs: In docs/

The service is installed and configured with Helm and runs on a kubernates clusters. The main objective of the service is to expose an API to perform data transfers between locally mounted storages, a mounted storage and an user Jupyter server, or through direct download. The documentation is structured as follows:

  • Overview:

    gives an overview of the service at its components;

  • Assumptions and Simplifications for the Demo:

    outlines the assumptions and semplifications made for the working demo of the service

  • Helm Deployment:

    provides an overview of the Kubernetes components deployed using Helm and lists the configurable variables defined in the values.yaml file.

  • API Schema:

    outlines the logical flow of a FastAPI service that handles data staging operations.

  • Api Documentation:

    outlines the documentation for every implemented method

  • Building and Testing the SKAO Staging Service:

    outlines how to build and test the service using minikube

  • To Do List:

    shows next development marks

  • File Structure:

    provides an overview of the SKAO Staging Service file structure.

API Documentation:

Indices and tables