Skip to content

Commit

Permalink
doc: add note about immutable jobs to flux-update(1)
Browse files Browse the repository at this point in the history
Problem: The flux-update(1) man page does not mention that jobs
updated by the instance owner may become immutable.

Add an explanation of how jobs updated by the instance owner can
bypass validation, and why this makes the jobs immutable.
  • Loading branch information
grondo committed Aug 28, 2023
1 parent 35d99e1 commit c34f2cc
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/man1/flux-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,17 @@ all updates are either applied or the request fails.
a case by case basis. At this time, the set of keys that can actually
be updated for a job may be very limited.

The instance owner may be allowed to update specific attributes of jobs
and bypass validation checks. For example, the duration of a guest job may
be increased beyond currently configured limits if the update request is
performed by the instance owner. When a job is modified in this way, future
updates to the job by the guest user are denied with an error message::

job is immutable due to previous instance owner update

This is necessary to prevent possible unintended bypass of limits or
other checks on a job by a guest.

The flux-update(1) command may also support special handling of values
for specific keys. Those special cases are documented in the SPECIAL KEYS
section below.
Expand Down

0 comments on commit c34f2cc

Please sign in to comment.