Configuration¶

cfncluster uses the file ~/.cfncluster/config by default for all configuration parameters.

You can see an example configuration file site-packages/cfncluster/examples/config

Layout¶

Configuration is defined in multiple sections. Required sections are “global”, “aws”, one “cluster”, and one “subnet”.

A section starts with the section name in brackets, followed by parameters and configuration.

[global]
cluster_template = default
update_check = true
sanity_check = true

Configuration Options¶

global¶

Global configuration options related to cfncluster.

[global]

cluster_template¶

The name of the cluster section used for the cluster.

See the Cluster Definition.

cluster_template = default

update_check¶

Whether or not to check for updates to cfncluster.

update_check = true

sanity_check¶

Attempts to validate that resources defined in parameters actually exist.

sanity_check = true

aws¶

This is the AWS credentials section (required). These settings apply to all clusters.

If not defined, boto will attempt to use a) enviornment or b) EC2 IAM role.

[aws]
aws_access_key_id = #your_aws_access_key_id
aws_secret_access_key = #your_secret_access_key

# Defaults to us-east-1 if not defined in enviornment or below
aws_region_name = #region

cluster¶

You can define one or more clusters for different types of jobs or workloads.

Each cluster has it’s own configuration based on your needs.

The format is [cluster <clustername>].

[cluster default]

key_name¶

Name of an existing EC2 KeyPair to enable SSH access to the instances.

key_name = mykey

template_url¶

Overrides the path to the cloudformation template used to create the cluster

Defaults to https://s3.amazonaws.com/cfncluster-<aws_region_name>/templates/cfncluster-<version>.cfn.json.

template_url = https://s3.amazonaws.com/cfncluster-us-east-1/templates/cfncluster.cfn.json

compute_instance_type¶

The EC2 instance type used for the cluster compute nodes.

Defaults to t2.micro for default template.

compute_instance_type = t2.micro

master_instance_type¶

The EC2 instance type use for the master node.

This defaults to t2.micro for default template.

master_instance_type = t2.micro

initial_queue_size¶

The inital number of EC2 instances to launch as compute nodes in the cluster.

The default is 2 for default template.

initial_queue_size = 2

max_queue_size¶

The maximum number of EC2 instances that can be launched in the cluster.

This defaults to 10 for the default template.

max_queue_size = 10

maintain_initial_size¶

Boolean flag to set autoscaling group to maintain initial size.

If set to true, the Auto Scaling group will never have fewer members than the value of initial_queue_size. It will still allow the cluster to scale up to the value of max_queue_size.

Setting to false allows the Auto Scaling group to scale down to 0 members, so resources will not sit idle when they aren’t needed.

Defaults to false for the default template.

maintain_initial_size = false

scheduler¶

Scheduler to be used with the cluster. Valid options are sge, openlava, torque, or slurm.

Defaults to sge for the default template.

scheduler = sge

cluster_type¶

Type of cluster to launch i.e. ondemand or spot

Defaults to ondemand for the default template.

cluster_type = ondemand

spot_price¶

If cluster_type is set to spot, the maximum spot price for the ComputeFleet. See the Spot Bid Advisor for assistance finding a bid price that meets your needs:

spot_price = 0.00

custom_ami¶

ID of a Custom AMI, to use instead of default published AMI’s.

custom_ami = NONE

s3_read_resource¶

Specify S3 resource for which cfncluster nodes will be granted read-only access

For example, ‘arn:aws:s3:::my_corporate_bucket/*’ would provide read-only access to all objects in the my_corporate_bucket bucket.

See working with S3 for details on format.