AWS ParallelCluster is an AWS supported Open Source cluster management tool to deploy and manage HPC clusters in the AWS cloud.
Clone or download
sean-smith Add ebs_kms_key_id to Configuration Docs
Signed-off-by: Sean Smith <seaam@amazon.com>
Latest commit 5f17080 Jan 11, 2019

README.rst

AWS ParallelCluster - HPC for the Cloud

Build Status Version

AWS ParallelCluster is an AWS supported Open Source cluster management tool that makes it easy for you to deploy and manage High Performance Computing (HPC) clusters in the AWS cloud. Built on the Open Source CfnCluster project, AWS ParallelCluster enables you to quickly build an HPC compute environment in AWS. It automatically sets up the required compute resources and a shared filesystem and offers a variety of batch schedulers such as AWS Batch, SGE, Torque, and Slurm. AWS ParallelCluster facilitates both quick start proof of concepts (POCs) and production deployments. You can build higher level workflows, such as a Genomics portal that automates the entire DNA sequencing workflow, on top of AWS ParallelCluster.

Quick Start

First, install the library:

$ pip install aws-parallelcluster

Next, configure your aws credentials and default region:

$ aws configure
AWS Access Key ID [None]: YOUR_KEY
AWS Secret Access Key [None]: YOUR_SECRET
Default region name [us-east-1]:
Default output format [None]:

Then, run pcluster configure:

$ pcluster configure
Cluster Template [default]:
AWS Access Key ID []:
AWS Secret Access Key ID []:
Acceptable Values for AWS Region ID:
    ap-south-1
    ...
    us-west-2
AWS Region ID [us-east-1]:
VPC Name [myvpc]:
Acceptable Values for Key Name:
  keypair1
  keypair-test
  production-key
Key Name []:
Acceptable Values for VPC ID:
  vpc-1kd24879
  vpc-blk4982d
VPC ID []:
Acceptable Values for Master Subnet ID:
  subnet-9k284a6f
  subnet-1k01g357
  subnet-b921nv04
Master Subnet ID []:

Now you can create your first cluster;

$ pcluster create myfirstcluster

After the cluster finishes creating, log in:

$ pcluster ssh myfirstcluster

You can view the running compute hosts:

$ qhost

For more information on any of these steps see the Getting Started Guide.

Documentation

Documentation is part of the project and is published to - https://aws-parallelcluster.readthedocs.io/. Of most interest to new users is the Getting Started Guide - https://aws-parallelcluster.readthedocs.io/en/latest/getting_started.html.

Issues

Please open a GitHub issue for any feedback or issues: https://github.com/aws/aws-parallelcluster. There is also an active AWS HPC forum which may be helpful:https://forums.aws.amazon.com/forum.jspa?forumID=192.

Changes

CfnCluster 1.6 IAM Change

Between CfnCluster 1.5.4 and 1.6.0 we made a change to the CfnClusterInstancePolicy that adds “s3:GetObject” permissions on objects in <REGION>-cfncluster bucket, "autoscaling:SetDesiredCapacity", "autoscaling:DescribeTags" permissions and "cloudformation:DescribeStacks" permissions on <REGION>:<ACCOUNT_ID>:stack/cfncluster-*.

If you’re using a custom policy (e.g. you specify "ec2_iam_role" in your config) be sure it includes this new permission. See https://aws-parallelcluster.readthedocs.io/en/latest/iam.html

CfnCluster 1.5 IAM Change

Between CfnCluster 1.4.2 and 1.5.0 we made a change to the CfnClusterInstancePolicy that adds “ec2:DescribeVolumes” permissions. If you’re using a custom policy (e.g. you specify "ec2_iam_role" in your config) be sure it includes this new permission. See https://aws-parallelcluster.readthedocs.io/en/latest/iam.html

CfnCluster 1.2 and Earlier

For various security (on our side) and maintenance reasons, CfnCluster 1.2 and earlier have been deprecated. AWS-side resources necessary to create a cluster with CfnCluster 1.2 or earlier are no longer available. Existing clusters will continue to operate, but new clusters can not be created.