Run ansible-playbook with a user-data script on an EC2 instance

ONLINECAST

2 min read

·

07-10-2024

6

0

Share

Launching EC2 Instances with Ansible and User-Data Scripts

When provisioning AWS EC2 instances, it's often necessary to perform initial configuration and install software beyond the basic operating system. This is where user-data scripts come in. These scripts, typically written in Cloud-Init, run automatically during instance launch, allowing you to customize your instances right out of the box. Ansible, a powerful automation tool, seamlessly integrates with user-data scripts, enabling you to execute complex configuration tasks and streamline your EC2 deployment process.

Scenario: Imagine you need to launch an EC2 instance running a specific web server application. You want to ensure the server is properly configured, necessary packages are installed, and the application is running automatically after the instance boots up.

Original Code:

---
- hosts: web-servers
  become: true
  tasks:
    - name: Create user-data script
      template:
        src: user-data.j2
        dest: /tmp/user-data.yaml
    - name: Launch EC2 instance
      ec2:
        region: us-east-1
        image: ami-xxxxxxxx
        instance_type: t2.micro
        key_name: my-key-pair
        security_groups:
          - my-security-group
        user_data: "{{ lookup('file', '/tmp/user-data.yaml') }}"

Breakdown:

1. User-Data Script:
   • template module is used to create a user-data script from a template file (user-data.j2).
   • dest specifies the location where the script will be saved.
2. EC2 Instance Launch:
   • ec2 module is used to launch the EC2 instance.
   • user_data is set to the content of the user-data script created in the previous step.

User-data.j2 Template:

#cloud-config
package_update: true
packages:
  - httpd
  - nginx
runcmd:
  - systemctl enable httpd
  - systemctl start httpd
  - systemctl enable nginx
  - systemctl start nginx

This user-data template will update packages, install HTTP and Nginx web servers, and start them automatically after boot.

Benefits of using Ansible with User-Data:

• Centralized Control: Ansible allows you to manage your user-data scripts alongside your other infrastructure configuration, making it easier to maintain and update.
• Idempotency: Ansible's idempotent nature ensures that running the playbook multiple times will not introduce unintended changes.
• Flexibility: You can use Jinja2 templating within your user-data scripts to dynamically generate configurations based on variables.
• Scalability: Ansible can launch and configure multiple EC2 instances in parallel, significantly speeding up your deployment process.

Additional Insights:

• Cloud-Init: Cloud-Init is a widely used tool for configuring cloud instances. It provides a standardized framework for running scripts and executing commands during instance launch.
• User-Data Format: User-data scripts can be written in YAML, JSON, or plain text format. You can find more information about cloud-init formats and supported features here.
• Security Considerations: Ensure your user-data scripts only contain trusted and necessary commands. Avoid storing sensitive credentials within your user-data script.

Conclusion:

By integrating Ansible with user-data scripts, you can automate the configuration of your EC2 instances, streamlining your deployment process and ensuring consistency across your infrastructure. This approach enhances the efficiency and reliability of your cloud deployments.