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

Plugins offline: Nextflow self-contained distribution allows only core plugins #4330

Open
ewels opened this issue Sep 21, 2023 · 6 comments
Open
Labels

Comments

@ewels
Copy link
Member

ewels commented Sep 21, 2023

Talking to @Alexander-Stuckey about running offline with plugins, I pointed to these docs for fetching plugins for offline use, but it seems that it doesn't work if you use the -all distribution of Nextflow:

N E X T F L O W  ~  version 23.09.1-edge
Launching `/pgen_int_work/BRS/rif/helix_replacement_project/sarek/resources/nf-core-sarek_3.3.1/3_3_1/main.nf` [distracted_meninsky] DSL2 - revision: 19395081df
WARN: Nextflow self-contained distribution allows only core plugins -- User config plugins will be ignored: nf-validation@0.3.2

This is currently the recommended method from nf-core, so it's causing some confusion.

We're starting to see these kinds of problems a lot now, since @nf-core pipelines are adopting the nf-validation plugin. I think that this is probably some of the first very widespread adoption of a non-core Nextflow plugin.

@ewels
Copy link
Member Author

ewels commented Sep 21, 2023

Related to #4329

@bentsherman
Copy link
Member

I think #4340 will make it possible to get around this problem by using the regular Nextflow distribution and downloading the desired set of core plugins. Otherwise we will need to change the self-contained distribution to support non-core plugins, and I don't know how difficult that would be.

@ewels
Copy link
Member Author

ewels commented Sep 28, 2023

Ok, yeah sounds like we probably need to drop the -all distribution at some point. I know it's been spoken about before hand.

I guess tied to this is that we could do with a user friendly way to distribute Nextflow in offline systems to replace that dist. Running Nextflow on another system and then transferring a bunch of directories is quite indirect and unintuitive.

Could we have some kind of "downloader" web pages, that generates an -all dist on the fly with the selected plugins? Or some other way that we can make it easy for people to easily get a Nextflow install that works offline?

Related to #2028 and #2951

@bentsherman
Copy link
Member

bentsherman commented Sep 29, 2023

Could we extend nf-core download for this purpose, or is it only used for container images?

You could write a bash script to install everything you need for offline usage:

  1. install nextflow like normal
  2. install nextflow plugins: nextflow plugin install <plugin>[@<version>]
  3. pull pipeline repos: nextflow pull <project>
  4. download container images
  5. create an archive of items 1-4
  6. transfer archive to offline system
  7. extract that archive over ssh?

@ewels
Copy link
Member Author

ewels commented Sep 29, 2023

Could be an option, yeah 👍🏻

Copy link

stale bot commented Mar 17, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Mar 17, 2024
@stale stale bot removed the stale label Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants