Skip to content

Commit 2643b97

Browse files
committed
docs: update configuration references
1 parent c8eb7a3 commit 2643b97

File tree

4 files changed

+71
-19
lines changed

4 files changed

+71
-19
lines changed

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4646
- Replace `standard_{error,input,output}` by `{stderr,stdin,stdout}_expanded`
4747
in filtered fields of individual job responses from Slurm controler for
4848
compatibility with v0.0.43 REST API.
49-
- docs: Update Slurm REST API supported versions section in architecture page.
49+
- docs:
50+
- Update Slurm REST API supported versions section in architecture page.
51+
- Update configuration reference documentation.
5052

5153
### Fixed
5254
- gateway: Use agent provided version instead of agent minimal version from

docs/modules/conf/examples/agent.ini

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -147,15 +147,28 @@ jwt_key=/var/lib/slurm-web/slurmrestd.key
147147
# _static_.
148148
jwt_token=None
149149

150-
# Slurm REST API version.
150+
# List of supported slurmrestd REST API versions to try during discovery,
151+
# in descending order (newest first).
152+
#
153+
# The agent will try each version in order until it finds one that works.
154+
# This allows the agent to support multiple slurmrestd API versions
155+
# automatically.
151156
#
152157
# CAUTION: You SHOULD NOT change this parameter unless you really know what
153158
# you are doing. This parameter is more intented for Slurm-web developers
154159
# rather than end users. Slurm-web is officially tested and validated with
155160
# the default value only.
156161
#
157-
# Default value: 0.0.41
158-
version=0.0.41
162+
# Default value:
163+
# - 0.0.44
164+
# - 0.0.43
165+
# - 0.0.42
166+
# - 0.0.41
167+
versions=
168+
0.0.44
169+
0.0.43
170+
0.0.42
171+
0.0.41
159172

160173
[filters]
161174

@@ -256,15 +269,15 @@ acctjob=
256269
# - command
257270
# - cpus
258271
# - current_working_directory
259-
# - exclusive
260272
# - gres_detail
261273
# - last_sched_evaluation
262274
# - node_count
263275
# - partition
276+
# - shared
264277
# - sockets_per_node
265-
# - standard_error
266-
# - standard_input
267-
# - standard_output
278+
# - stderr_expanded
279+
# - stdin_expanded
280+
# - stdout_expanded
268281
# - tasks
269282
# - tres_per_job
270283
# - tres_per_node
@@ -277,15 +290,15 @@ ctldjob=
277290
command
278291
cpus
279292
current_working_directory
280-
exclusive
281293
gres_detail
282294
last_sched_evaluation
283295
node_count
284296
partition
297+
shared
285298
sockets_per_node
286-
standard_error
287-
standard_input
288-
standard_output
299+
stderr_expanded
300+
stdin_expanded
301+
stdout_expanded
289302
tasks
290303
tres_per_job
291304
tres_per_node

docs/modules/conf/partials/conf-agent.adoc

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,33 @@ _No default value_
281281
282282
|version
283283
|str
284-
|Slurm REST API version.
284+
|Slurm REST API version (deprecated).
285+
286+
This parameter is deprecated. Use `versions` instead to specify a list of
287+
supported slurmrestd API versions.
288+
289+
CAUTION: You SHOULD NOT change this parameter unless you really know what
290+
you are doing. This parameter is more intented for Slurm-web developers
291+
rather than end users. Slurm-web is officially tested and validated with
292+
the default value only.
293+
294+
295+
WARNING: This parameter is *deprecated* in favor of `[slurmrestd]` > `versions`.
296+
297+
298+
299+
_No default value_
300+
301+
|-
302+
303+
|versions
304+
|list[str]
305+
|List of supported slurmrestd REST API versions to try during discovery,
306+
in descending order (newest first).
307+
308+
The agent will try each version in order until it finds one that works.
309+
This allows the agent to support multiple slurmrestd API versions
310+
automatically.
285311
286312
CAUTION: You SHOULD NOT change this parameter unless you really know what
287313
you are doing. This parameter is more intented for Slurm-web developers
@@ -292,7 +318,17 @@ the default value only.
292318
293319
294320
295-
*Default:* `0.0.41`
321+
*Default:*
322+
323+
324+
* `0.0.44`
325+
326+
* `0.0.43`
327+
328+
* `0.0.42`
329+
330+
* `0.0.41`
331+
296332
297333
|-
298334
@@ -436,8 +472,6 @@ unique job, all other fields are filtered out.
436472
437473
* `current_working_directory`
438474
439-
* `exclusive`
440-
441475
* `gres_detail`
442476
443477
* `last_sched_evaluation`
@@ -446,13 +480,15 @@ unique job, all other fields are filtered out.
446480
447481
* `partition`
448482
483+
* `shared`
484+
449485
* `sockets_per_node`
450486
451-
* `standard_error`
487+
* `stderr_expanded`
452488
453-
* `standard_input`
489+
* `stdin_expanded`
454490
455-
* `standard_output`
491+
* `stdout_expanded`
456492
457493
* `tasks`
458494

docs/modules/conf/partials/policy-actions.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,5 @@ defined reservations.
4848
|cache-reset
4949
|Reset cache statistics in settings panel.
5050
51+
5152
|===

0 commit comments

Comments
 (0)