Cleanup running containers on the Control-C signal #422
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
|
Tested while multiple containers were running on all build hosts. |
christophprokop
added
the
prerelease
ammernico
force-pushed
the
container-cleanup
branch
from
54b622f to
770ffb1
Compare
ammernico
force-pushed
the
container-cleanup
branch
2 times, most recently
from
284f396 to
752d2fc
Compare
primeos-work
requested changes
Oct 14, 2024
Comment on lines
-455
to
-493
| let running_jobs = jobs | ||
| .into_iter() | ||
| .map(|prep| { | ||
| trace!(parent: &run_span, job_uuid = %prep.1.jobdef.job.uuid(), "Creating JobTask"); | ||
| // the sender is set or we need to use the root sender | ||
| let sender = prep | ||
| .3 | ||
| .into_inner() | ||
| .unwrap_or_else(|| vec![root_sender.clone()]); | ||
| JobTask::new(prep.0, prep.1, sender) | ||
| }) | ||
| .inspect( | ||
| |task| trace!(parent: &run_span, job_uuid = %task.jobdef.job.uuid(), "Running job"), | ||
| ) | ||
| .map(|task| { | ||
| task.run() | ||
| .instrument(tracing::debug_span!(parent: &run_span, "JobTask::run")) | ||
| }) | ||
| .collect::<futures::stream::FuturesUnordered<_>>(); | ||
| debug!("Built {} jobs", running_jobs.len()); | ||
|
|
||
| running_jobs | ||
| .collect::<Result<()>>() | ||
| .instrument(run_span.clone()) | ||
| .await?; | ||
| trace!(parent: &run_span, "All jobs finished"); | ||
| drop(run_span); | ||
|
|
||
| match root_receiver.recv().await { | ||
| None => Err(anyhow!("No result received...")), | ||
| Some(Ok(results)) => { | ||
| let results = results | ||
| .into_iter() | ||
| .flat_map(|tpl| tpl.1.into_iter()) | ||
| .map(ProducedArtifact::unpack) | ||
| .collect(); | ||
| Ok((results, HashMap::with_capacity(0))) | ||
|
|
||
| tokio::select! { | ||
| _ = token.cancelled() => { | ||
| anyhow::bail!("Received Control-C signal"); | ||
| } | ||
| r = async { | ||
| let running_jobs = jobs | ||
| .into_iter() | ||
| .map(|prep| { | ||
| trace!(parent: &run_span, job_uuid = %prep.1.jobdef.job.uuid(), "Creating JobTask"); | ||
| // the sender is set or we need to use the root sender | ||
| let sender = prep | ||
| .3 | ||
| .into_inner() | ||
| .unwrap_or_else(|| vec![root_sender.clone()]); | ||
| JobTask::new(prep.0, prep.1, sender) | ||
| }) | ||
| .inspect( | ||
| |task| trace!(parent: &run_span, job_uuid = %task.jobdef.job.uuid(), "Running job"), | ||
| ) | ||
| .map(|task| { | ||
| task.run() | ||
| .instrument(tracing::debug_span!(parent: &run_span, "JobTask::run")) | ||
| }) | ||
| .collect::<futures::stream::FuturesUnordered<_>>(); | ||
| debug!("Built {} jobs", running_jobs.len()); | ||
|
|
||
| running_jobs | ||
| .collect::<Result<()>>() | ||
| .instrument(run_span.clone()) | ||
| .await?; | ||
| trace!(parent: &run_span, "All jobs finished"); | ||
| drop(run_span); | ||
|
|
||
| match root_receiver.recv().await { | ||
| None => Err(anyhow!("No result received...")), | ||
| Some(Ok(results)) => { | ||
| let results = results | ||
| .into_iter() | ||
| .flat_map(|tpl| tpl.1.into_iter()) | ||
| .map(ProducedArtifact::unpack) | ||
| .collect(); | ||
| Ok((results, HashMap::with_capacity(0))) | ||
| } | ||
| Some(Err(errors)) => Ok((vec![], errors)), | ||
| } | ||
| } => { | ||
| r | ||
| } | ||
| Some(Err(errors)) => Ok((vec![], errors)), |
There was a problem hiding this comment.
Note to self: I still need to properly review this part.
| pub struct JobHandle { | ||
| log_dir: Option<PathBuf>, | ||
| endpoint: EndpointHandle, | ||
| container_id: Option<String>, |
There was a problem hiding this comment.
This approach seems fine but we never set container_id back to None for finished jobs - it would be more elegant if we could do so (after ensuring that the container has indeed exited but that might already be implemented to check if the job has finished).
ammernico
force-pushed
the
container-cleanup
branch
from
752d2fc to
4642a14
Compare
- Add the `signal` feature to `tokio` to interrupt and handle the Control-C signal in Butido. - Add Control-C signal handling into the `Orchestrator`. - Implement `Drop` on the `JobHandle` to ensure container cleanup. Fixes science-computing#409 Signed-off-by: Nico Steinle <[email protected]>
ammernico
force-pushed
the
container-cleanup
branch
from
4642a14 to
9e52a33
Compare
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.
signalfeature totokioto interrupt and handle the Control-C signal in Butido.Orchestrator.Dropon theJobHandleto ensure container cleanup.This is a working draft pr for testing purposes and still missing some features.