Need to build and run a Docker image but don't have root access? No problem with Apptainer!

My group is moving towards a working paradigm where each project has a Docker image. This helps keep control of the environments for each project, as you know that operating systems and programming languages like R and Python undergo regular upgrades, which are mostly undesirable for long running data analytics projects. For example in the field of biomedical genomics, some projects can take up to 10 years between initiation and final publication, so having a stable and portable computing environment is crucial.

While this solution is fantastic if you have a workstation where you have free reign to use root/sudo permissions, many data analysts are restricted to using shared computing resources without root. There are some ways to mitigate these restrictions.

One approach is to make a Docker image on another computer and use Singularity or Udocker to pull and convert it to be run by non-root user.

But sometimes, users don't have access to another computer to build these images. Options for non-root users to build such images are very limited. Here I want to demonstrate how to achieve this using Apptainer.


Let's say you have a Dockerfile that describes all the dependancies of the project that looks like this:

FROM bioconductor/bioconductor_docker:RELEASE_3_19

# Update apt-get

RUN apt-get update \

        && apt-get upgrade -y \

        && apt-get install -y nano git libncurses-dev xorg openbox \

        && pip install magic-wormhole           \

        && apt-get clean \

        && rm -rf /var/lib/apt/lists/*

# Install CRAN packages

RUN Rscript -e 'install.packages(c("zoo","tidyverse","reshape2","gplots","MASS","eulerr","kableExtra","vioplot","pkgload","beeswarm"))'

# Install bioconductor packages

RUN Rscript -e 'BiocManager::install(c("DESeq2","fgsea","limma","topconfects","mitch"))'

# get a clone of the codes

RUN git clone https://github.com/markziemann/lung_brain.git

# Set the container working directory

ENV DIRPATH /myproject

WORKDIR $DIRPATH


The first step is to convert this into a format that is compatible with Singularity/Apptainer. For this, spython can convert it to a Singularity definition file. spython is available from pip3 package manager.

spython recipe Dockerfile > myproject.def

Next, the image can be built using Apptainer. Apptainer installation doesn't need root, but due to significant dependancies it would be better managed by the sysadmin, who would probably use a package manager like apt to simplify installation. Anyway assuming that it is installed properly, the image can be built like this:

apptainer build myproject.sif myproject.def

And once the image is built, you can launch the image and start interacting with it using bash. 

apptainer run --writable myproject.sif

or

apptainer shell --writable myproject.sif

After conducting the analysis, getting the results out of the container is the next challenge. By default apptainer does bind mount of the hosts home directory, so this part is relatively simple.

cp myresult.tsv /home/me/myproject/

----

Thanks to Shanon Loveridge for providing the key snippets of code for this post.
Location: Melbourne VIC, Australia

Popular posts from this blog

Two subtle problems with over-representation analysis

Image
Over-representation analysis is a helpful and really frequently used technique for understanding trends from omics data and gene lists more generally. Just to demonstrate this, I tabulated the number of citations of some of the most popular web tools and packages, which reaches a massive 191k citations! But if you have used some of these tools, you will notice that they yield subtly different results. We were curiuous about that and ran a whole bunch of investigations into the internal workings of these tools, in particular clusterProfiler. We identified two subtle problems with clusterProfiler, which we unpack in detail in our new publication , but here I will give you a quick overview. Problem #1: The background problem The first one we call the “background problem,” because it involves the software eliminating large numbers of genes from the background list if they are not annotated as belonging to any category. This results in removing a large number of unannotated genes from the b...
Read more

Data analysis step 8: Pathway analysis with GSEA

Image
In our RNA-seq series so far we've performed differential analysis and generated some pretty graphs, showing thousands of differentially expressed genes after azacitidine treatment. In order to understand the biology underlying the differential gene expression profile, we need to perform pathway analysis. We use Gene Set Enrichment Analysis ( GSEA ) because it can detect pathway changes more sensitively and robustly than some methods. A 2013 paper compared a bunch of gene set analyses software with microarrays and is worth a look. Generate a rank file The rank file is a list of detected genes and a rank metric score. At the top of the list are genes with the "strongest" up-regulation, at the bottom of the list are the genes with the "strongest" down-regulation and the genes not changing are in the middle. The metric score I like to use is the sign of the fold change multiplied by the inverse of the p-value, although there may be better methods out there...
Read more

Uploading data to GEO - which method is faster?

If you have had to upload omics data to GEO before, you'll know it's a bit of a hassle and takes a long time. There are a few methods suggested by the GEO team if you are using the Unix command line: Using 'ncftp' ncftp set passive on set so-bufsize 33554432 open  ftp://geoftp:yourpasscode@ftp-private.ncbi.nlm.nih.gov cd uploads/your @mail.com_ yourfolder put -R Folder_with_submission_files Using 'lftp' lftp  ftp://geoftp:yourpasscode@ftp-private.ncbi.nlm.nih.gov cd uploads/ your @mail.com _ yourfolder mirror -R Folder_with_submission_files Using 'sftp' (expect slower transfer speeds since this method encrypts on-the-fly) sftp  geoftp @s ftp-private.ncbi.nlm.nih.gov password: yourpasscode cd uploads/ your @mail.com _ yourfolder mkdir new_geo_submission cd new_geo_submission put file_name Using 'ncftpput' (transfers from the command-line without entering an interactive shell) Usage example: ncftpput -F -R -z -u  geoftp  -p "yourpasscode...
Read more