CfnCluster Commands

Most commands provided are just wrappers around CloudFormation functions.

Note

When a command is called and it starts polling for status of that call it is safe to Ctrl-C out. you can always return to that status by calling cfncluster status mycluster

create

Creates a CloudFormation stack with the name cfncluster-[stack_name]. To read more about CloudFormation see AWS CloudFormation.

positional arguments:
cluster_name create a cfncluster with the provided name.
optional arguments:
-h, --help show this help message and exit
--norollback, -nr
 disable stack rollback on error
--template-url TEMPLATE_URL, -u TEMPLATE_URL
 specify a URL for a custom cloudformation template
--cluster-template CLUSTER_TEMPLATE, -t CLUSTER_TEMPLATE
 specify a specific cluster template to use
--extra-parameters EXTRA_PARAMETERS, -p EXTRA_PARAMETERS
 add extra parameters to stack create
--tags TAGS, -g TAGS
 tags to be added to the stack
$ cfncluster create mycluster

update

Updates the CloudFormation stack using the values in the config file or a TEMPLATE_URL provided. For more information see AWS CloudFormation Stacks Updates.

positional arguments:
cluster_name update a cfncluster with the provided name.
optional arguments:
-h, --help show this help message and exit
--norollback, -nr
 disable stack rollback on error
--template-url TEMPLATE_URL, -u TEMPLATE_URL
 specify a URL for a custom cloudformation template
--cluster-template CLUSTER_TEMPLATE, -t CLUSTER_TEMPLATE
 specify a specific cluster template to use
--extra-parameters EXTRA_PARAMETERS, -p EXTRA_PARAMETERS
 add extra parameters to stack update
--reset-desired, -rd
 reset the current ASG desired capacity to initial config values
$ cfncluster update mycluster

stop

This first sets the Auto Scaling Group parameters to min/max/desired = 0/0/0 then stops the Master Server. This polls on the status of the master server until it is stopped.

Note

A stopped cluster won't charge for EC2 usage but will still charge for EBS usage and Elastic IP addresses. Each time you bring up an instance it charges you for an hour so bringing it up and down multiple times within an hour isn't reccomended. For more info see Stop and Start Your Instance.

positional arguments:
cluster_name stop a cfncluster with the provided name.
optional arguments:
-h, --help show this help message and exit
$ cfncluster stop mycluster

start

Starts a cluster. This starts the Master Server and sets Auto Scaling Group parameters to min/max/desired = 0/max_queue_size/0 where max_queue_size defaults to 10. If you specify the --reset-desired flag, the min/desired values will be set to the initial_queue_size. Since the EC2 instances in the compute fleet try and mount the nfs drive from the master server this causes a race condition such that if the master server starts after the compute nodes, the compute nodes will terminate since they can't mount the nfs drive.

positional arguments:
cluster_name start a cfncluster with the provided name.
optional arguments:
-h, --help show this help message and exit
--reset-desired, -rd
 Set the ASG desired capacity to initial config values. Note this could cause a race condition. If the MasterServer boots after the ASG scales it will cause an error.
$ cfncluster start mycluster

delete

Delete a cluster. This causes a CloudFormation delete call which deletes all the resources associated with that stack.

positional arguments:
cluster_name delete a cfncluster with the provided name.
optional arguments:
-h, --help show this help message and exit
$ cfncluster delete mycluster

status

Pull the current status of the cluster. Polls if the status is not CREATE_COMPLETE or UPDATE_COMPLETE. For more info on possible statuses see the Stack Status Codes page.

positional arguments:
cluster_name show the status of cfncluster with the provided name.
optional arguments:
-h, --help show this help message and exit
$cfncluster status mycluster

list

Lists clusters currently running or stopped. Lists the stack_name of the CloudFormation stacks with the name cfncluster-[stack_name].

optional arguments:
-h, --help show this help message and exit
$ cfncluster list

instances

Shows EC2 instances currently running on the given cluster.

positional arguments:
cluster_name show the status of cfncluster with the provided name.
optional arguments:
-h, --help show this help message and exit
$ cfncluster instances mycluster

configure

Configures the cluster. See Configuring CfnCluster.

optional arguments:
-h, --help show this help message and exit
$ cfncluster configure mycluster

version

Displays CfnCluster version.

optional arguments:
-h, --help show this help message and exit
$ cfncluster version