Parameter Options

Each script has the --help-ext. Please refer to this for the latest information.

• start_cluster.py
  • --cluster-name
  • --file-system-type
  • --no-rollback
  • --extra-parameters
  • --tags
• list_clusters.py
• stop_cluster.py
  • --cluster-name

start_cluster.py

The python script which will create your AWS Parallel Cluster.

Example command:

$ start_cluster.py \
    --cluster-name=my-first-cluster \
    --file-system-type=efs \
    --no-rollback

--cluster-name

Example my-first-cluster

Description: Name of the cluster you would like to launch.

This is the only mandatory parameter. You will need to refer this parameter's value in order to then stop the cluster.

--file-system-type

Default efs

Description: The type of file system to use for the cluster

There are two choices for this parameter. efs and fsx. Both are on-demand resources and are created at runtime and destroyed on the deletion of the cluster. fsx is a much faster file system but is also a lot more expensive.

You can read up on both on our Shared File Systems page or from the official amazon docs below.

• efs
• fsx

--no-rollback

Description: Adds the --norollback option to the pcluster create command.

Highly useful for determining if something went wrong in your cluster. Please note, this means you will also need to delete your cluster afterwards. It will not automatically shut-down in the event of a creation failure.
Use the stop_cluster.py to delete your cluster after you have discovered the creation issue.

--extra-parameters

Example: "{"ParameterKey1": "ParameterValue1", "ParameterKey2": "ParameterValue2"}"

Adds extra parameters to pass as input to the CloudFormation template.
Yet to find an actual use case for them.

--tags

Example: "{"UseCase": "gridss"}

Adds tags to each ec2-instance created in the stack along with the cloud-formation itself.

list_clusters.py

List all creating/running/failing clusters in your AWS account.

Example command:

$ list_clusters.py
             Name           Status Version            Head Node   Creator
 two-ten-one-test  CREATE_COMPLETE  2.10.1  i-0533788de8a26fea8  alexiswl

stop_cluster.py

Most important command of them all.

Example command:

$ stop_cluster.py --cluster-name two-ten-one-test

--cluster-name

Name of the cluster specified in start_cluster.py