@@ -6,18 +6,22 @@ flux-config-ingest(5)
66DESCRIPTION
77===========
88
9- The Flux **job-ingest ** service verifies and validates job requests
9+ The Flux **job-ingest ** service optionally modifies and validates job requests
1010before announcing new jobs to the **job-manager **. Configuration of the
11- **job-ingest ** module can be accomplished either via the module command
12- line or an ``ingest `` TOML table. See the KEYS section below for supported
13- ``ingest `` table keys.
11+ **job-ingest ** module can be accomplished via the ``ingest `` TOML table.
12+ See the KEYS section below for supported ``ingest `` table keys.
1413
15- The **job-ingest ** module validates jobspec using a work crew of
16- ``flux job-validator `` processes. The validator supports a set of plugins,
17- and each plugin may consume additional arguments from the command line
18- for specific configuration. The validator plugins and any arguments are
19- configured in the ``ingest.validator `` TOML table. See the VALIDATOR KEYS
20- section below for supported ``ingest.validator `` keys.
14+ The **job-ingest ** module implements a two stage pipeline for job requests.
15+ The first stage modifies jobspec and is implemented as a work crew of
16+ ``flux job-frobnicator `` processes. The second stage validates the modified
17+ requests and is implemented as a work crew of ``flux job-validator `` processes.
18+ The frobnicator is disabled by default, and the validator is enabled by default.
19+
20+ The frobnicator and validator each supports a set of plugins, and each plugin
21+ may consume additional arguments from the command line for specific
22+ configuration. The plugins and any arguments are configured in the
23+ ``ingest.frobnicator `` and ``ingest.validator `` TOML tables, respectively.
24+ See the FROBNICATOR KEYS and VALIDATOR KEYS sections for supported keys.
2125
2226KEYS
2327====
@@ -28,6 +32,19 @@ batch-count
2832 ``batch-count `` key is nonzero then jobs are batched based on a counter
2933 instead. This is mostly useful for testing.
3034
35+ FROBNICATOR KEYS
36+ ================
37+
38+ plugins
39+ (optional) An array of frobnicator plugins to use.
40+ For a list of supported plugins on your system run
41+ ``flux job-frobnicator --list-plugins ``
42+
43+ args
44+ (optional) An array of extra arguments to pass on the frobnicator
45+ command line. Valid arguments can be found by running
46+ ``flux job-frobnicator --plugins=LIST --help ``
47+
3148VALIDATOR KEYS
3249==============
3350
@@ -52,6 +69,9 @@ EXAMPLE
5269
5370::
5471
72+ [ingest.frobnicator]
73+ plugins = [ "defaults" ]
74+
5575 [ingest.validator]
5676 plugins = [ "jobspec", "feasibility" ]
5777 args = [ "--require-version=1" ]
0 commit comments