.. _`aspera-dockerimage`:

=====================
IBM Aspera Quickstart
=====================

.. contents::
   :depth: 2
   :local:

.. admonition:: Compute Resources

    - See the `RIS Service Desk <https://washu.atlassian.net/servicedesk/customer/portal/2/group/6/create/43>`_ for additional assistance.
    - :ref:`User Agreement <compute-user-agreement>`

.. admonition:: Docker Usage

    - The information contained on this page assumes that you have a knowledge base of using Docker to create images and push them to a repository for use. If you need to review that information, please see the links below.
    - :ref:`Docker and the RIS Compute Service <docker-on-compute>`
    - :ref:`Docker Basics: Building, Tagging, & Pushing A Custom Docker Image <ris-docker-basics>`


.. _`aspera-dockerimage-software`:

Image Details
-------------

- Docker image hosted at ghcr.io/washu-it-ris/aspera-connect
- IBM Aspera Connect

Interactive Job
---------------

Environment Variables
~~~~~~~~~~~~~~~~~~~~~

- The Aspera SCP Password provided needs to be set as a variable.

.. code::

    export ASPERA_SCP_PASS="Replace With Provided Password"

- The directory where the provided ssh key is saved needs to be included.
    - E.g. The ssh key is saved in ``/storage1/fs1/${ALLOCATION_NAME}/Active/aspera_key``

    .. code::

        export LSF_DOCKER_VOLUMES="/storage1/fs1/${ALLOCATION_NAME}/Active:/storage1/fs1/${ALLOCATION_NAME}/Active"

- A job should be submitted with the following information to create an interactive job.

.. code::

    bsub -q general-interactive -Is -a 'docker(ghcr.io/washu-it-ris/aspera-connect:ubuntu20)' /bin/bash

- Once the job is running, Aspera commands can be used. Like in the following.

.. code::

    ascp -i "/path/to/aspera_key/aspera_tokenauth_id_rsa" -Q -l 200m -k 1 test.file 'asp-dbgap@gap-submit.ncbi.nlm.nih.gov:test'

.. admonition:: Download Files

    - The example is for a test file to make sure Aspera works. Replace ``'asp-dbgap@gap-submit.ncbi.nlm.nih.gov:test'`` with the file to be downloaded.
    - It is recommended that files are transfered individually and to use scripting loops to download batches.

Docker Image
~~~~~~~~~~~~

.. code::

    ghcr.io/washu-it-ris/aspera-connect:<tag>


.. _`aspera-versions`:

Available Versions
------------------

Current Version:
~~~~~~~~~~~~~~~~
- ghcr.io/washu-it-ris/aspera-connect
    - ubuntu20