Master Table of Contents

Contents:

• Overview
• Installing StarCluster
  • Install Latest Stable Release from PyPI
    • Manually Install Latest Stable Release from PyPI
  • Install development version from github
    • Install development version using a downloaded snapshot
    • Install development version using git
• Quick-Start
  • Learn more...
• StarCluster Guides
  • Sun Grid Engine (SGE) QuickStart
    • Submitting Jobs
    • Monitoring Jobs in the Queue
    • Viewing a Job’s Output
    • Monitoring Cluster Usage
    • Creating a Job Script
    • Deleting a Job from the Queue
    • OpenMPI and Sun Grid Engine
      • OpenMPI Parallel Environment
      • Round Robin vs Fill Up Modes
      • Submitting OpenMPI Jobs using a Parallel Environment
• StarCluster User Manual
  • StarCluster Configuration File
    • Creating the configuration file
    • Amazon Web Services Credentials
    • Amazon EC2 Regions
    • Amazon S3 Region-Specific Endpoints
    • Amazon EC2 Keypairs
    • Defining Cluster Templates
    • Defining Multiple Cluster Templates
    • Setting the Default Cluster Template
    • Amazon EBS Volumes
    • Amazon Security Group Permissions
    • Defining Plugins
  • Using EBS Volumes for Persistent Storage
    • Create, Partition, and Format a new EBS Volume
  • Launching a StarCluster on Amazon EC2
    • Managing Multiple Clusters
    • Logging into the master node
    • Logging into the worker nodes
    • Shutting Down a Cluster
  • Getting Started with StarCluster
    • Logging into the master node
    • Logging into a worker node
    • Verify /etc/hosts
    • Verify Passwordless SSH
    • Verify /home is NFS Shared
    • Ensure EBS Volumes are Mounted and NFS shared (OPTIONAL)
    • Verify scratch space
    • Compile and run a “Hello World” OpenMPI program
  • Creating a New AMI From the StarCluster AMI
  • Listing All Public StarCluster AMIs
  • Enabling Tab Completion for Bash/Zsh
    • Enabling StarCluster Tab Completion in BASH
    • Enabling StarCluster Tab Completion in ZSH
    • Using StarCluster Tab Completion
  • StarCluster Plugin System
    • Creating a New Plugin
    • Using the Logging System
    • Adding Your Plugin to the Config
    • Using the Development Shell
    • Plugin Development Workflow
  • Adding and Removing Nodes from StarCluster
    • Adding Nodes
    • Removing Nodes
  • StarCluster Elastic Load Balancer
    • Usage
    • Configuration
    • Capabilities
    • Operation
  • Hacking on StarCluster
  • Features
• Plugin Documentation
  • 1. IPython Cluster Plugin
  • 2. MySQL Cluster Plugin
    • 2.1. Configuration Options
    • 2.2. What This Plugin Does
    • 2.3. Creating a Replicated Table
    • 2.4. Recommendations for Use
• Frequently Asked Questions
• Contributing to StarCluster
  • Overview
  • Sign-up for a github acount
  • Fork the StarCluster project
  • Setup a virtualenv for StarCluster development
  • Clone your fork
  • Code clean-up
  • Submit your changes upstream
• Hacking
• Features
• Project TODOs