tutorials: Add a flux cancel tutorial #210

chu11 · 2023-02-17T04:02:18Z

No description provided.

vsoch · 2023-02-17T04:13:52Z

tutorials/commands/flux-job-cancel.rst

@@ -0,0 +1,114 @@
+.. _flux-job-cancel:
+.. _flux-job-cancelall:


Just a high level note - Dan and I were trying to remember how to cancel the other day and the intuitive thing (that follows other tools) would be flux job cancel --all. Maybe we could deprecate cancelall or (so the intuitive one is available) just provide both?

I didn't happen to write cancelall, although I suspect it was because flux job cancel takes jobids as input while flux job cancelall does not. So separating them out made more sense than having to deal with mixing up the logic of both together.

But it's a fair point, perhaps bring up the --all option for a discussion in flux-core.

I think those commands were modeled after Unix/Linux kill vs killall.

Considering we're still building interfaces, this command could be considered a "plumbing" command in the future, and so I wonder if a whole tutorial on flux job cancel is necessary.
Feels like a "canceling jobs" howto might be better?

I think for the time being, in that flux job cancel is a command (and one we badly needed yesterday!) it should be included here and we can move it / change our minds about it when the CLI is refactored.

With respect to that, I have some pretty strong opinions about cli design so I hope you invite me to the conversation, of course bringing a silver spike and garlic in case I get out of hand 🧛

vsoch · 2023-02-17T04:14:49Z

tutorials/commands/flux-job-cancel.rst

+
+    $ flux mini submit sleep 100
+    ƒh35Dh5qRyq
+


Maybe between here we could add like:

If you've job submit the job, the id will be readily available. If you need to see a list of your current jobs, you can use `flux jobs`.

We also just merged flux job last which might be even easier than flux jobs in this case

In this particular case I was mostly trying to show that the job was running. Since flux mini submit already output the jobid. Then later flux jobs showed the job was canceled.

vsoch · 2023-02-17T04:15:27Z

tutorials/commands/flux-job-cancel.rst

+The special ``flux job cancelall`` command allows you to cancel many jobs.  Several options allow you to
+target a specific set of jobs.
+
+To start off, lets create 100 jobs that will sleep infinitely.  We will use the special ``--cc`` option


oh no, sleeping beauty jobs!

What does --cc mean?

i assume "carbon copy", which we can mention (and hopefully its obvious what it does given what its called)

vsoch · 2023-02-17T04:16:19Z

tutorials/commands/flux-job-cancel.rst

+
+As you can see, we have a lot of jobs waiting to run (state ``S``) and a lot of running jobs (state ``R``).
+
+Lets first ``flux job cancell`` without any options.


Suggested change

Lets first ``flux job cancell`` without any options.

Lets first ``flux job cancel`` without any options.

Or this should be "cancelall" ?

vsoch · 2023-02-17T04:17:51Z

tutorials/commands/flux-job-cancel.rst

+.. code-block:: console
+
+    $ flux job cancelall
+    flux-job: Command matched 100 jobs (-f to confirm)


I would expect this to be flux job cancel --all --force for some future update - I could guess that easily!

vsoch · 2023-02-17T04:19:09Z

tutorials/commands/flux-job-cancel.rst

+As you can see all the jobs are now canceled after passing the ``-f`` option to ``flux job cancelall``.
+
+``flux job cancellall`` has several options to filter the jobs to cancel.  Perhaps the most commonly used
+option is ``-S``.  The ``-S`` option specifies the state of a job to cancel.  The most


Does this have an equivalent long form? It might be easier to read if it's like --state and then the user would remember that (and be able to guess the short form) vs. learning to use -S but not knowing what it means.

grondo · 2023-02-17T05:28:48Z

tutorials/commands/flux-job-cancel.rst

+Cancelling a lot of jobs
+------------------------
+
+The special ``flux job cancelall`` command allows you to cancel many jobs.  Several options allow you to


This might be misleading since flux job cancel can also cancel many jobs.

oh good point, multiple jobids vs filtering mechanism.

grondo · 2023-02-17T05:31:40Z

tutorials/commands/flux-job-cancel.rst

+As you can see ``flux job cancelall --states=pending`` would target the 52 pending jobs for cancellation and
+``flux job cancelall --states=running`` would target the current 48 running jobs for cancellation.
+
+And that's it! If you have any questions, please


Since cancelall is mentioned, might as well mention flux pkill?

i thought about that, but pkill is really about signaling. So its a bit different?

I didn't know Flux resorted to violence. 😱

No pkill cancels jobs

well crud, i guess i was just thinking pkill(1) ... yeah, i guess it should go here too

