Template Reference

Advanced template parameters

These advanced template parameters are specified in the individual JSON files. During DC/OS installation these template files are used to generate a customized DC/OS build.

Zen templates

The Zen templates orchestrate the individual component templates to create a DC/OS cluster.

Agent templates

The agent templates create public or private agent nodes that are then attached to a DC/OS cluster as a part of an AutoScalingGroup.

Master templates

The master templates create master nodes, on top of the infrastructure stack already created.

Infrastructure template

The infrastructure template defines and creates a DC/OS specific infrastructure that works well with an existing VPC.

Zen

The Zen templates (e.g. ee.elzen-1.json) orchestrate the individual component templates.

Parameter NameKey Value
AdminLocationOptional: Specify the IP range to whitelist for access to the admin zone. Must be a valid CIDR. To allow access from any IP address, use 0.0.0.0/0.
CustomAMIOptional: Specify an AMI ID. Must reside in the same region and have all DC/OS prerequisites installed.
InternetGatewayInternet Gateway ID, must be attached to the Vpc. Used by all nodes for outgoing Internet access.
KeyNameAWS EC2 Key Pair to SSH into instances
MasterInstanceTypeRegion-specific instance type. Example: m3.xlarge
PrivateAgentInstanceCountSpecify the number of private agent nodes or accept the default.
PrivateAgentInstanceTypeRegion-specific instance type. Example: m3.xlarge
PrivateSubnetSubnet ID for use by all private agent nodes
PublicAgentInstanceCountSpecify the number of public agent nodes or accept the default.
PublicAgentInstanceTypeRegion-specific instance type. Example: m3.xlarge
PublicSubnetSubnet ID for use by all public agent nodes
VpcExisting VPC to use. Nodes will be launched using subnets and Internet Gateway under this VPC

Private agents

The private agent template (advanced-priv-agent.json) creates agents which are then attached to a DC/OS cluster as a part of an AutoScalingGroup. To configure the template, specify the VPC, subnet, and master DNS address for the DC/OS cluster to join.

Parameter NameDescription
InternalMasterLoadBalancerDnsNameDNS Name of Internal Load Balancer. Has to be valid for agents to join a running cluster
KeyNameAWS EC2 Key Pair to SSH into instances
PrivateAgentInstanceCountSpecify the number of private agent nodes or accept the default.
PrivateAgentInstanceTypeRegion-specific instance type. Example: m3.xlarge
PrivateAgentSecurityGroupPermissive Security group used by private Agents
PrivateSubnetSubnet ID for use by all private agent nodes

Public agents

The public agent template (advanced-pub-agent.json) creates agents which are then attached to a DC/OS cluster as a part of an AutoScalingGroup. To configure the template, specify the VPC, subnet, and master DNS address for the DC/OS cluster to join.

Parameter NameDescription
InternalMasterLoadBalancerDnsNameDNS Name of Internal Load Balancer. Has to be valid for agents to join a running cluster
KeyNameAWS EC2 Key Pair to SSH into instances
PublicAgentInstanceCountSpecify the number of public agent nodes or accept the default.
PublicAgentInstanceTypeRegion-specific instance type. E.g. m3.xlarge
PublicAgentSecurityGroupPermissive Security group used by Public Agents
PublicSubnetSubnet ID for use by all public agent nodes

Master

The master templates (advanced-master-1.json, advanced-master-3.json, advanced-master-5.json, advanced-master-7.json) create masters, on top of the infrastructure stack already created.

Parameter NameDescription
AdminSecurityGroupAdmin URL Security Group. Controls Access to the Admin page
ExhibitorS3BucketS3 Bucket resource name. Used by Exhibitor for Zookeeper discovery and coordination. See Exhibitor documentation on ‘“shared configuration”‘: https://github.com/Netflix/exhibitor/wiki/Shared-Configuration for more information
KeyNameAWS EC2 Key Pair to SSH into instances
LbSecurityGroupLoadbalancer Security Group. Rules allow masters and private agent nodes to communicate.
MasterInstanceTypeRegion-specific instance type. Example: m3.xlarge
MasterSecurityGroupSecurity group used by master nodes
PrivateAgentSecurityGroupSecurity group used by Private Agents, typically with limited access to the outside
PrivateSubnetSubnet ID for use by all private agent nodes
PublicAgentSecurityGroupPermissive Security group used by Public Agents
PublicSubnetSubnet ID for use by all public agent nodes

Infrastructure

The infrastructure template (infra.json) defines, and creates, a DC/OS specific infrastructure that works well with a VPC already created. This is the lowest building block of a DC/OS cluster and the components created in this stack are consumed by the dependent templates (master and agents).

Parameter NameDescription
AdminLocationOptional: Specify the IP range to whitelist for access to the admin zone. Must be a valid CIDR.
InternetGatewayInternet Gateway ID, must be attached to the ‘Vpc’. Used by all nodes for outgoing Internet access.
KeyNameAWS EC2 Key Pair to SSH into instances
PrivateSubnetSubnet ID for use by all private agent nodes
PublicSubnetSubnet ID for use by all public agent nodes
VpcExisting VPC to use. Nodes will be launched using subnets and Internet Gateway under this VPC