Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.72 KB

readme.md

File metadata and controls

41 lines (31 loc) · 1.72 KB
Raw

polytope-server

⚠️ This project is BETA and will be experimental for the forseable future. Interfaces and functionality are likely to change, and the project itself may be scrapped. DO NOT use this software in any project/software that is operational.

Polytope provides a REST API for access to hypercube data, stored in various data sources (FDBs, MARS, etc.). Polytope is comprised of a number of microservices:

  • frontend: REST API running Falcon/Flask
  • worker: responsible for fetching data and pushing it to a staging area for download
  • broker: responsible for scheduling pending requests
  • garbage-collector: responsible for cleaning up old requests and freeing up space in the staging area

Through common abstraction layers, these components speak to various other services:

  • request_store: database to track requests (MongoDB)
  • queue: queue to dispatch requests to workers (RabbitMQ)
  • staging: object-store to serve and receive data (S3, BasicHTTPServer)
  • authentication: for authenticating users to Polytope (ECMWF API, Basic MongoDB, API Key MongoDB)
  • authorization: for managing authorization to different collections (ECMWF LDAP, MongoDB)
  • identity: for registering users with Polytope (MongoDB)
  • api-keys: for generating Polytope API keys (MongoDB)
  • caching: caching of web requests to various services (MongoDB, Redis, Memcached)

Quick Start

cd polytope-deployment
export SKAFFOLD_IMAGE_REGISTRY=localhost:32000
skaffold dev

Testing

Unit tests:

python -m pytest tests/unit

Generic integration tests (a deployment is required):

python -m pytest tests/integration --config </path/to/config1.yaml> --config </path/to/config2.yaml>