nf-core / nf-core/modules

Remove custom docker.runOptions from nextflow.configs living in tests folders

Open
#8,252 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Some modules supply their own docker.runOptions. This is a relict.

https://github.com/search?q=repo%3Anf-core%2Fmodules%20docker.runOptions&type=code

For gatk4spark modules however this might still be needed:

@mahesh-panchal:

I think I have a lead, but I’m not sure what to do about it at the moment. I think the reason spark is not working with the user id and group id passed through docker is because spark wants an entry for it in /etc/passwd. The normal entry point for the docker container I believe has a mechanism to add one:
https://github.com/apache/spark/blob/cef665004847c4cc2c5b0be9ef29ea5510c0922e/reso[…]gers/kubernetes/docker/src/main/dockerfiles/spark/entrypoint.sh
Nextflow however overrides the entrypoint in the .command.run so it calls bash instead.
The docker.userEmulation = true also imports /etc/passwd so perhaps something could be done with beforescript

For other modules we want to remove those.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository code search for docker.runOptions in nextflow.configs under tests folders. Review the single comment and compare gatk4spark modules separately, since that exception is unresolved. Done means removing the obsolete options from other modules while retaining any confirmed Spark requirement and keeping the affected tests valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
testing
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.