OpenCGA has published a docker image for quick testing and playing without going through hassle to learn, wait and install each and every OpenCGA components. The docker image is available at the public docker registry under the repository opencb/opencga-demo.
The OpenCGA demo docker image contains the following components:
- OpenCGA binaries
- MongoDB 4.0
- Solr 6.6 (default)
- init.sh, a bash script to :
- Install OpenCGA catalog
- Populate data (optional)
To download OpenCGA demo image, use the command docker pull with the OpenCB enterprise, opencga-demo repository and tag. For example :
To start the OpenCGA demo container, use the command docker run. For example: (This command will pull image as well if not present in local repository)
The first time you run the OpenCGA demo container, it installs the OpenCGA catalog in mongoDB, starts the OpenCGA REST server and finally, it starts the OpenCGA daemon. In this case, no data is loaded. If you want to load some demo data, set the option load to true that instructs OpenCGA demo container to download data from Corpasome project and then, to run an ETL pipeline that loads, annotates, computes statistics and indexes data into the Solr search engine. This process roughly takes 35-40 minutes depending on the internet speed and the machine specifications. Following command starts the OpenCGA container loading demo data:
User can also mount customise directories to store MongoDB and Solr data for ease. The following command will mount the ~/data/mongodb and ~/data/solr directories from host machine to inside container at "/data/opencga/mongodb", "/data/opencga/mongodb" respectively.
You can connect to the OpenCGA demo container using the following command:
To fetch the logs of the OpenCGA demo container, use the following command:
In order to access to the Solr dashboard, use the following URL on your internet browser:
And to access to the OpenCGA REST webservices, use the following URL:
How To Create OpenCGA Demo Docker Image From Source Code
Distributed systems with multiple dependencies require a lot of work to setup, install, configure system and developers would like to have a quick way to test their changes locally and quickly with a system mimicking as close as possible to production systems. Following are the steps to create your own opencga demo image from modified oepncga source code :
Build OpenCGA Next image :
Next Build OpenCGA Demo Image :
Catalog installation and steps to create project, study etc are in listed in "opencga-app/app/scripts/docker/opencga-demo/init.sh" script. User can modify as per own needs for example, change the variant file etc.
Following command will run local OpenCGA Demo :