OpenCGA
OverviewInstallationUsing OpenCGA
v2.1
v2.1
  • Home
  • Overview
    • Features
    • Architecture Diagram
    • Security
    • Metadata and Clinical Data
    • Data Models
      • Sample
      • Individual
    • Alignment and Coverage
    • Variant Query and Analysis
    • Clinical Data Analysis
    • Running Analysis
    • Scalability and Performance
    • Sizing OpenCGA
  • OpenCGA Architecture
    • Catalog
    • Alignment and Coverage
    • Variant Storage Engine
      • Variant Data Model
    • Clinical Analysis
    • Analysis Framework
  • Data Models
    • User
    • Project
    • Study
    • File
    • Sample
    • Individual
    • Family
    • Cohort
    • Job
    • Clinical Analysis
  • Case Studies
    • Genomics England Research
    • Microsoft Azure
  • User Manual
    • Installation
      • Kubernetes Cluster
        • Azure
        • Configuration
      • On-Premise HPC Cluster
        • Server Configuration
        • Getting OpenCGA
        • Choosing Variant Storage Engine
        • Configuration
      • Running Docker
    • Login
    • Using OpenCGA
      • REST Web Service API
      • IVA Web App
      • Client Libraries
        • pyopencga - Python Library
        • opencgaR - R library
        • Java
        • JavaScript
      • Command Line
        • Configuration
      • Public Demo
    • Managing Data
      • Sharing and Permissions
        • Users and Groups
        • Study ACLs
      • Create Projects and Studies
      • Load VCF Files to a Study
      • Working with Files
      • Population of Metadata
        • Adding Custom Metadata
        • Data Versioning
    • Alignment Engine
      • BAM Index
      • Alignment Read Query
      • Working with Coverage
      • Alignment Analysis
    • Variant Storage Engine
      • Variant Query
      • Variant Aggregation Stats
      • Variant Analysis
    • Clinical Genomics
      • Clinical Interpretation
      • Clinical Analysis
    • Using JupyterLab
    • Administrator
      • User Management
      • Templates / Manifest
  • About
    • Roadmap
    • Release Notes
    • Community
Powered by GitBook
On this page
  • Overview
  • Implementation
  • Run OpenCGA Cluster
  • Run OpenCGA Local
  • Build Docker Images

Was this helpful?

  1. User Manual
  2. Installation

Running Docker

PreviousConfigurationNextLogin

Last updated 4 years ago

Was this helpful?

Overview

OpenCGA produces four different Docker images for runnning OpenCGA in two main different modes: cluster and local. All of them run Java 8 and can be found in , the docker images are:

  • : base image for building the other images, this image contains the OpenCGA basic installation folder.

  • : image running REST web services

  • : image running master service

  • : all-in-one image with all OpenCGA components running

You can use OpenCGA Docker image to run a complete OpenCGA platform locally. You can use the other images to deploy a whole cluster solution in a cloud environment using Kubernetes. Docker Images are deployed in .

Implementation

OpenCGA publishes a number of images into for user ease. These images are based on Alpine JRE images to keep sizes as small as possible, contains OpenCGA binaries, for complete contents of image, please have a look at Dockerfile in github. A typical image name will follow the following structure :

  • opencga:{OPENCGA_VERSION_NUMBER}-{VARIANT_STORAGE_FLAVOUR}

    • OPENCGA_VERSION_NUMBER will be like 1.4.0, 1.4.2, 2.0 etc

    • VARIANT_STORAGE_FLAVOUR can be mongoDB 4.0, hdinshigh, emr etc

    • e.g. opencga:1.4.0-mongo4.0

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 :

    1. Install OpenCGA catalog

    2. Populate data (optional)

Run OpenCGA Cluster

Kubernetes, Ansible, OpenStack, ....

Run OpenCGA Local

This mode is not intended for production but for a user demo.

Build Docker Images

To download OpenCGA demo image, use the command with the OpenCB enterprise, opencga-demo repository and tag.

OpenCB Docker Hub
opencga-base
opencga-init
opencga-r
opencga-demo
Docker Hub OpenCB organisation
DockerHub
docker pull