Skip to content

Commit 03e507b

Browse files
committed
docs: max-runtime is not valid on job-exec
QUICK_REFERENCE.md told operators to add max-runtime to a [job-exec] section. The key exists on RunJob, RunServiceJob and [global], but ExecJob has no such field, so the documented configuration is rejected. Point at the global default instead, and mark the block as ini rather than bash so a config-parsing check can see it — the snippet was invisible to the docs gate precisely because of the fence language. Found by the documentation-drift gate being built for this repo, which is the kind of defect it exists to catch. Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
1 parent 27d6886 commit 03e507b

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

docs/QUICK_REFERENCE.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,14 +402,22 @@ go tool pprof cpu.prof
402402
```
403403

404404
### Jobs Overlapping
405-
```bash
405+
```ini
406406
# Add no-overlap to job config
407407
[job-exec "long-task"]
408408
schedule = @hourly
409409
container = worker
410410
command = /scripts/task.sh
411411
no-overlap = true # ← Add this
412-
max-runtime = 50m # ← And timeout
412+
```
413+
414+
`max-runtime` is not available on `job-exec`; it applies to `job-run`,
415+
`job-service-run` and `[global]`. To bound an exec job, set the global
416+
default:
417+
418+
```ini
419+
[global]
420+
max-runtime = 50m
413421
```
414422

415423
## Performance Tips

0 commit comments

Comments
 (0)