Skip to content

Commit

Permalink
flux-job(1): add subsection for flux job info
Browse files Browse the repository at this point in the history
Problem: flux job info is not documented.

Add a new subsection for it.
  • Loading branch information
garlick committed Oct 27, 2023
1 parent 096d83d commit fc19459
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions doc/man1/flux-job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,53 @@ Inactive jobs may also be purged automatically if the job manager is
configured as described in :man5:`flux-config-job-manager`.


flux job info
-------------

The :command:`flux job info` retrieves the selected low level job artifact
and displays it on standard output. The following keys are valid:

eventlog
The primary job eventlog, consisting of timestamped events that drive the
job through various states. For example, a job that is pending resource
allocation in SCHED state transitions to RUN state on the *alloc* event.

See also :doc:`rfc:spec_18` and :doc:`rfc:spec_21`.

guest.exec.eventlog
The execution eventlog, consisting of timestamped events posted by the
execution system while the job is running.

guest.input, guest.output
The job input and output eventlogs, consisting of timestamped chunks of
input/output data.

See also :doc:`rfc:spec_24`.

jobspec
The job specification. Three versions are available:

- default: the *current* jobspec, which may reflect updates,
for example if the job duration was extended

- with :option:`--original`: the original jobspec submitted by the user

- with :option:`--base`: the jobspec as initially ingested to the KVS, after
the frobnicator filled in any default values, but before updates

See also :doc:`rfc:spec_25` and :doc:`rfc:spec_14`.

R
The resource set allocated to the job. Two versions are available:

- default: the *current* R, which may reflect updates, for example if the job
expiration time was extended (default)

- with :option:`--base`: the initial R allocated by the scheduler

See also :doc:`rfc:spec_20`.


RESOURCES
=========

Expand Down

0 comments on commit fc19459

Please sign in to comment.