Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: add a capability matrix #319

Open
wants to merge 9 commits into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![Gitter](https://badges.gitter.im/bgruening/docker-galaxy-stable.svg)](https://gitter.im/bgruening/docker-galaxy-stable?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
![docker pulls](https://img.shields.io/docker/pulls/bgruening/galaxy-stable.svg) ![docker stars](https://img.shields.io/docker/stars/bgruening/galaxy-stable.svg)


Galaxy Docker Image
===================

Expand All @@ -20,6 +21,7 @@ The Image is based on [Ubuntu 14.04 LTS](http://releases.ubuntu.com/14.04/) and

# Table of Contents <a name="toc" />

- [Capability matrix](#cap_matrix)
- [Usage](#Usage)
- [Upgrading images](#Upgrading-images)
- [Enabling Interactive Environments in Galaxy](#Enabling-Interactive-Environments-in-Galaxy)
Expand Down Expand Up @@ -47,6 +49,35 @@ The Image is based on [Ubuntu 14.04 LTS](http://releases.ubuntu.com/14.04/) and
- [Support & Bug Reports](#Support-Bug-Reports)


# Capability matrix <a name="cap_matrix" /> [[toc]](#toc)

Galaxy is a powerful framework with sheer endless possibilities of deployment methods and features.
This is often overwhelming and makes the choise for the correct deployment harder.
In the following matrix we will try to give you an overview about the feature we do
offer with the Galaxy Docker project and which features are constantly tested under different deployments.
Please note this can only cover a small spectrum what is actually possible with Galaxy.
We are aiming to fill this matrix step by step, get in [contact](https://gitter.im/bgruening/docker-galaxy-stable) if you want to help!

| Feature | Monolithic | [Compose](https://docs.docker.com/compose) | [Kubernetes](https://kubernetes.io):hatching_chick: | [Swarm](https://docs.docker.com/engine/swarm) | [Rancher](http://rancher.com/rancher-os) |
| ----------------------- |:-------------:| :-------:|:----:|:----:|:----:|
| SLURM Job Runner (JR) | ✔ | ✔ |- |- |✔ |
| HT-Condor JR | ✔ | ✔ |- |- |✔ |
| HT-Condor JR + Docker | - | ✔ |- |- |✔ |
| Kubernetes JR | - | - |- |- |- |
| Chronos JR | - | - |- |- |- |
| Pulsar JR | - | - |- |- |- |
| Interactive Environments| ✔ | ✔ |- |- |✔ |
| Conda resolver | ✔ | ✔ |- |- |✔ |
| TS resolver :koala: | ✔ | - |- |- |- |
| compute auto scale | - | ✔ |- |- |✔ |
| pgadmin4 support | - | ✔ |- |- |✔ |

:koala: For the composed versions, the Tool Shed (TS) resolver were left out on purpose to keep the image sizes small.
It simply means that we do not ship the [requirements](https://galaxyproject.org/toolshed/package-recipes/) needed to compile traditional TS dependencies. This feature can be enabled by simply installing all requirements into the galaxy-web container. However, we recommend to use [Conda packages](https://docs.galaxyproject.org/en/master/admin/conda_faq.html).

:hatching_chick: The kubernetes (k8s) setup is based on [kompose](https://github.com/kubernetes-incubator/kompose) to convert the needed YAML files.


# Usage <a name="Usage" /> [[toc]](#toc)

At first you need to install docker. Please follow the [very good instructions](https://docs.docker.com/installation/) from the Docker project.
Expand Down