Release notes
This page contains the releases notes of Slurm-web with details about the new features, modifications and bug fixes coming with all releases.
This page is rendered based on the content of
CHANGELOG.md
in Slurm-web source code.
|
unreleased
Added
-
front:
-
Support filtering jobs in failed state ( #611).
-
Add button to reset cache statistics in settings cache tab ( #603).
-
Dedicated route to directly access fullscreen view of resources diagram instead of modal requiring clicks ( #631).
-
Display spinner while loading jobs running in node details page and display error when unable to load jobs.
-
gateway: Add
/agent/{cluster}/cache/resetroute to reverse proxy request to agent/cache/reset. -
agent: Add
/cache/resetroute to reset cache statistics. -
conf:
-
Introduce
cache-resetauthorization action. -
Assign
cache-resetaction to user role (all authenticated users) in default authorization policy.
-
-
docs:
-
Mention support of Debian 14 « forky ».
-
Add Deployment section in architecture page to explain where packages must be installed with different topologies ( #483)
-
Changed
-
Change license from GPLv3+ to MIT.
-
docs:
-
Simplify distribution schema in architecture page to avoid confusion of frontend component on users host.
-
Update screenshots in quickstart guide to reflect latest UI updates.
-
Update authorization policy reference documentation.
-
Fixed
-
agent:
-
front:
-
Round allocated resources percentages with one decimal in node details page.
-
Fix centering of node tooltip over the racks graphical representation.
-
Restore expected view after authentication error (eg. missing or expired token) and successful login.
-
Update dependencies to fix CVE-2025-7783 (form-data), CVE-2025-58751, CVE-2025-58752 and CVE-2025-62522 (vite), CVE-2025-58754 (axios).
-
Handling of cache hit rate calculation when total number of requests in cache statistics is 0.
-
-
docs: Fix entreprise→enterprise typo.
5.1.0 - 2025-07-09
Added
-
gateway:
-
Support loading LDAP bind password from separate file ( #585). Contribution from @Cornelicorn.
-
Add cache boolean in
/clustersresponse to indicate whether cache service is enabled on agents. -
Add
/agent/{cluster}/cache/statsroute to reverse proxy request to agent/cache/stats.
-
-
agent:
-
Record slurmrestd cache hit and miss counts in cache service.
-
Add metrics with cache hit and miss counts.
-
Support querying cache metrics.
-
Add cache boolean in
/infoendpoint to indicate whether cache service is enabled on agent. -
Add
/cache/statsroute to retrieve cache statistics.
-
-
ldap-check: Support loading LDAP bind password from separate file. Contribution from @Cornelicorn.
-
conf:
-
Add gateway
[ldap]>bind_password_fileconfiguration parameter. Contribution from @Cornelicorn. -
Add gateway
[ldap]>lookup_as_userconfiguration parameter. Contribution from @Cornelicorn. -
Introduce
cache-viewauthorization action. -
Assign
cache-viewaction to user role (all authenticated users) in default authorization policy.
-
Changed
-
gateway:
-
Check agent version is greater or equal to the minimal supported version specified in gateway configuration settings.
-
Send asynchronous HTTP requests to discover agents ( #438).
-
After successful user authentication, when service bind dn and password are defined in configuration, Slurm-web now retrieves user information and user groups in LDAP with these credentials by default. Previous behavior can be restored by setting
lookup_as_user = yesunder the[ldap]section in gateway configuration file ( #587). Contribution from @Cornelicorn.
-
-
agent:
-
Change route to information endpoint from
/v{version}/infoto/info. -
Return version of agent in information endpoint.
-
Emit warning log entry when
SlurmwebMetricsDBErroris raised before responding HTTP/500.
-
-
conf: Update description of
agent>versiongateway parameter to describe its new semantic. -
pkgs:
-
Set Python requests external library dependency on agent only.
-
Bump minimal version of
RFL.authenticationto v1.5.0. -
Move Python aiohttp external library dependency from gateway extra package to main package because it is also a dependency of the agent now.
-
-
docs:
-
Update authorization policy reference documentation.
-
Update configuration reference documentation.
-
Mention cache metrics in metrics configuration reference documentation.
-
Fixed
-
gateway: Handle content type error when expecting JSON response from agent.
-
agent: Return HTTP/501 instead of crashing when metrics are requested but metrics service is disabled.
-
front:
-
Handling of GPU declared without model in Slurm configuration ( #584). Contribution from @mehalter.
-
Regression on handling of denied clusters in cluster list.
-
Parsing of GRES GPUs when comma is present between brackets with indexes or sockets. Contribution from @astappiev.
-
Fix color of ring in clusters list in dark mode.
-
Update dependencies to fix CVE-2025-5889 (brace-expansion).
-
-
docs: Fix rendering of example list values in generated configuration reference documentation ( #599).
5.0.0 - 2025-05-27
Added
-
Support Slurm 25.05 and Slurm REST API v0.0.41 ( #541).
-
GPU resources utilization monitoring ( #258).
-
frontend:
-
Dark mode support ( #278).
-
Display cluster total memory size and number of GPUs in dashboard stats.
-
Display number of GPUs per node in resources page and node details page.
-
Display number of allocated GPU and allocation percentage in node details page.
-
Display number of GPU requested or allocated in jobs list.
-
Display number of GPU requested and allocated in job details page.
-
Add buttons to display GPU status metrics in dashboard.
-
Reproduce Slurm job status logic for jobs badges ( #404).
-
Reproduce Slurm node status logic for node status and allocation badges with icons to represent status flags ( #405).
-
Add node filter for error and fail states.
-
Display version in below logo in main menu ( #568).
-
Display suspended, preempted, deadline, node fail, boot fail, out of memory jobs in dashboard chart.
-
Display fail and error nodes in dashboar chart.
-
-
agent:
-
Add total quantity of memory and number of gpus in cluster stats response.
-
Add metrics for GPU by state and total number of GPU.
-
Support querying GPU metrics.
-
Add missing jobs base states in collected metrics:
SUSPENDED,PREEMPTED,NODE_FAIL,BOOT_FAIL,DEADLINEandOUT_OF_MEMORY. -
Add
ERRORandFAILnode states in collected metrics.
-
-
gateway: Add version in configuration file generated for frontend component.
-
conf:
-
Select
gresandgres_usedattributes by default inslurmrestdnodes list and indiviual node responses. -
Select
gres_detail,sockets_per_node,tasks,tres_per_job,tres_per_node,tres_per_socket,tres_per_taskattributes by default inslurmrestdjobs list and Slurm controller invidual job responses.
-
-
docs:
-
Mention support of Fedora 42.
-
Mention GPU support feature in overview page.
-
Mention GPU metrics in metrics configuration reference documentation.
-
Mention dark mode support feature in overview page.
-
Mention new
--with-slurmoption inslurm-web-gen-jwt-keymanpage. -
Add update guide page with special notes for manual steps required to update from v4 to v5.
-
Changed
-
agent:
-
Run agent as slurm-web system user by default.
-
Emit warning log entry at launch when slurmrestd local authentication method is used.
-
-
frontend:
-
Migrate to Tailwind CSS v4 ( #449). Note this breaks support of old browsers versions, it requires Safari 16.4+, Chrome 111+, and Firefox 128+.
-
Convert nodes memory size in GB or TB in resources page and node details page.
-
Appearance of jobs sort button to visually separate its double role, change sort order and select sort criterion.
-
Bump heroicons dependency to version 2.2.0.
-
Group drain and draining node state filters.
-
-
genjwt: Give ownership of Slurm-web JWT signing key to slurm-web system user only by default. Read ACL is added for slurm system user only if
--with-slurmoption is provided explicitely. -
connect: Emit warning log entry when slurmrestd local authentication method is used.
-
ldap-check: Return exit code 1 on LDAP authentication error.
-
conf:
-
Bump
[slurmrestd]>versiondefault value from0.0.40to0.0.41in agent configuration for compatibility with Slurm 25.05. -
Change default value of
[slurmrestd]>authagent parameter fromlocaltojwt.
-
-
docs:
-
Replace mention of Slurm REST API version v0.0.40 by v0.0.41.
-
Mention requirement of Slurm >= 24.05 and dropped support of Slurm 23.11.
-
Update quickstart guide to setup
slurmrestdJWT authentication, automatic token management mode on Unix socket by default. -
Update installation guide and quickstart guide to mention new separate
slurmweb-5repository. -
Update troubleshooting guide with different
curlcommand forslurmrestdJWT authentication and TCP/IP socket. -
Mention
slurmrestdlocal authentication is deprecated in architecture andslurmrestdconfiguration pages. -
Update
slurmrestdconfiguration guides to reflect change to jwt authentication method by default. -
Update configuration reference documentation.
-
Fixed
-
agent: Fix
AttributeErrorwithprometheus_client.registry.Collectoron el8 ( #548). -
frontend:
-
Rendering of nodes grid in resources page in presence of long node names.
-
Update dependencies to fix CVE-2025-46565 (vite).
-
-
ldap-check: Report and return error instead of crashing when LDAP URI is not defined in configuration.
4.2.0 - 2025-04-29
Added
-
Add
--log-componentoption on every commands to prefix all log entries with a component name. -
Introduce
slurm-web-connect-checkutility to test access toslurmrestdservice with agent configuration parameters. -
frontend:
-
gateway: Add
RACKSDB_{ROWS,RACKS}_LABELSin configuration file generated for frontend component. -
conf:
-
Introduce
[ui]>racksdb_{rows,racks}_labelsgateway parameters. -
Introduce
[slurmrestd]>auth,jwt_mode,jwt_user,jwt_lifespan,jwt_keyandjwt_tokenagent parameters.
-
-
agent:
-
Support JWT authentication on
slurmrestdin static and auto modes. -
Support access to
slurmrestdon TCP/IP socket ( #313). -
docs:
-
Mention
--log-componentoption in manpages. -
Add manpage for
slurm-web-connect-checkutility. -
Add Slurmrestd Access page with guides to setup Slurm and agent in all supported configurations.
-
Mention support of JWT authentication and TCP/IP sockets between agent and Slurm
slurmrestdin Protocols section of Architecture page and Quickstart guide.
-
-
lib: Add comment in agent native and uWSGI services units to explain possibility to drop privileges of slurm user in favor of more restricted slurm-web user with
slurmrestdJWT authentication.
Changed
-
conf: Deprecate
[slurmrestd]>socketparameter in favor ofuridesigned to support TCP/IP socket. -
frontend: Replace view job link by a window icon in jobs list.
-
lib: Rename sysusers configuration file
slurm-web-gateway.conftoslurm-web.confin order to make it generic for both gateway and agent. -
pkgs:
-
Add dependency on
importlib_metadataexternal library on Python < 3.8. -
Bump minimal version of
RFL.logto v1.4.0. -
Bump minimal version of
RFL.settingsto v1.4.0. -
Bump minimal version of
RFL.authenticationto v1.4.0.
-
-
docs: Update configuration reference documentation.
Fixed
-
Fix DeprecationWarning with setuptools
pkg_resourcesbeing used as an API. -
Fix handling of generic Python exceptions in registered error handler with Flask < 1.1.0 to return JSON description of this exception ( #497).
-
gateway: Add support of strings in RacksDB/agent version parts comparison logic.
-
frontend:
-
Missing bearer token in RacksDB infrastructure diagram request ( #471).
-
Responsive layout in jobs view by removing some columns on smaller screens.
-
Do not display canceled request errors ( #507).
-
Update dependencies to fix CVE-2025-24964 (vitest), CVE-2025-27152 (axios) CVE-2025-30208, CVE-2025-31125, CVE-2025-31486, CVE-2025-32395 (vite) and GHSA-67mh-4wv8-2f99 (esbuild).
-
4.1.0 - 2025-02-05
Added
-
agent: Return local RacksDB enabled boolean and version in
/infoendpoint. -
gateway: Return RacksDB enabled boolean feature flag of every clusters in
/clustersendpoint. -
conf:
-
Add
racksdb>enabledparameter for the agent. -
Add
ldap>lookup_user_dnparameter for the gateway.
-
Changed
-
gateway:
-
Check RacksDB version executed by agent is greater or equal to the minimal supported version specified in gateway configuration settings ( #415→ #417).
-
Do not return clusters global stats in
/clustersendpoint anymore. -
Lookup user DN in the scope of user base subtree before authentication on LDAP directory by default ( #446, #447→ #464). This can be reverted to the previous behavior by setting
lookup_user_dn=noin[ldap]section of the gateway configuration.
-
-
agent:
-
frontend:
-
Reduce height of error message container when unable to retrieve infrastructure graphical representation from RacksDB in resources page.
-
Do not display infrastructure advanced graphical representation canvas in resources page when RacksDB is disabled in agent configuration for a cluster ( #418→ #434).
-
Retrieve clusters stats asynchronously after the clusters list with their permissions ( #428→ #435).
-
-
conf: Update description of
agent>racksdb_versionto describe its new semantic. -
docs:
-
Explain RacksDB is now optional in quickstart guide, with method to disable integration feature in side note, and in overview and architecture pages.
-
Update configuration reference documentation.
-
Fixed
-
backend: Remove
en_US.UTF-8locale requirement for uwsgi services ( #432→ #463). -
agent: Fix No module named ‘werkzeug.middleware’ ModuleNotFoundError with Werkzeug < 0.15 ( #419→420).
-
frontend:
-
Do not show fullscreen button on thumbnail when unable to retrieve infrastructure graphical representation from RacksDB.
-
Restore infrastructure graphical representation canvas on cluster change in resources page when coming from cluster on which RacksDB failed.
-
Reduce size of JS chunk by moving chart.js and luxon libraries in separate vendor chunk ( #414→ #441).
-
Remove workaround for Firefox to avoid blurry lines in racks canvas, fixed in Firefox ESR >= 128 and Firefox >= 133 ( #443).
-
Do not report ongoing issue when users do not have permission on
view-statsaction on a cluster in clusters list page. -
Remove old values from dashboard timeseries charts only if their associated timestamps is older than the new suggested minimal timestamp on update ( #454→ #466).
-
Update dependencies to fix CVE-2024-55565 (nanoid) and CVE-2025-24010 (vite).
-
-
pkgs: Bump dependency to RFL.web 1.3.0 to fix access to restricted endpoints with anonymous token or no token ( #460, #462→ #461).
-
docs: Fix cp command to copy examples of uWSGI services provided in Slurm-web packages ( #448→ #465).
4.0.0 - 2024-11-28
Added
-
Support Slurm 24.11 and Slurm REST API v0.0.40 ( #366 → #400).
-
agent:
-
Return RacksDB infrastructure name and a boolean to indicate if metrics feature is enabled in
/infoendpoint, in addition to the cluster name. -
Add optional
/metricsendpoint with various Slurm metrics in OpenMetrics format designed to be scraped by Prometheus or compatible ( #274). -
Add possibility to query metrics from Prometheus database with
/v<version>/metrics/<metric>endpoint. -
Add possibility to filter jobs which are allocated a specific node with node query parameter on
/v<version>/jobsendpoint.
-
-
gateway:
-
Return RacksDB infrastructure name and boolean metrics feature flag of every clusters in
/clustersendpoint. -
Return optional markdown login service message as rendered HTML page with
/messages/loginendpoint. -
Proxy metrics requests to agent through
/api/agents/<cluster>/metrics/<metric>endpoint.
-
-
frontend:
-
Request RacksDB with the infrastructure name provided by the gateway ( #348).
-
Display time limit of running jobs in job details page ( #352).
-
Display service message below login form if defined ( #253).
-
Add dependency on charts.js and luxon adapter to draw charts with timeseries metrics.
-
Display charts of resources (nodes/cores) status and jobs queue in dashboard page based on metrics from Prometheus ( #275).
-
Display list of jobs which have resources allocated on the node in node details page ( #292).
-
Display hash near all jobs fields in job details page to generate link to highlight specific field ( #251).
-
Represent terminated jobs with colored bullet in job status badge, using respectively green for completed (ie. successful) jobs, red for failed jobs and dark orange for timeout jobs ( #354).
-
-
conf:
-
Add
racksdb>infrastructureparameter for the agent. -
Add
metrics>enabledparameter for the agent. -
Add
metrics>restrictparameter for the agent. -
Add
metrics>hostparameter for the agent. -
Add
metrics>jobparameter for the agent. -
Add
ui>templates,message_template,message_loginparameters for the gateway. -
Select
alloc_cpusandalloc_idle_cpusnodes fields onslurmrestd/slurm/*/nodesand/slurm/*/node/<node>endpoints. -
Select
nodesjobs field onslurmrestd/slurm/*/jobsendpoint. -
Introduce service message template.
-
-
show-conf: Introduce
slurm-web-show-confutility to dump current configuration settings of gateway and agent components with their origin, which can either be configuration definition file or site override ( #349). -
docs:
-
Add manpage for
slurm-web-show-confcommand. -
Add metrics feature configuration documentation page.
-
Mention metrics optional feature in quickstart guide.
-
Mention metrics export and charts feature in overview page.
-
Mention possible Prometheus integration in architecture page.
-
Mention login service message feature in overview page.
-
Mention jobs badges to visualize job status in overview page.
-
Add page to document Service Messages configuration.
-
Mention support of Fedora 41.
-
-
pkgs:
-
Introduce
gatewayPython extra package. -
Add requirement on markdown external library for
gatewayextra package. -
Add dependency on prometheus-client for the agent.
-
Add direct dependency on ClusterShell for the agent.
-
Changed
-
agent: Bump minimal required Slurm version from 23.02.0 to 23.11.0.
-
gateway: Change error message when unable to parse agent info fields.
-
docs:
-
Update configuration reference documentation.
-
Update dashboard screenshot in overview page with example of resource chart.
-
Replace mention of Slurm REST API version v0.0.39 by v0.0.40.
-
Mention requirement of Slurm >= 23.11 and dropped support of Slurm 23.02.
-
-
conf:
-
Convert
[cache]>passwordagent parameter from string to password type. -
Convert
[ldap]>bind_passwordgateway parameter from string to password type. -
Bump
[slurmrestd]>versiondefault value from0.0.39to0.0.40in agent configuration for compatibility with Slurm 24.11.
-
-
pkgs:
-
Add requirement on RFL.core >= 1.1.0.
-
Add requirement on RFL.settings >= 1.1.1.
-
Fixed
-
agent:
-
Fix retrieval of terminated jobs only available in accounting service with an option to ignore 404 for specific slurmrestd requests.
-
Fix compatibility issue with Requests >= 2.32.2 ( #350).
-
Return HTTP/404 not found with meaningful error message when requesting unexisting node.
-
-
gateway:
-
Catch generic
requests.exceptions.RequestExceptionwhen retrieving information from agents to avoidAttributeErrorwith more specific exceptions on old versions on Requests library ( #391). -
Catch
JSONDecodeErrorfrom simpleson external library and json standard library module not managed by Requests < 2.27.
-
-
frontend:
-
Notifications not visible when browser is not at the top ( #367).
-
Update dependencies to fix CVE-2024-45812 and CVE-2024-45811 (vite), CVE-2024-47068 (rollup), CVE-2024-21538 (cross-spawn).
-
Removed
-
Support of Slurm 23.02 and Slurm REST API v0.0.39.
-
conf:
-
Remove unused
requiredfrom default selected jobs field onslurmrestd/slurm/*/jobsendpoint. -
Remove unused
state_reasonfrom default selected job field onslurmrestd/slurm/*/job/<id>endpoint.
-
-
docs: Remove mention of Fedora 39 support.
3.2.0 - 2024-09-05
Added
-
gateway: Support custom LDAP user primary group attribute and group object classes ( #342).
-
agent: Retrieve Slurm version from
slurmrestdREST API and return value in response ofstatsendpoint. -
frontend: Display Slurm version in clusters list ( #314).
-
ldap-check: Support custom LDAP user primary group attribute and group object classes ( #342).
-
conf:
-
Add
ldap>user_primary_group_attributeparameter for the gateway. -
Add
ldap>group_object_classesparameter for the gateway. -
Add
cache>versionparameter for the agent.
-
-
docs:
-
Add link to related github issue for
slurmrestdTCP/IP socket limitation in architecture page. -
Add warning about the pure documentation purpose of complete examples of gateway/agent configuration files.
-
Explain
[slurmrestd]>versionagent setting is more intended for developers and should not be changed. -
Mention Slurm accounting is required in quickstart guide ( #341).
-
Changed
-
agent: Check Slurm version returned from
slurmrestdagainst hard-coded minimal version and log error if not greater or equal. -
frontend: Add intermediate cluster list width to 80% on large screens, before going down to 60% on even larger screens.
-
pkgs: Add requirement on RFL.core and RFL.authentication >= 1.0.3.
-
docs:
-
Update configuration reference documentation.
-
Update screenshots with latest UI changes.
-
Fixed
-
backend: handle
rfl.settings.errors.SettingsSiteLoaderErrorwhen loading gateway and agent site configuration ( #317). -
gateway: Response with HTTP/501 and JSON error when requesting users with authentication disabled.
-
agent:
-
Translate HTTP/404 from slurmrestd into JSON error agent that can be interpreted by frontend and emit clear error message in logs ( #321).
-
Detect responses from slurmrestd not formatted in JSON, translated into JSON error for frontend and emit clear error message in logs ( #333).
-
Detect absence of warnings key in
slurmrestdresponses and emit warning log instead of crashing ( #316).
-
-
genjwt: fix portability to Python < 3.8 in debug message.
-
ldap-check: fix usage of
user_name_attributeconfiguration parameter ( #340). -
frontend:
-
Support node names without digits in expand/fold logic ( #328).
-
Update dependencies to fix CVE-2024-39338 (axios), CVE-2024-6783 (vue-template-compiler) and CVE-2024-4067 (micromatch).
-
Display empty list of users/account with light gray cross instead of dot in reservations page ( #336).
-
Hide users disclosure from jobs filters panel when authentication is disabled ( #330).
-
-
docs:
-
Mention requirement of
SLURMRESTD_SECURITY=disable_user_checkenvironment variable inslurmrestdservice drop-in configuration override ( #320). -
Fix protocols section in architecture page to mention Slurm internal authentication mechanism (with
sackd) and clarify thatmungeis not involved between Slurm-web agent andslurmrestd.
-
3.1.0 - 2024-07-03
Added
-
frontend:
-
gateway:
-
agent: Add
cpusandnode_countfields as provided byslurmrestdin jobs list responses. -
docs: Add full gateway and agent configuration files examples.
-
conf:
-
Add
ldap>user_name_attributeparameter for the gateway. -
Add
ui>hide_deniedparameter for the gateway.
-
Changed
-
frontend:
-
Use server icon instead of cpu chip icon to represent nodes in clusters list and clusters pop over menu.
-
Merge account column with user column in jobs list, the account is now displayed between parenthesis.
-
-
docs: Update configuration reference documentation.
-
pkgs:
-
Add requirement on RFL >= 1.0.2.
-
Add requirement on aiohttp.
-
Fixed
-
frontend:
-
gateway: Add possibility to configure custom LDAP user name attribute in alternative to
uid( #305). -
conf: Add documentation precisions and examples in agent and gateway configuration definitions.
-
docs:
-
Typo in slurmrestd service name in quick start guide.
-
Use consistent URL format for
curlcommands onslurmrestdUnix sockets. -
Fix agent and gateway configuration file extension in configuration files reference documentation.
-
Fix some agent and gateway configuration file extension typos in quickstart guide.
-
Invert initial setup and JWT signing key sections in quickstart to satisfy
slurm-web-gen-jwt-keyconfiguration requirement.
-