Configure retention policies
Managing database and job archive size with retention policies
How-to Guides
How-to solve concrete problems
This section contains practical how-to guides for common ClusterCockpit tasks.
Setup & Deployment
| Guide | Description |
|---|---|
| Hands-On Demo | Basic ClusterCockpit setup and API usage walkthrough |
| Deploy and Update cc-backend | Recommended deployment and update workflow for production use |
| Setup a systemd Service | Run ClusterCockpit components as systemd services |
Create a cluster.json File | How to initially create a cluster configuration |
Configuration & Customization
| Guide | Description |
|---|---|
| Customize cc-backend | Add legal texts, modify login page, and add custom logo |
| Notification Banner | Add a message of the day banner on the homepage |
| Auto-Tagging | Enable automatic job tagging for application detection and classification |
| Resampling | Plan and configure metric resampling |
| Retention Policies | Manage database and job archive size with retention policies |
Metric Collection & Integration
| Guide | Description |
|---|---|
| Hierarchical Metric Collection | Configure multiple cc-metric-collector instances with forwarding |
| External TSDB Integration | Integrate Prometheus and InfluxDB data into cc-metric-store |
| Sharing HPM Metrics (SLURM) | Share hardware performance counter access between monitoring and user jobs |
API & Developer Tools
| Guide | Description |
|---|---|
| Generate JWT Tokens | Generate JSON Web Tokens for API authentication |
| Use the REST API | How to use the REST API endpoints |
| Use the Swagger UI | Browse and test API endpoints via Swagger UI |
| Regenerate Swagger Docs | Regenerate the Swagger UI documentation from source |
Migrations
| Guide | Description |
|---|---|
| Database Migrations | Apply database schema migrations |
| Job Archive Migrations | Migrate job archive data between versions |
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
How to ingest metrics from external time series databases
Integrate Prometheus and InfluxDB data into cc-metric-store using adapter scripts and proxy approaches
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 plan and configure resampling
Configure metric resampling
How to setup a systemd service
Run ClusterCockpit components as systemd services
Sharing HPM Metrics Between Monitoring and User Profiling
How to share hardware performance counter access between system monitoring and user jobs in SLURM
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.