Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Limit reading/mounting from shared filesystem JobStore #5047

Merged
merged 6 commits into from
Aug 15, 2024

Conversation

adamnovak
Copy link
Member

This fixes #4673 by adding a --symlinkJobStoreReads option.

If you set --symlinkJobStoreReads=False, we won't create symlinks pointing into a FileJobStore when jobs go to read from it. We will instead make copies or hardlinks (within a filesystem). So if you have a workload that does more I/O on a file mounted into a container than a single full copy would do, you can use this to make a copy happen instead of having everyone mount straight from the shared filesystem.

If you have caching enabled, you can make the cache actually cache a copy per node instead of symlinking all the way through just because it can.

Changelog Entry

To be copied to the draft changelog by merger:

  • New --symlinkJobStoreReads=False option lets you force local-node copies (possibly in the cache) even when reading directly from a FileJobStore is possible, potentially reducing shared filesystem IO.

Reviewer Checklist

  • Make sure it is coming from issues/XXXX-fix-the-thing in the Toil repo, or from an external repo.
    • If it is coming from an external repo, make sure to pull it in for CI with:
      contrib/admin/test-pr otheruser theirbranchname issues/XXXX-fix-the-thing
      
    • If there is no associated issue, create one.
  • Read through the code changes. Make sure that it doesn't have:
    • Addition of trailing whitespace.
    • New variable or member names in camelCase that want to be in snake_case.
    • New functions without type hints.
    • New functions or classes without informative docstrings.
    • Changes to semantics not reflected in the relevant docstrings.
    • New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
    • New features without tests.
  • Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
  • Finish the review with an overall description of your opinion.

Merger Checklist

  • Make sure the PR passes tests.
  • Make sure the PR has been reviewed since its last modification. If not, review it.
  • Merge with the Github "Squash and merge" feature.
    • If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
  • Copy its recommended changelog entry to the Draft Changelog.
  • Append the issue number in parentheses to the changelog entry.

Copy link
Member

@DailyDreaming DailyDreaming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, though could something be added to the docs for --symlinkJobStoreReads and when to use it?

Also, particularly: https://github.com/DataBiosphere/toil/blob/7d4d0749e9f5ffcc2a4507e13e940e46400a020d/docs/running/cliOptions.rst

@adamnovak adamnovak merged commit 5b1dbdb into master Aug 15, 2024
1 check passed
@adamnovak adamnovak deleted the issues/4673-control-symlink-reads branch August 15, 2024 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow CWL and WDL workflows to minimize access to a shared-filesystem file job store
2 participants