Skip to content

Commit 0fd345f

Browse files
committed
update the config documentation
1 parent c14220c commit 0fd345f

File tree

1 file changed

+69
-3
lines changed

1 file changed

+69
-3
lines changed

src/docs/antora/modules/ROOT/pages/config.adoc

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,84 @@ i.e.
88
nomad{
99
client{
1010
address = "http://localhost:4646"
11+
token = "YOUR_NOMAD_TOKEN"
12+
connectionTimeout = 6000
13+
readTimeout = 6000
14+
writeTimeout = 6000
15+
retryConfig = {
16+
delay = 500
17+
maxDelay = 90
18+
maxAttempts = 10
19+
jitter = 0.25
20+
}
1121
}
22+
1223
jobs{
24+
25+
namespace = 'nf-nomad'
1326
deleteoncompletion = false
27+
28+
volumes = [
29+
{ type "host" name "scratchdir" },
30+
{ type "csi" name "nextflow-fs-volume" },
31+
{ type "csi" name "nextflow-fs-volume" path "/var/data" readOnly true}
32+
]
33+
34+
constraints = {
35+
node {
36+
unique = [ name: 'nomad01' ]
37+
}
38+
}
39+
40+
41+
spreads = {
42+
spread = [ name:'node.datacenter', weight: 50 ]
43+
}
44+
45+
secrets {
46+
enabled = true
47+
}
48+
1449
}
1550
}
1651
```
1752

1853
=== Client configuration
1954

20-
- address, a URL
21-
- token, if the cluster is protected you must to provide a token
55+
- `address`: The URL for the nomad server node.
56+
- `token`: If the cluster is protected you must to provide a token.
57+
- `connectionTimeout`: The maximum time to wait before giving up on establishing a connection with the cluster (default `6000` ms).
58+
- `readTimeout`: The maximum time to wait before indicating inability to read from the connection (default `6000` ms).
59+
- `writeTimeout`: The maximum time to wait before indicating inability to write to the connection (default `6000` ms).
60+
- `retryConfig.delay`: Delay when retrying failed API requests (default: 500ms).
61+
- `retryConfig.jitter`: Jitter value when retrying failed API requests (default: 0.25)
62+
- `retryConfig.maxAttempts`: Max attempts when retrying failed API requests (default: 10)
63+
- `retryConfig.maxDelay`: Max delay when retrying failed API requests (default: 90s)
64+
2265

2366
=== Jobs configuration
2467

25-
- deleteOnCompletion, a boolean indicating if the job will be removed once completed
68+
- `deleteOnCompletion`: A boolean indicating if the job will be removed once completed
69+
- `datacenters`: A list of datacenters for the job submission.
70+
- `region`: The region for job submission.
71+
- `namespace`: The namespace to be used for all Nextflow jobs.
72+
- `volumeSpec`: The volumes which should be accessible to the jobs.
73+
- `affinitiesSpec`: The affinities which should be attached to the job spec.
74+
- `constraintsSpec`: The constraints which should be attached to the job spec.
75+
- `spreadsSpec`: The spreads spec which should be used with all generated jobs.
76+
- `rescheduleAttempts`: Number of rescheduling (to a different node) attempts for the generated jobs.
77+
- `restartAttempts`: Number of restart (on the same node) attempts for the generated jobs.
78+
- `secretOpts`: The configuration for Nomad Secret Store.
79+
- `dockerVolume`, DEPRECATED
80+
- `affinitySpec`, DEPRECATED
81+
- `constraintSpec`, DEPRECATED
82+
83+
84+
85+
=== Debug configuration
86+
- `debug`: Enabling this flag will dump the job definitions for troubleshooting.
87+
88+
=== Secrets configuration
89+
90+
- `enabled`: A boolean flag to indicate the usage of Nomad secrets store.
91+
- `path`: Path of the nomad secret to be used.

0 commit comments

Comments
 (0)