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

workDir and jobStore should default to (shared) tmp-outdir-prefix #5143

Closed
gmloose opened this issue Oct 28, 2024 · 1 comment · Fixed by #5154
Closed

workDir and jobStore should default to (shared) tmp-outdir-prefix #5143

gmloose opened this issue Oct 28, 2024 · 1 comment · Fixed by #5154

Comments

@gmloose
Copy link
Contributor

gmloose commented Oct 28, 2024

The documentation for the options --workDir and --jobStore state that, when a workflow is run on a distributed batch system, these locations must be accessible by all worker nodes. Currently, unless explicitly set by the user, both workDir and jobStore are set to whatever value is given to tmpdir-prefix (or a system-default tmpdir location).

It would make sense to set workDir and jobStore to whatever value is given to tmp-outdir-prefix, which should be set to a shared location when using a distributed batch system.

I therefore propose the following changes:

  • tmp-outdir-prefix defaults to tmpdir-prefix, unless given on the command-line
  • workDir defaults to tmp-outdir-prefix, unless given on the command-line
  • jobStore defaults to tmp-outdir-prefix, unless given on the command-line
  • coordinationDir defaults to the default tmpdir-prefix, ignoring tmpdir-prefix when given on the command-line (rationale: this is a book-keeping location, that must be on a local 100% posix-compliant file system, because it uses file locks).

Note that tmpdir-prefix need not exist on the node where Toil is running, as long as it exists on all the worker nodes. Hence, Toil should not check for its existence on the "head" node.

I can create a pull request. However, I'm unsure as to how this should be tested, because I couldn't find any Toil tests that check the correct (documented) behaviour of these command-line options. Are there?

┆Issue is synchronized with this Jira Story
┆Issue Number: TOIL-1664

@gmloose
Copy link
Contributor Author

gmloose commented Nov 12, 2024

Provided by #5154

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 a pull request may close this issue.

1 participant