The Mulled Toolkit¶
The mulled toolkit distributed as part of galaxy-lib allows for the automatic generation and testing of containers from Conda packages. These containers can be used stand alone on the command-line or automatically as part of properly annotated Galaxy or CWL tools.
This documentation describes the low-level mulled toolkit, but for information on using these containers automatically with tools check out these other documents:
The mulled toolkit utilizes mulled with involucro in an automatic way to build and test containers. This for example has been used to convert all packages in bioconda into Linux Containers (Docker and rkt at the moment) and made available via the BioContainers Quay.io account.
Once you have installed galaxy-lib,
several mulled utilities should be configured on your
Some examples of using these tools are described below.
Search for containers¶
This will search for containers in the biocontainers organisation.
$ mulled-search -s vsearch -o biocontainers
Build all packages from bioconda from the last 24h¶
The BioConda community is building a container for every package they create with a command similar to this.
$ mulled-build-channel --channel bioconda --namespace biocontainers \ --involucro-path ./involucro --recipes-dir ./bioconda-recipes --diff-hours 25 build
Building Docker containers for local Conda packages¶
Conda packages can be tested with creating a busybox based container for this particular package in the following way. This also demonstrates how you can build a container locally and on-the-fly.
> we modified the samtools package to version 3.0 to make clear we are using a local version
- build your recipe
$ conda build recipes/samtools
- index your local builds
$ conda index /home/bag/miniconda3/conda-bld/linux-64/
- build a container for your local package
$ mulled-build build-and-test 'samtools=3.0--0' \ -c iuc,conda-forge,bioconda,file://home/bag/miniconda3/conda-bld/ --test 'samtools --help'
--0 indicates the build version of the conda package. It is recommended to specify this number otherwise
you will override already existing images. For Python Conda packages this extension might look like this
Build, test and push a conda-forge package to biocontainers¶
> You need to have write access to the biocontainers repository
You can build packages from other Conda channels as well, not only from BioConda.
pandoc is available from the
conda-forge channel and conda-forge is also enabled by default in Galaxy. To build
pandoc and push it to biocontainrs
you could do something along these lines.
$ mulled-build build-and-test 'pandoc=1.17.2--0' --test 'pandoc --help' -n biocontainers
$ mulled-build push 'pandoc=1.17.2--0' --test 'pandoc --help' -n biocontainers
Build, test and push containers to your own quay.io repository¶
> You need to have admin access to the quay.io organization or user. > If using travis and wish to encrypt your keys you will need to have the travis gem installed.
- Generate the QUAY_OAUTH_TOKEN and add it to your .travis.yml
If you want your repositories to be public you must give involucro your QUAY_OAUTH_TOKEN token. If you want private containers skip this step.
First head on over to your quay.io dashboard and create a new application for the organization or user. This token will need to have permissions to create new repositories. You can get the full instructions here <https://docs.quay.io/api/> under the ‘Applications and Tokens’ heading. Once your key appears be sure to store it someplace secure! I will say you are storing it in a plain text file called ~/tokens/quay-oauth-token.
$ cd my-recipes-repo ##Using Travis $ travis encrypt QUAY_OAUTH_TOKEN=`cat ~/tokens/quay-oauth-token` --add ##Local Builds $ export QUAY_OAUTH_TOKEN=`cat ~/tokens/quay-oauth-token`
For more information on encrypting keys using travis see <https://docs.travis-ci.com/user/encryption-keys/>
- Give involucro your authentication info
Give Involucro a URL with your information.
The password can either be a plaintext password or the encrypted password. If
you need to check this run
docker login quay.io with your credentials. Save
it to a plain text file called ~/tokens/involucro-auth .
$ cd my-recipes-repo ##Using Travis $ travis encrypt INVOLUCRO_AUTH=`cat ~/tokens/involucro-auth` --add ##Local Builds $ export INVOLUCRO_AUTH=`cat ~/tokens/involucro-auth`
You can also export these variables to your own environment and try it out.
$ cd my-recipes-repo $ export INVOLUCRO_AUTH=`cat ~/tokens/involucro-auth` $ export QUAY_OAUTH_TOKEN=`cat ~/tokens/quay-oauth-token` $ mulled-build build-and-test 'pandoc=1.17.2--0' --test 'pandoc --help' -n MY_QUAY $ mulled-build push 'pandoc=1.17.2--0' --test 'pandoc --help' -n MY_QUAY