Warning

FirecREST version 1 is now in maintenance mode. Only minimal-effort issue fixes will be addressed, and no new features are planned. If you are new to FirecREST, please start directly with FirecREST version 2. If you already use FirecREST v1, we strongly recommend moving your code to FirecREST v2.

Welcome to FirecREST

FirecREST platform, a RESTful Services Gateway to High-Performance Computing (HPC) resources, is a high-performance and reusable framework that integrates with existing HPC infrastructure, thus enabling the access to HPC resources to web-enabled services.

FirecREST provides a REST API that defines a set of HTTP methods through which developers can interact with using the HTTP/REST protocol architecture. Calls to the REST API received are translated into the appropriate infrastructure requests. Among the most prominent services that FirecREST exposes we find authentication and authorization, execution of parallel jobs through a workload manager, file-system operations, data mover, system status, system accounting information, etc.

Table of Contents:

• Overview
  • FirecREST in a nutshell
  • FirecREST architecture
    • Gateway
    • Status microservice
    • Compute microservice
    • Storage microservice
    • Tasks microservice
    • Utilities microservice
    • Delegation microservice
  • FirecREST IAM
• Hands On
  • HTTP requests
  • Testbuild
  • Obtain credentials
  • List the contents of a directory
  • Upload a small file with the blocking call
  • Run a small simulation
    • Submit a job
    • Check for job status
  • Upload with non-blocking call something bigger
  • Run again the simulation with a bigger file
  • Download the output
  • Transfer data between filesystems
• Use-case examples
  • CI/CD pipeline
  • Web User Interfaces
  • FirecREST Operators for Airflow
  • JupyterHub with FirecRESTSpawner
• Reference Guide
  • Status
  • Utilities
  • Compute
  • Storage
  • Tasks
  • Reservation
  • Certificator

Latest Release

FirecREST version 1 is in maintenance mode: only minimal-effort issue fixes will be addressed, and no new features are planned. Active development at CSCS happens in FirecREST version 2. You can always find the latest release of FirecREST version 1 here.

Publications

FA Cruz, M Martinasso. FirecREST: RESTful API on Cray XC systems [pdf]