Menu
AWS OpsWorks
User Guide (API Version 2013-02-18)

Adding Nodes Automatically in AWS OpsWorks for Puppet Enterprise

This topic describes how to add Amazon Elastic Compute Cloud (Amazon EC2) nodes to your AWS OpsWorks for Puppet Enterprise server automatically. In Add Nodes for the Puppet Master to Manage, you learned how to use the associate-node command to add one node at a time to your Puppet Enterprise server. The code in this topic shows how to add nodes automatically using the unattended method. The recommended method of unattended (or automatic) association of new nodes is to configure the Amazon EC2 user data. By default, an AWS OpsWorks for Puppet Enterprise server already has puppet-agent available for for Ubuntu, Amazon Linux, and RHEL node operating systems.

For information about how to disassociate a node, see Disassociate a Node from an AWS OpsWorks for Puppet Enterprise Server in this guide, and disassociate-node in the AWS OpsWorks for Puppet Enterprise API documentation.

Supported Operating Systems

For the current list of supported operating systems for nodes, see the Puppet agent platforms.

Step 1: Create an IAM Role to Use as Your Instance Profile

Create an AWS Identity and Access Management (IAM) role to use as your EC2 instance profile, and attach the following policy to the IAM role. This policy allows the opsworks-cm API to communicate with the EC2 instance during node registration. For more information about instance profiles, see Using Instance Profiles in the Amazon EC2 documentation. For information about how to create an IAM role, see Creating an IAM Role in the Console in the Amazon EC2 documentation.

{ "Version": "2012-10-17", "Statement": [ { "Action": [ "opsworks-cm:AssociateNode", "opsworks-cm:DescribeNodeAssociationStatus", "opsworks-cm:DescribeServers", "ec2:DescribeTags" ], "Resource": "*", "Effect": "Allow" } ] }

AWS OpsWorks provides an AWS CloudFormation template that you can use to create the IAM role with the preceding policy statement. The following AWS CLI command creates the instance profile role for you by using this template. You can omit the --region parameter if you want to create the new AWS CloudFormation stack in your default region.

aws cloudformation --region region ID create-stack --stack-name myPuppetinstanceprofile --template-url https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/owpe/opsworks-cm-nodes-roles.yaml --capabilities CAPABILITY_IAM

Step 2: Create Instances by Using an Unattended Association Script

