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
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to
--nowait, -nw	do not wait for stack events, after executing stack command
--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, TAGS is a JSON formatted string encapsulated by single quotes

$ cfncluster create mycluster

create cluster with tags:

$ cfncluster create mycluster --tags '{ "Key1" : "Value1" , "Key2" : "Value2" }'

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
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to
--nowait, -nw	do not wait for stack events, after executing stack command
--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

Sets the Auto Scaling Group parameters to min/max/desired = 0/0/0

Note

A stopped cluster will only terminate the compute-fleet.

Previous versions of CfnCluster stopped the master node after terminating the compute fleet. Due to a number of challenges with the implementation of that feature, the current version only terminates the compute fleet. The master will remain running. To terminate all EC2 resources and avoid EC2 charges, consider deleting the cluster.

positional arguments:

cluster_name stops the compute-fleet of the provided cluster name.

optional arguments:

-h, --help	show this help message and exit
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to

$ cfncluster stop mycluster

start

Starts a cluster. This sets the Auto Scaling Group parameters to either the initial configuration values (max_queue_size and initial_queue_size) from the template that was used to create the cluster or to the configuration values that were used to update the cluster since creation.

positional arguments:

cluster_name starts the compute-fleet of the provided cluster name.

optional arguments:

-h, --help	show this help message and exit
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to

$ 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
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to
--nowait, -nw	do not wait for stack events, after executing stack command

$ cfncluster delete mycluster

ssh

Runs ssh to the master node, with username and ip filled in based on the provided cluster.

For example:

cfncluster ssh mycluster -i ~/.ssh/id_rsa

Results in an ssh command with username and ip address pre-filled.

ssh ec2-user@1.1.1.1 -i ~/.ssh/id_rsa

SSH command is defined in the global config file, under the aliases section and can be customized:

[aliases] ssh = ssh {CFN_USER}@{MASTER_IP} {ARGS}

Variables substituted:

{CFN_USER} {MASTER_IP} {ARGS} (only if specified on the cli)

positional arguments:

cluster_name name of the cluster to set variables for.

optional arguments:

-h, --help	show this help message and exit
--dryrun, -d	print command and exit.

$cfncluster ssh mycluster -i ~/.ssh/id_rsa -v

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
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to
--nowait, -nw	do not wait for stack events, after executing stack command

$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
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to

$ 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
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file
--region REGION, -r REGION
	specify a specific region to connect to

$ cfncluster instances mycluster

configure

Configures the cluster. See Configuring CfnCluster.

optional arguments:

-h, --help	show this help message and exit
--config CONFIG_FILE, -c CONFIG_FILE
	specify a alternative config file

$ cfncluster configure mycluster

version

Displays CfnCluster version.

optional arguments:

-h, --help	show this help message and exit
--region REGION, -r REGION
	specify a specific region to connect

$ cfncluster version