Installation

How to install and set up the Job Metrics scraper and database

Installation

This guide covers the installation of the components required for the Job Metrics Dashboard.

Prerequisites

  • A running Slurm cluster with Slurm REST API enabled.
  • PostgreSQL (v13+) database server.
  • Go (v1.22+) installed on the machine where the scraper will run.

1. Database Setup

The system requires a PostgreSQL database named slurm_history.

CREATE DATABASE slurm_history;

You will need to run specific migrations to set up the schema. These are provided in the Go Scraper repository.

2. Go Scraper Setup

The Slurm History Ingestor is the component responsible for collecting job data.

  1. Clone the repository:
    git clone https://github.com/thediymaker/slurm-history-ingestor.git
    
  2. Follow the detailed setup guide: Please refer to the Go Scraper Documentation for complete instructions on building, configuring, and running the ingestor service.

3. Enable the Plugin

Once the backend is collecting data, enable the plugin in your Next.js application.

See the Configuration page for environment variable details.