Difference between revisions of "StarCluster"

From Genome Analysis Wiki
Jump to navigationJump to search
Line 59: Line 59:
 
  ## EC2 Keypairs
 
  ## EC2 Keypairs
 
  ###########################
 
  ###########################
  [key west2_starcluster]
+
  [key <font color='green'>west2_starcluster</font>]
 
  KEY_LOCATION = ~/.ssh/AWS/west2_starcluster_key.rsa  # Same region
 
  KEY_LOCATION = ~/.ssh/AWS/west2_starcluster_key.rsa  # Same region
 
   
 
   
Line 66: Line 66:
 
  ##  starcluster start -c west2_starcluster  nameichose4cluster
 
  ##  starcluster start -c west2_starcluster  nameichose4cluster
 
  ###########################################
 
  ###########################################
  [cluster <font color='red'>myexample</font>]
+
  [cluster <font color='red'>myexample</font>]         # Name of this cluster definition
  KEYNAME = westcluster                      # Name I chose
+
  KEYNAME = <font color='green'>west2_starcluster</font>                # Name of keys I need
 
  CLUSTER_SIZE = 4                            # Number of nodes
 
  CLUSTER_SIZE = 4                            # Number of nodes
 
  CLUSTER_SHELL = bash
 
  CLUSTER_SHELL = bash

Revision as of 15:09, 19 November 2012

Back to the beginning: GotCloud

If you have access to your own cluster, your task will be much simpler. Install the Pipeline software (links at GotCloud) and run it as descibed on the same pages.

For those who are not so lucky to have access to a cluster, Amazon Web Services (AWS) provides an alternative. You may run the pipeline software on a cluster created in AWS. One tool that makes the creation of a cluster of AMIs (Amazon Machine Instances) is StarCluster (see http://star.mit.edu/cluster/).

The following shows an example of how you might use starcluster to create and AWS cluster and set it up to run the Pipeline.

We will use starcluster to launch a set of AWS instances. There are many details setting up starcluster and this is not intended to explain all of the many variations you might choose, but should provide you a working example.

The tasks to be completed are:

  • Install the ec2 tools package (ec2-api-tools for Ubuntu) on your machine (optional)
  • Install and configure starcluster on your machine (required)
  • Create an EBS volume based on the GotCloud snapshot
  • Configure StarCluster to use the volume just created
  • Create an AWS cluster
  • Create storage for your sequence data and make it available for the software
  • Run the Pipeline software

Installing and configuring StarCluster on your machine is described at http://star.mit.edu/cluster/.

StarCluster Configuration Example

StarCluster creates a model configuration file in ~/.starcluster/config and you are instructed to edit this and set the correct values for the variables. Here is a highly simplified example of a config file that should work. Please note there are many things you might want to choose, so craft the config file with care. You'll need to specify nodes with 4GB of memory (type m1.medium) and make sure each node has access to the input and output data for the step being run.

####################################
## StarCluster Configuration File ##
####################################
[global]
DEFAULT_TEMPLATE=myexample

#############################################
## AWS Credentials Settings
#############################################
[aws info]
AWS_ACCESS_KEY_ID = AKImyexample8FHJJF2Q
AWS_SECRET_ACCESS_KEY = fthis_was_my_example_secretMqkMIkJjFCIGf
AWS_USER_ID=199998888709 

AWS_REGION_NAME = us-west-2                 # Choose your own region
AWS_REGION_HOST = ec2.us-west-2.amazonaws.com
AWS_S3_HOST = s3-us-west-2.amazonaws.com

###########################
## EC2 Keypairs
###########################
[key west2_starcluster]
KEY_LOCATION = ~/.ssh/AWS/west2_starcluster_key.rsa   # Same region

###########################################
## Define Cluster
##   starcluster start -c west2_starcluster  nameichose4cluster
###########################################
[cluster myexample]          # Name of this cluster definition
KEYNAME = west2_starcluster                 # Name of keys I need
CLUSTER_SIZE = 4                            # Number of nodes
CLUSTER_SHELL = bash

#  Choose the base AMI using   starcluster listpublic
#   (http://star.mit.edu/cluster/docs/0.93.3/faq.html)
NODE_IMAGE_ID = ami-c6bd30f6
AVAILABILITY_ZONE = us-west-2a              # Region again!
NODE_INSTANCE_TYPE = m1.medium              # 4G memory should work for Pipeline


Create Your Cluster

 starcluster start -c westcluster myseq-example
 StarCluster - (http://web.mit.edu/starcluster) (v. 0.93.3)
 Software Tools for Academics and Researchers (STAR)
 Please submit bug reports to starcluster@mit.edu

 >>> Validating cluster template settings...
 >>> Cluster template settings are valid
 >>> Starting cluster...
     [lines deleted]


Set Up Master Node, Login as root

Login as root and set up the Pipeline software like is says in debian package.

 starcluster sshmaster myseq-example
 StarCluster - (http://web.mit.edu/starcluster) (v. 0.93.3)
 Software Tools for Academics and Researchers (STAR)
   [lines deleted]

 mkdir debs
 cd debs
 wget ftp://share.sph.umich.edu/biopipe/current-align.deb
   [lines deleted]
 wget ftp://share.sph.umich.edu/biopipe/current-umake.deb
   [lines deleted]

 dpkg -i debs/current-align*.deb debs/current-umake*.deb
   [lines deleted]