flux-jobs: add -i, --include=HOSTS|RANKS option
#6209
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
garlick
approved these changes
Aug 12, 2024
doc/man1/flux-jobs.rst
Outdated
Comment on lines
56
to
59
| List only jobs where the assigned resources intersect with the supplied | ||
| argument, which may be specified either as an idset of broker ranks or | ||
| list of hosts in hostlist form. It is not an error to specify ranks or | ||
| hosts which do not exist. |
There was a problem hiding this comment.
Might want to use "RFC 22 idset" and "RFC 29 hostlist" and add the references to a FLUX RFC section e.g.
FLUX RFC
========
| :doc:`rfc:spec_22`
| :doc:`rfc:spec_29`
There was a problem hiding this comment.
Good suggestion! I've done that and also fixed a typo and force-pushed the result.
Problem: There is no way to pass a constraint to flux.job.job_list() Add an optional constraint parameter to job_list() and job_list_inactive()
Problem: There is no way to pass extra constraints via the JobList interface. Add an optional constraint parameter to the JobList initializer. This parameter takes a string in constraint query syntax which is parsed by an instance of JobListConstraintParser. The result is then joined with ``and`` to any other constraints before being passed to the job-list module.
Problem: There is no easy way to restrict the output of flux-jobs(1) based on a set of hosts or ranks, but this is basic and useful functionality. Add a new `-i, --include=` optiont that takes a hostlist or idset of targets, and adds a constraint to the JobList query that restricts matching jobs to those that were allocated the provided targets. Fixes flux-framework#6202
Problem: None of the Python tests ensure the job_list and job_list_inactive optional constraint parameters work. Add a couple simple tests to t0013-job-list.py that ensure the constraint parameters to these functions do something.
Problem: There are no tests of the flux-jobs -i, --include option. Add some simple tests of this option to t2800-jobs-cmd.t.
Problem: The -i, --include option is not documented in flux-jobs(1). Document it.
grondo
force-pushed
the
flux-jobs-include
branch
from
a4064ed
to
b2868cc
Compare
|
Setting MWP here unless I hear objections. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6209 +/- ##
==========================================
- Coverage 83.62% 83.31% -0.31%
==========================================
Files 512 521 +9
Lines 83199 85203 +2004
==========================================
+ Hits 69576 70990 +1414
- Misses 13623 14213 +590
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR takes a bit of the minor work from #5711 and uses it to implement a
-i, --include=HOSTS|RANKSoption forflux jobsas suggested in #6202.This might be a more palatable first step that what's proposed in #5711, is useful on its own, and if the advanced
-f, --filter"query syntax" is ever merged, the hostlist/ranks constrain can easily be combined (if used) withand.The option name of
-i, --includecould be controversial here. I wouldn't have thought of it except that it was proposed by @kkier, and I like that it matches the similar options influx-resource(1)for consistency. I also like that it works for both ranks and hostnames.However, easy to change if others do not agree.