Starting and customizing Galaxy on Terra

Allie Cliffe
  • Updated

Interactive applications such as Galaxy run on virtual machines (VMs) in your workspace Cloud Environment. This article describes how to start your Galaxy analysis and adjust the configuration of your Galaxy Cloud Environment to fit your computational needs.

Galaxy Cloud components overview

The Galaxy Cloud Environment is the virtual machine that runs your Galaxy app. Each person in a shared workspace has their own Galaxy VM (see diagram below).  

Components in the Galaxy Cloud Environment VM

  • A virtual machine (VM) engine (compute profile)
  • Software (the current version of Galaxy in the application configuration)
  • A boot disk
  • VM storage (persistent disk).

Diagram of Galaxy Cloud Environment components with two separate Galaxy Cloud Environments inside the workspace perimeter - one for user 1 and one for user 2 - consisting of a distinct VM engine (white), software and VM boot disk (grey) and VM storage (white). Also inside the workspace is a grey box representing the shared workspace storage - Google bucket

VM compute profile

You can adjust the compute profile and persistent disk size of your Galaxy instance VM (white boxes in the diagram above) to meet your analysis needs.

VM software

All Galaxy Cloud Environments come preinstalled with the latest version of Galaxy and a standard boot disk (gray boxes).

How to start a Galaxy instance (default settings)

To start your Galaxy instance (using the default or a customized compute profile and storage size) follow the directions below. 

1. Go to the Analyses tab in your workspace.

2. Click the + Start button next to Your Analyses.
Screenshot of the analyses page with the + Start button circled at the top next to Your analyses

3. Select the Galaxy application from the menu on the right.

4. In the Galaxy Cloud Environment pane, choose your Cloud compute profile (number of nodes, CPUs, and memory) and Persistent disk size.

Cost warningThe cost of running the default Galaxy environment is higher than for the default notebook configuration and there is no autopause feature. Be careful to use your resources wisely and actively pause or delete your environment when you're done working!

The default Galaxy environment includes an up-to-date version of Galaxy, one node with eight CPUs, 52 GB of RAM, and 500 GB of persistent disk storage.
Screenshot of the default galaxy Cloud Environmentconfiguration pane with a blue section at the top showing the running cloud compute cost - $0.53 per hour - paused cloud compute cost - $0.05 per hour - and persistent disk cost - $0.04 per hour. Below this is the Application configuration with Galaxy version 21.9 installed. Below this is the default cloud compute profile of one node, 8 CPUs, and 52 GB of memory. Below this is the persistent disk of 500 GB

5. Click Next to finalize your configuration.

6. On the Galaxy Cloud Environment screen, click Create to spin up your Galaxy instance. 
Screenshot of Galaxy Cloud Environment startup screen with warnings for Setup duration - Creating a cloud environment for Galaxy takes 8-10 minutes. You can navigate away, and we will notify you when it's ready - and Continuation cost - Please pause or delete the cloud environment when finished; it will continue to incur charges if it keeps running. Please see the subsection Pausing/Resuming a Galaxy instance - plus Environment updates - If you would like to update your compute or disk configuration
after an environment is created, please delete the environment and
create a new environment with the desired configuration.

What to expect

You'll see a new Galaxy icon with a blue dot in the right sidebar. The dot will change to green when the VM is done creating (this can take 10 minutes).
Closeup of analyses page with an arrow pointing to the Galaxy logo in the the right sidebar with a blue dot indicating that it is provisioning

7. When provisioning is complete, a popup lets you know your Galaxy Cloud Environment is ready. Clicking Launch Galaxy will take you directly to your very own Galaxy instance (in a new browser tab).
.Screenshot of Your cloud environment for Galaxy popup with a launch galaxy button at the bottom right

About the Galaxy Cloud Environment paneYou can access the Galaxy Cloud Environment pane both when you first create your Galaxy app instance, then again after the Galaxy app has been created in case you'd like to view what configs you chose.

The Galaxy Cloud Environment pane displays the current configuration and a cost estimate for either that configuration or another hypothetical configuration you're thinking of using instead.

How to customize Galaxy 

You can customize the compute profile and storage size of your Galaxy instance from the Galaxy Cloud Environment pane. Follow the steps below to access the Galaxy Cloud Environment pane while Galaxy is running. 

You must re-create (i.e., delete) your Galaxy VM to change any customizations Currently, Terra does not support updating the compute configuration of a Galaxy application that is already running. If you decide you want to change an existing configuration, you'll need to delete that instance and re-create it with a different configuration.

1. Go to the Analyses tab in your workspace.

2. Click the Galaxy icon with the green dot in the sidebar.

3. In the Galaxy Environment Details pane, click the gear icon (environment settings). 

4. In the Galaxy Cloud Environment pane, click Delete Environment.

5. Leave the radio button to keep the persistent disk but delete application configuration and compute profile.

6. Click Delete (bottom right).

Once the old instance is deleted, you can click the cloud icon in the sidebar and follow directions above to customize and start a new Galaxy instance. You'll be able to adjust your Cloud compute profile (number of nodes, CPUs and memory) and Persistent disk size. 
Screenshot of the Cloud Environment configuration pane with  a blue section at the top showing the running cloud compute cost - $0.53 per hour - paused cloud compute cost - $0.05 per hour - and persistent disk cost - $0.04 per hour. Below this is the Application configuration with Galaxy version 21.9 installed. Below this is the default cloud compute profile of one node, a dropdown with options of 8, 16, 32, 64, and 96 for the CPUs, and 52 GB of memory. Below this is the persistent disk of 500 GB

Cost-saving recommendations

Size your compute power appropriately

You pay a fixed amount while Galaxy is running, whether or not you do active calculations. The cost is based on the compute power of your virtual machine or cluster, not on how much computation is being done. So you want to have enough power to do your computations in a reasonable amount of time, but not a lot of extra that you pay for but don't use.

Avoid runaway costs! Always shut off your Galaxy instance when you're done working! You will continue to pay the cost displayed in blue on your Galaxy Cloud Configuration pane as long as your instance is running. There is no autopause functionality in Terra for Galaxy analyses. To keep from being charged, you will need to delete your Galaxy VM explicitly every time. 

How to delete a Galaxy instance
You will find a list of all Cloud Environment VMs and all persistent disks and their status at https://app.terra.bio/#clusters (go to Main Menu > Your name > Cloud Environments). You can delete it directly from this page. Note that you can keep your storage persistent disk.

You can also delete your Galaxy VM by clicking on the Galaxy logo in the workspace side panel and selecting the Delete button at the bottom.

To learn more about controlling cloud costs, see Controlling cloud costs - sample use cases.

How to save Galaxy outputs to the Workspace bucket

Reasons to copy generated data to workspace storage

  • To share outputs with collaborators
  • To use generated data as input for a workflow
  • To copy data to external or local long-term storage

How to copy data to workspace storage

Galaxy has a built-in upload/download system where you can pull data to and from the bucket to the PD.

Copy-data-in-Galaxy-instance_Screen-shot.png

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.