Master Table of Contents

Contents:

• What is StarCluster?
  • Cluster Configuration
    • Security Groups
    • User-friendly Hostnames
    • User Accounts
    • Password-less SSH
    • NFS Shares
    • EBS Volumes
    • Scratch Space
    • Queueing System
  • Customize Cluster Using Plugins
  • StarCluster Machine Images (AMIs)
  • Create and Manage Clusters
  • Dynamically Resize Clusters
  • Easily Create and Format EBS Volumes
  • Easily Build S3 and EBS AMIs
  • Copy Data To and From a Cluster
  • Reduce Costs using Spot Instances
  • And more...
• 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
  • Installing on Windows
• Quick-Start
  • Learn more...
• StarCluster User Manual
  • Configuration File
    • Creating the configuration file
      • Storing the config in an alternate location
      • Loading the config from the web
    • Amazon Web Services Credentials
    • Amazon EC2 Regions
      • Switching Regions via Command Line
    • Amazon S3 Region-Specific Endpoints
    • Using a Proxy Host
    • Amazon EC2 Keypairs
    • Defining Cluster Templates
    • Defining Multiple Cluster Templates
    • Setting the Default Cluster Template
    • Amazon EBS Volumes
    • Amazon Security Group Permissions
    • Defining Plugins
    • Splitting the Config into Multiple Files
      • Loading Configs from the Web
    • Tips for Switching Regions
  • Using EBS Volumes for Persistent Storage
    • Create and Format a new EBS Volume
    • Managing EBS Volumes
      • Getting Volume Status
      • Removing Volumes
      • Resizing Volumes
      • Moving Volumes Across Availability Zones
  • Launching a Cluster on Amazon EC2
    • Managing Multiple Clusters
    • Logging into the master node
    • Logging into the worker nodes
    • Running X11 (Graphical) Applications on the Cluster
    • Rebooting a Cluster
    • Terminating a Cluster
    • Stopping an EBS-backed Cluster
  • Running Remote Commands from Command Line
    • Running X11 (Graphical) Applications
  • Copying Data to and from a Cluster
    • Copying Data to a Cluster (put)
    • Copying Data from a Cluster (get)
  • Using the Cluster
    • 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
  • Customizing the StarCluster AMI
    • Launching and Customizing an Image Host
      • Launching a New Image Host
      • Using an Existing Instance as an Image Host
    • Creating a New AMI from an Image Host
      • Creating an EBS-Backed AMI
      • Creating an S3-backed (instance-store) AMI
  • Listing the Official StarCluster AMIs
  • 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
    • Adding Nodes
      • Re-adding a Node
    • Removing Nodes
      • Remove Without Terminating
  • Elastic Load Balancer
    • Goals
    • Usage
      • Cluster Size Limits
      • Increasing Cluster Growth Rate
      • Load Balancer Statistics
      • Advanced Configuration
      • Experimental Features
    • How it Works
      • Criteria for Adding a Node
      • Criteria for Removing a Node
      • The 45 Minutes Past the Hour Rule
      • The Process of Adding a Node
      • The Process of Removing a Node
      • Learning More
  • StarCluster Shell Completion (Bash/Zsh)
    • Enabling Tab Completion in BASH
    • Enabling Tab Completion in ZSH
    • Using StarCluster Tab Completion
• 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
• Plugin Documentation
  • Sun Grid Engine Plugin
    • Using the Plugin
      • Advanced Options
        • Disabling Job Execution on Master Node
      • Disabling SGE
    • Sun Grid Engine Quick-Start
      • 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
  • Create Users Plugin
    • Configuration
      • Downloading User SSH Keys
    • Usage
      • Using the SSH Keys Archive
  • IPython Cluster Plugin
    • Using the IPython Cluster
    • Connecting from your Local IPython Installation
    • Using IPython Parallel Scripts with StarCluster
    • Using the IPython HTML Notebook
    • Using Parallel IPython in the IPython Notebook
  • TMUX Plugin
    • Usage
    • Basic TMUX Usage
  • Condor Plugin
    • Using the Condor Cluster
    • Submitting Jobs
    • Monitoring Job Status
    • Canceling Jobs
  • Hadoop Plugin
    • Usage
    • Hadoop Web Interfaces
    • Using Dumbo to Drive the Hadoop Framework
      • Managing HDFS
      • Using the Streaming API
  • MPICH2 Plugin
    • Usage
    • Building and Running MPI Programs
  • MySQL Cluster Plugin
    • Configuration Options
    • What This Plugin Does
    • Creating a Replicated Table
    • Recommendations for Use
  • Package Installer Plugin
    • Usage
  • Xvfb Plugin
    • Usage
• Frequently Asked Questions
  • Garbage Packet Received
• StarCluster Support
  • Submitting Bug Reports
  • Issues and Questions
• Contributing to StarCluster
  • Overview
  • Sign-up for a github account
  • Fork the StarCluster project
  • Setup a virtualenv for StarCluster development
  • Clone your fork
  • Code clean-up
  • Submit your changes upstream
• Hacking
• Features
• StarCluster TODOs
  • Support for Amazon VPC
  • Improved Eucalyptus Support
  • Add More Options to “addnode” command
  • Add Support for Load Balancing a Given SGE Queue
  • Use PyStun to Restrict Cluster Acccess to User’s IP-address
• Version History
  • 0.93.3
    • News
    • Bug Fixes
  • 0.93.2
    • News
    • Features
    • Bug Fixes
  • 0.93.1
    • News
    • Features
    • Bug Fixes
  • 0.93
    • News
    • Features
      • New Plugins
    • Bug Fixes
  • 0.92.1
    • Features
    • Bug Fixes
    • Improvements
  • 0.92
    • News
    • Features
• License: LGPL (version 3)