Developer Guide

This document complements the guidelines set out in the SKA telescope developer portal

Tooling Pre-requisites

Below are some tools that will be required to work with the data product API:

Python 3.10 or later versions: Install page URL: https://www.python.org/downloads/
Poetry 1.6 or later versions: Install page URL: https://python-poetry.org/docs/#installation
GNU make 4.2 or later versions: Install page URL: https://www.gnu.org/software/make/
Elasticsearch 8.6.0 or later versions: (optional)

Development setup

Clone the repository and its submodules:

git clone --recursive git@gitlab.com:ska-telescope/sdp/ska-sdp-dataproduct-api.git

Running the application

Configure the environmental variables in the .env file under the root folder according to your requirements and environment. The default values are:

REACT_APP_SKA_SDP_DATA_PRODUCT_DASHBOARD_URL=http://localhost
REACT_APP_SKA_SDP_DATA_PRODUCT_DASHBOARD_PORT=8100
PERSISTENT_STORAGE_PATH=./tests/test_files/product
METADATA_FILE_NAME=ska-data-product.yaml
METADATA_ES_SCHEMA_FILE=./src/ska_sdp_dataproduct_api/elasticsearch/data_product_metadata_schema.json
METADATA_JSON_SCHEMA_FILE=./src/ska_sdp_dataproduct_api/core/data_product_metadata_json_schema.json
ES_HOST=http://localhost:9200
STREAM_CHUNK_SIZE=65536

To run the application directly on your host machine:

cd ska-sdp-dataproduct-api
poetry shell
poetry install
uvicorn src.ska_sdp_dataproduct_api.main:app --reload

To run the application inside a docker container on your host machine:

NOTE: When running the application in a docker container, the <PERSISTENT_STORAGE_PATH> needs to be accessible from within the container. You can mount the test folder into this location as done below:

docker build -t ska-sdp-dataproduct-api .
docker run -p 8000:8000 -v <YOUR_PROJECT_DIR>/ska-sdp-dataproduct-api/tests:/usr/src/ska_sdp_dataproduct_api/tests ska-sdp-dataproduct-api

Uvicorn will then be running on http://127.0.0.1:8000

Steps to run the system locally in Minikube or want to run an instance of Elasticsearch:

If you want to run the API with a local instance of Elasticsearch, please see the Steps to run the system locally in Minikube