Welcome to StarCluster’s documentation!

Contents:

• Installing StarCluster
  • Install Latest Stable Release from PyPI
  • Install development version from github
• StarCluster Configuration File
  • Creating the config 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
  • StarCluster Plugins
• Using Elastic Block Storage (EBS) Volumes with StarCluster
  • Using StarCluster to Create/Partition/Format a new EBS Volume (recommended)
  • Manually Creating/Partitioning/Formatting 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
  • Sun Grid Engine (SGE) QuickStart
  • Monitoring Jobs in the Queue
  • Viewing a Job’s Output
  • Monitoring Cluster Usage
  • Creating a Job Script
  • Deleting a Job from the Queue
• 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

Indices and tables

• Index
• Search Page