To create EC2 instances, you can copy the following code to the userdata section of EC2 instance instructions, Auto Scaling group launch configurations, or an AWS CloudFormation template. You do not need to prefill your own values in this script. For more information about adding scripts to user data, see Running Commands on Your Linux Instance at Launch in the Amazon EC2 documentation. The easiest way to create a new node is to use the Amazon EC2 instance launch wizard. This walkthrough uses the Nginx web server example module setup described in Getting Started with AWS OpsWorks for Puppet Enterprise.

  1. This script runs the opsworks-cm API associate-node command to associate a new node with your Puppet master. In this release, it also installs the current version of the AWS CLI on the node for you, in case it is not already running the most up-to-date version. Save this script to a convenient location as userdata.sh.

    By default, the name of the new registered node is the instance ID.

    #!/bin/bash set -euo pipefail #set aws settings declare -x PP_INSTANCE_ID=$(curl --silent --show-error --retry 3 http://169.254.169.254/latest/meta-data/instance-id) # this uses the EC2 instance ID as the node name declare -x PP_IMAGE_NAME=$(curl --silent --show-error --retry 3 http://169.254.169.254/latest/meta-data/ami-id) declare -x PP_REGION=$(curl --silent --show-error --retry 3 http://169.254.169.254/latest/meta-data/placement/availability-zone | sed 's/.$//') # put the opsworks name of your server if you don't use the ocm_server tag declare -x OCM_SERVER="<serverName>" # put the region of your OCM Server if you don't use the ocm_region tag declare -x OCM_REGION="<region>" # we're detecting if a tag is set; if so, override anything in the file declare -x TAG_SERVER=$(aws ec2 describe-tags --region $PP_REGION --filters "Name=resource-id,Values=$PP_INSTANCE_ID" \ --query 'Tags[?Key==`ocm_server`].Value' --output text) declare -x TAG_REGION=$(aws ec2 describe-tags --region $PP_REGION --filters "Name=resource-id,Values=$PP_INSTANCE_ID" \ --query 'Tags[?Key==`ocm_region`].Value' --output text) if [ -n $TAG_SERVER ] && [ ! -z $TAG_SERVER ]; then declare -x OCM_SERVER=$TAG_SERVER fi if [ -n $TAG_REGION ] && [ ! -z $TAG_REGION ]; then declare -x OCM_REGION=$TAG_REGION fi #set global settings declare -x PUPPETSERVER=$(aws opsworks-cm describe-servers --region=$OCM_REGION \ --query "Servers[?ServerName=='$OCM_SERVER'].Endpoint" --output text) declare -x PRUBY='/opt/puppetlabs/puppet/bin/ruby' declare -x PUPPET='/opt/puppetlabs/bin/puppet' declare -x DAEMONSPLAY='true' declare -x SPLAYLIMIT='30' declare -x PUPPET_CA_PATH='/etc/puppetlabs/puppet/ssl/certs/ca.pem' function loadmodel { aws configure add-model --service-model https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/owpe/model-2017-09-05/opsworkscm-2016-11-01.normal.json --service-name opsworks-cm-puppet } function preparepuppet { mkdir -p /opt/puppetlabs/puppet/cache/state mkdir -p /etc/puppetlabs/puppet/ssl/certs/ mkdir -p /etc/puppetlabs/code/modules/ echo "{\"disabled_message\":\"Locked by OpsWorks Deploy - $(date --iso-8601=seconds)\"}" > /opt/puppetlabs/puppet/cache/state/agent_disabled.lock } function establishtrust { aws opsworks-cm describe-servers --region=$OCM_REGION --server-name $OCM_SERVER \ --query "Servers[0].EngineAttributes[?Name=='PUPPET_API_CA_CERT'].Value" --output text > /etc/puppetlabs/puppet/ssl/certs/ca.pem } function installpuppet { ADD_EXTENSIONS=$(generate_csr_attributes) curl --retry 3 --cacert /etc/puppetlabs/puppet/ssl/certs/ca.pem "https://$PUPPETSERVER:8140/packages/current/install.bash" | \ /bin/bash -s agent:certname=$PP_INSTANCE_ID \ agent:splay=$DAEMONSPLAY \ extension_requests:pp_instance_id=$PP_INSTANCE_ID \ extension_requests:pp_region=$PP_REGION \ extension_requests:pp_image_name=$PP_IMAGE_NAME $ADD_EXTENSIONS $PUPPET resource service puppet ensure=stopped } function generate_csr_attributes { pp_tags=$(aws ec2 describe-tags --region $PP_REGION --filters "Name=resource-id,Values=$PP_INSTANCE_ID" \ --query 'Tags[?starts_with(Key, `pp_`)].[Key,Value]' --output text | sed s/\\t/=/) csr_attrs="" for i in $pp_tags do csr_attrs="$csr_attrs extension_requests:$i" done echo $csr_attrs } function installpuppetbootstrap { $PUPPET help bootstrap > /dev/null && bootstrap_installed=true || bootstrap_installed=false if [ "$bootstrap_installed" = false ]; then echo "Puppet Bootstrap not present, installing" curl --retry 3 https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/owpe/puppet-agent-bootstrap-0.2.1.tar.gz \ -o /tmp/puppet-agent-bootstrap-0.2.1.tar.gz $PUPPET module install /tmp/puppet-agent-bootstrap-0.2.1.tar.gz --ignore-dependencies echo "Puppet Bootstrap installed" else echo "Puppet Bootstrap already present" fi } function runpuppet { sleep $[ ( $RANDOM % $SPLAYLIMIT ) + 1]s $PUPPET agent --enable $PUPPET agent --onetime --no-daemonize --no-usecacheonfailure --no-splay --verbose $PUPPET resource service puppet ensure=running enable=true } function associatenode { CERTNAME=$($PUPPET config print certname --section agent) SSLDIR=$($PUPPET config print ssldir --section agent) PP_CSR_PATH="$SSLDIR/certificate_requests/$CERTNAME.pem" PP_CERT_PATH="$SSLDIR/certs/$CERTNAME.pem" #clear out extraneous certs and generate a new one $PUPPET bootstrap purge $PUPPET bootstrap csr # submit the cert ASSOCIATE_TOKEN=$(aws opsworks-cm associate-node --region $OCM_REGION --server-name $OCM_SERVER --node-name $CERTNAME --engine-attributes Name=PUPPET_NODE_CSR,Value="`cat $PP_CSR_PATH`" --query "NodeAssociationStatusToken" --output text) #wait aws opsworks-cm wait node-associated --region $OCM_REGION --node-association-status-token "$ASSOCIATE_TOKEN" --server-name $OCM_SERVER #install and verify aws opsworks-cm-puppet describe-node-association-status --region $OCM_REGION --node-association-status-token "$ASSOCIATE_TOKEN" --server-name $OCM_SERVER --query 'EngineAttributes[0].Value' --output text > $PP_CERT_PATH $PUPPET bootstrap verify } # Order of execution of functions loadmodel preparepuppet establishtrust installpuppet installpuppetbootstrap associatenode runpuppet
  2. Follow the procedure in Launching an Instance in the EC2 documentation, with modifications here. In the EC2 instance launch wizard, choose an Amazon Linux AMI.

  3. On the Configure Instance Details page, select myPuppetinstanceprofile, the role you created in Step 1: Create an IAM Role to Use as Your Instance Profile, as your IAM role.

  4. In the Advanced Details area, upload the userdata.sh script that you created in Step 1.

  5. No changes are needed on the Add Storage page. Go on to Add Tags.

    By applying tags to your EC2 instance, you can customize the behavior of userdata.sh. For this example, apply the role nginx_webserver to your node by adding the following tag: pp_role, with the value nginx_webserver.

    Setting the pp_role value on the node sets data values that are permanently stored in the node's agent certificate, enabling trusted classification of the node. For more information, see Extension requests (permanent certificate data) in the Puppet platform documentation.

  6. On the Configure Security Group page, choose Add Rule, and then choose the type HTTP to open port 80 for the Nginx web server in this example.

  7. Choose Review and Launch, and then choose Launch. When your new node starts, it applies the Nginx configuration of the sample module you set up in Getting Started with AWS OpsWorks for Puppet Enterprise.

  8. When you open the webpage linked to the public DNS of your new node, you should see a website that is hosted by your Puppet-managed Nginx web server.