Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JasonYangShadow/lpmx

A novel composable rootless container system
https://github.com/JasonYangShadow/lpmx

container-linux docker docker-image fakechroot fakeroot rootless rootless-container singularity unionfs

Last synced: 10 days ago
JSON representation

A novel composable rootless container system

Awesome Lists containing this project

README 

        
![lpmx logo](./lpmx_small.PNG)



# LPMX [![Build Status](https://travis-ci.com/JasonYangShadow/lpmx.svg?branch=master)](https://travis-ci.com/JasonYangShadow/lpmx) ![Discord user id](https://dcbadge.vercel.app/api/shield/500280645285707776?style=plastic&theme=clean) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=JasonYangShadow_lpmx&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=JasonYangShadow_lpmx) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=JasonYangShadow_lpmx&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=JasonYangShadow_lpmx) 

LPMX, i.e, Local Package Manager X, is a **pure rootless composable** container system. It helps researchers run genome analysis tools via existing Docker or Singularity (experimental) images without root/sudo privilege required. Besides, researchers can benefit from composability, e.g. allowing one to write a pipeline consisting tools from different containers.



# Why should I use containers?

In bioinformatics, [Bioconda](https://bioconda.github.io) 

is a repository containing popular bioinformatics tools and allows users to install binaries of these tools rather than compiling them from scratch. But conflicting tools (requiring conflicting dependencies, e.g. Python2 & Python3) inside a genome analysis pipeline can not be set up successfully because Bioconda can not install them inside a single namespace. For example, [Manta](https://github.com/Illumina/manta) still requires Python2, so  installing a pipeline consisting of Manta and other Python3-based tools will fail. Bioconda moved the burden of resolving the dependency hell from users to developers. But we need to further eliminate the burden for developers.

Container virtualization can solve this problem by isolating each tool into a container. 



# Why should I use LPMX?

[Singularity](https://sylabs.io/singularity/), a popular tool for container virtualization in science, is getting more and more popular recently. However, Singularity lacks **composability**. For example, we have a GATK container and a minimap2 container (both of which are created by somebody else than us), if we want to containerize a custom pipeline utilizing the existing containers, we need to write a substantial amount of code to bridge the custom pipeline and the containers (GATK & minimap2). 



To this end, LPMX provides composability. With LPMX, we can compose existing container images to create a custom pipeline container without writing a large amount of glue code.



Besides, you can directly use existing Docker and Singularity images with LPMX without root privilege, which is safe and convenient. You can also install software inside containers as you commonly do on your laptop.



# Features

1. **Pure Rootless**, root privilege is not required at any stage, including installation, launching containers, creation of images. It is suitable for Linux clusters, where users do not have root permission.

2. **Composability**, existing container systems do not allow users to compose existing containers. LPMX has composability feature. Imagine that you can containerize the Canu assembler inside a container and still allows it to submit jobs via the host job submission command, e.g. qsub.

3. **Userspace Union File System(UUFS)**, LPMX implements its own simple userspance union file system to support loading layers extracted from Docker images (or other layered file system). Unlike existing implementations such as [fuse-overlayfs](https://github.com/containers/fuse-overlayfs), UUFS does not require neither newer Linux kernels nor preinstalled libraries, it purely runs in userland. The UUFS is designed to support sharing base layers among different containers so that storage space and network traffic are saved, while container launch speed is largely accelerated.

4. **Understanding existing container image meta-data(Limited distros, Alpine is not supported)**, LPMX can create containers via Docker images available on the docker hub. Currently Ubuntu and CentOS series are supported. Besides, the latest release also has experimental support for the Singularity image.

5. **Designed for restricted runtime environment**, LPMX is designed for running containers in restricted runtime environments, such as root privilege is not approved or complete off-line usage. LPMX supports complete off-line initialization and deployment, which is especially suitable for scientific computing infrastructure.

6. **Easy to access GPGPU resource**, LPMX provides end-users an easy way to access the host GPGPU resource. An example is here [https://github.com/JasonYangShadow/lpmx/wiki/GPGPU](https://github.com/JasonYangShadow/lpmx/wiki/GPGPU)



# Quick Run

All following commands use Ubuntu 18.04 as host OS.



1. Install LPMX

```

# for x86_64 binary

$ wget -O lpmx https://github.com/JasonYangShadow/lpmx/blob/master/build/linux/x86_64/Linux-x86_64-lpmx?raw=true



$ chmod a+x lpmx && ./lpmx init

```



2. Download Docker Image and Run

```

# download common Linux distro from Docker hub

$ ./lpmx docker download ubuntu:16.04



# echo hello world

$ ./lpmx docker fastrun ubuntu:16.04 "echo 'hello world'"



```



3. Try minimap2

```

# download common genomic analysis tools from Docker hub

$ ./lpmx docker download evolbioinfo/minimap2:v2.17



# run minimap2

$ mkdir -p $PWD/share

$ wget -O $PWD/share/human.fa https://raw.githubusercontent.com/lh3/minimap2/master/test/MT-human.fa

$ wget -O $PWD/share/orang.fa https://raw.githubusercontent.com/lh3/minimap2/master/test/MT-orang.fa

$ ./lpmx docker fastrun -v $PWD/share=/share evolbioinfo/minimap2:v2.17 "minimap2 -a /share/human.fa /share/orang.fa > /share/minimap2.sam"

$ ls -al $PWD/share

```



4. Compose different containers

```

# download Docker image with old versions of minimap & samtools

$ ./lpmx docker download jasonyangshadow/example:1



# show version info of old minimap & samtools

$ ./lpmx docker fastrun jasonyangshadow/example:1 "minimap -V"

$ ./lpmx docker fastrun jasonyangshadow/example:1 "samtools"



# create minimap2 container

$ ./lpmx docker create -n minimap2 -v $PWD/share=/share evolbioinfo/minimap2:v2.17



# exit the newly created container

$root exit



# get container id

$ container_id=`./lpmx list -n minimap2 | awk '{if (NR!=1) {print $1}}'` 



# expose minimap2 to make it available to host and other containers

$ ./lpmx expose -i $container_id -n minimap2 -p /usr/local/bin/minimap2

$ ls -al $PWD/bin/minimap2



# replace old version of minimap with newer minimap2 and keep using old version of original samtools

$ ./lpmx docker fastrun -v $PWD/share=/share -m $PWD/bin/minimap2=/usr/bin/minimap jasonyangshadow/example:1 "minimap '-V'"

$ ./lpmx docker fastrun -v $PWD/share=/share -m $PWD/bin/minimap2=/usr/bin/minimap jasonyangshadow/example:1 "minimap '-a /share/human.fa /share/orang.fa > /share/test.sam'"

$ ./lpmx docker fastrun -v $PWD/share=/share jasonyangshadow/example:1 "samtools view -S -b /share/test.sam > /share/test.bam"

$ ls -al $PWD/share

```



5. Try GPGPU

```

# if you can run nvidia-smi on the host, then you can easily get access GPGPU inside container with a simple command

$ FAKECHROOT_USE_SYS_LIB=true ./lpmx docker fastrun -m /usr/bin/nvidia-smi=/usr/bin/nvidia-smi ubuntu:16.04 "nvidia-smi"

```



That's it!



For all other command details, please check [wiki](https://github.com/JasonYangShadow/lpmx/wiki)



# Composability Feature

Genome analysis tools are often difficult to install due to their complex dependencies and conflicts. 

Container virtualization systems such as Dockera and Singularity can help researchers install tools by isolating tools. However, they lack **composability**, an easy way to integrate multiple tools in different containers or multiple tools in a container and a host, which was an obstacle to benefit from container systems in research. An example is that tools that require distributed computing are not straightforward to be containerized. Another example is that a pipeline container integrating different tools or versions is difficult to build from existing containers.



![composability](figures/composability.jpg)



The below video shows how to dynamically inject applications inside other LPMX containers into a current running LPMX container, you can see that even though applications, e.g. bwa, samtools, are not installed inside the currently running container, you can still inject them easily if they are already created via LPMX. This will greatly help integrate existing containers without repeated creation.



[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/kf94-rmOFYA/0.jpg)](https://www.youtube.com/watch?v=kf94-rmOFYAE)



And a gif showing injecting an exposed samtool into another container



![samtool](https://user-images.githubusercontent.com/2051711/100324168-301dd600-300a-11eb-9170-5457613b0db4.gif)



Below is a basic demo of using LPMX:



[![LPMX DEMO](http://img.youtube.com/vi/_1XOLa1cKX4/0.jpg)](http://www.youtube.com/watch?v=_1XOLa1cKX4 "LPMX simple demo")



# X11 APP also works

![X11](figures/x11.png)



# Common commands

1. List existing containers with their container ids, status and other info(also with name filter)

   ```

   ./lpmx list -n name

   ```

2. Download Docker image from Docker Hub

   ```

   ./lpmx docker download ubuntu:16.04

   ```

3. Create container with binding volumes via Docker image

   ```

   ./lpmx docker create -v /host_path=/container_path -n name ubuntu:16.04

   ```

4. Delete container

   ```

   ./lpmx destroy container_id(which can be found by calling list command #1)

   ```

5. Resume container

   ```

   ./lpmx resume container_id(which can be found by calling list command #1)

   ```



# Limitations

1. Only Linux(x86-64) systems are supported. (**Windows/Mac OS** are not supported)

2. **NON-GLIBC** based distros(For host OS and container images) are not supported, because our fakechroot only wraps functions inside GNU C Library(glibc), so both host OS and container images should be Glibc-based. For example, LPMX does not support Alpine Linux

3. User can not do privileged manipulations inside containers, such as but not limited to:

   - open privileged ports (range below 1024)

   - mount file systems

   - use su command inside containers

   - change host name, system time and etc.  

4. Executables statically linked do not work properly inside containers. Recompiling them withshared libraries is a recommended workaround. Alternatively, users can install such staticallylinked executables on host and call it from inside container by exposing them by LPMX, if needed.

5. Some commands, e.g ps command, will not work as expected inside containers due to the lackof inter-process communication namespace isolation; a customized ps command wrapper cando the trick.

6. LPMX does not work with a root account; end-users should use non-privileged accounts.

7. Setuid/setgid executables do not work inside LPMX containers because LD_PRELOAD is disabled by Linux for such executables.

8. When executables uses a system call that does not exist in the host kernel, LPMX cannotexecute them. This is the common limitation of container systems.

9. **(We need supports from community!)** Only several host OS are supported currently in this [repository](https://github.com/JasonYangShadow/LPMXSettingRepository) (Ubuntu 12.04/14.04/16.04/18.04/19.04, Centos 5.11/6/6.7/7), we compiled fakechroot against common Linux distros, but still there might be incompatability issues among different glibc versions. Common container image types are supported, such as Ubuntu and CentOS. 



# Incompatible Images

https://github.com/JasonYangShadow/lpmx/wiki/incompatible-images



# Online Tutorial Session

If you are interested in LPMX and want an online tutorial session, please fill in this [Online Tutorial Request Form](https://forms.gle/6tUYdMmMSo6nDv916), I will contact you. (English will be used).:w



# Related Projects



- [Fakechroot](https://github.com/JasonYangShadow/fakechroot)

- [LPM](https://lpm.bio/)

- [udocker](https://github.com/indigo-dc/udocker)

- [Singularity](https://sylabs.io/singularity) & [Singularity Compose](http://singularityhub.github.io/singularity-compose)



# Reference

- Please cite our work

  ```

  Yang, X., Kasahara, M. LPMX: a pure rootless composable container system. BMC Bioinformatics 23, 112 (2022). https://doi.org/10.1186/s12859-022-04649-3

  ```

- [Vagrant Box](https://app.vagrantup.com/jasonyangshadow/boxes/benchmark_ubuntu1804) containing experiment environment and [experiment attachments](https://github.com/JasonYangShadow/experiment_attachments) containing necessary scripts for reproducibility



# Acknowledgements

- Computations were partially performed on the NIG supercomputer at ROIS National Institute of Genetics. https://gc.hgc.jp

- Supported by SHIROKANE super computing system in Human Genome Center, The Institute of Medical Science, The University of Tokyo. https://www.at.hgc.jp/

- Thanks to Department of Computational Biology and Medical Sciences, The University of Tokyo. http://www.cbms.k.u-tokyo.ac.jp/english/index.html