How-to Guides

How-to solve concrete problems

Configure retention policies

Managing database and job archive size with retention policies

How to set up hierarchical metric collection

Configure multiple cc-metric-collector instances to receive metrics from compute nodes and forward them to the backend

Database migrations

Database migrations

Job archive migrations

Job archive migrations

Hands-On Demo

Hands-On Demo for a basic ClusterCockpit setup and API usage (without Docker)

How to add a MOD notification banner

Add a message of the day banner on homepage

How to create a `cluster.json` file

How to initially create a cluster configuration

How to customize cc-backend

Add legal texts, modify login page, and add custom logo.

How to deploy and update cc-backend

Recommended deployment and update workflow for production use

How to enable and configure auto-tagging

Enable automatic job tagging for application detection and job classification

How to generate JWT tokens

How to plan and configure resampling

Configure metric resampling

How to regenerate the Swagger UI documentation

How to setup a systemd service

Run ClusterCockpit components as systemd services

How to use the REST API Endpoints

How to use the Swagger UI documentation