chu11 · 2023-02-17T05:39:10Z

re-pushed with tweaks given the comments above, thanks!

grondo · 2023-02-17T05:41:33Z

tutorials/commands/flux-job-cancel.rst

+.. code-block:: console
+
+    $ flux mini submit --cc=1-100 sleep inf
+    <snip - many job ids printed out>


Optional: could use --quiet to suppress jobids on standard output

yeah, I didn't use --quiet in the #195 fast job submission guide too. I just didn't want to have to explain another option I used :P

maybe it's not a net win??

Yeah, I only mentioned it since you had to snip the output. Wondering how that will work if output is ever autogenerated.

I didn't get a chance to review the other tutorial pr

chu11 · 2023-02-17T06:36:32Z

ok, re-pushed adding a flux pkill section.

chu11 · 2023-05-11T17:04:44Z

re-pushed adding a note given work on flux-framework/flux-core#5055

vsoch reviewed Feb 17, 2023

View reviewed changes

chu11 force-pushed the flux_job_cancel branch from 0aa0cef to 78cd7f0 Compare February 17, 2023 05:23

grondo reviewed Feb 17, 2023

View reviewed changes

chu11 force-pushed the flux_job_cancel branch from 78cd7f0 to 2ce9597 Compare February 17, 2023 05:38

grondo reviewed Feb 17, 2023

View reviewed changes

chu11 force-pushed the flux_job_cancel branch from 2ce9597 to 8087105 Compare February 17, 2023 06:36

chu11 force-pushed the flux_job_cancel branch from 8087105 to caeb736 Compare February 17, 2023 06:53

chu11 mentioned this pull request Feb 17, 2023

Command Tutorials to do #193

Open

16 tasks

chu11 force-pushed the flux_job_cancel branch 3 times, most recently from b1f4132 to 2fb96cf Compare March 27, 2023 14:00

chu11 changed the title ~~tutorials: Add a flux job cancel tutorial~~ tutorials: Add a flux cancel tutorial Mar 30, 2023

chu11 force-pushed the flux_job_cancel branch 7 times, most recently from 8b08ea5 to 3286fad Compare May 11, 2023 16:20

chu11 mentioned this pull request Jun 7, 2023

tutorials: update flux job cancel tutorial once easy to get cancellation note #211

Closed

chu11 force-pushed the flux_job_cancel branch from 3286fad to 7b164dc Compare June 7, 2023 18:51

tutorials: Add a flux cancel tutorial

7d510f9

chu11 force-pushed the flux_job_cancel branch from 7b164dc to 7d510f9 Compare June 8, 2023 15:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tutorials: Add a flux cancel tutorial #210

tutorials: Add a flux cancel tutorial #210

chu11 commented Feb 17, 2023

vsoch Feb 17, 2023

chu11 Feb 17, 2023

grondo Feb 17, 2023

vsoch Feb 17, 2023

vsoch Feb 17, 2023

grondo Feb 17, 2023

chu11 Feb 17, 2023 •

edited

Loading

vsoch Feb 17, 2023

vsoch Feb 17, 2023

chu11 Feb 17, 2023

vsoch Feb 17, 2023

vsoch Feb 17, 2023

vsoch Feb 17, 2023

vsoch Feb 17, 2023

grondo Feb 17, 2023

chu11 Feb 17, 2023

grondo Feb 17, 2023

chu11 Feb 17, 2023

vsoch Feb 17, 2023

grondo Feb 17, 2023

chu11 Feb 17, 2023 •

edited

Loading

chu11 commented Feb 17, 2023

grondo Feb 17, 2023

chu11 Feb 17, 2023

grondo Feb 17, 2023

chu11 commented Feb 17, 2023

chu11 commented May 11, 2023

		@@ -0,0 +1,114 @@
		.. _flux-job-cancel:
		.. _flux-job-cancelall:


		As you can see, we have a lot of jobs waiting to run (state ``S``) and a lot of running jobs (state ``R``).

		Lets first ``flux job cancell`` without any options.

	Lets first ``flux job cancell`` without any options.
	Lets first ``flux job cancel`` without any options.

tutorials: Add a flux cancel tutorial #210

Are you sure you want to change the base?

tutorials: Add a flux cancel tutorial #210

Conversation

chu11 commented Feb 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chu11 Feb 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chu11 Feb 17, 2023 • edited Loading

Choose a reason for hiding this comment

chu11 commented Feb 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chu11 commented Feb 17, 2023

chu11 commented May 11, 2023

chu11 Feb 17, 2023 •

edited

Loading

chu11 Feb 17, 2023 •

edited

Loading