Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 3.13 KB

documentation_overview.md

File metadata and controls

51 lines (33 loc) · 3.13 KB
<style> code { color: #777777; } body { line-height: 2; font-family: "Helvetica"; } hr { border-top: 3px solid #C0C0C0; } </style>

Launch a GVL instance on the cloud

A GVL instance is a server, usually running as a virtual machine in a cloud environment. You can find an overview of supported clouds and how to launch an instance on the Launch page.

In particular, a step-by-step guide to launching an instance on the Australian Research Cloud (NeCTAR) can be found here.


Use and administer your instance

Your GVL instance runs your own Galaxy server as well as several other services, including CloudMan, RStudio Server and IPython Notebook, and an underlying Ubuntu linux environment. These services are described on the Workbench Services page.

On GVL versions older than 4.0, some services will not be available until installed. Instructions on doing this can be found on v3.05 of the README in our GitHub repository.

When you first create your instance, you will be given an IP address which you can access in a web browser. At the home page of your instance you should find your GVL Dashboard, with a list of Workbench Services and login instructions.

Documentation on some common GVL administration tasks, including CloudMan, Galaxy and Research Cloud tasks, can be found in this GVL administration guide.

For general documentation on using Galaxy itself, the best source is the Galaxy Project website. This site includes documentation on Galaxy Administration.

Instructions for command-line utilities administration can be found in the GVL commandline utilities GitHub repository. These include instructions for:

  • Adding a new linux or RStudio Server user
  • Updating the environment modules to reflect changes in tools installed from the Galaxy Toolshed
  • Using galaxy-fuse to directly mount Galaxy Datasets for command-line access

Build a custom GVL

"Building" a GVL refers to creating a new, custom cloud image, which can be used to launch new instances. Most users will not need to do this.

Reasons to build a new GVL image include:

  • You would like to port the GVL to a cloud environment where it is not already available.
  • You would like to make custom modifications which you can't make after launch, or create a modified image, tailored to your research domain, from which your own research community to can launch instances.

The ansible playbook used to build the GVL image and GVL filesystem, and instructions for using it, can be found in our GVL image bitbucket repository. These scripts are heavily reliant on the Galaxy CloudMan playbook, which you will find referenced in the README.