Add new ec2_instance_create role

roles/ec2_instance_create/README.md

@@ -0,0 +1,130 @@
+# ec2_instance_create
+
+A role to create an EC2 instance in AWS.
+
+Users can specify various parameters for instance configuration, including instance type, AMI ID, key pair, tags, and VPC/subnet configuration.
+
+This role also supports the creation of optional networking resources, such as a security group and an Elastic IP (EIP). You can choose to wait for the EC2 instance to finish booting before continuing.
+
+## Role Variables
+
+The following variables can be set in the role to customize EC2 instance creation and networking configurations:
+
+### EC2 Instance Configuration
+
+* **ec2_instance_create_aws_region**: (Required)
+  The AWS region in which to create the EC2 instance.
+
+* **ec2_instance_create_instance_name**: (Required)
+  The name of the EC2 instance to be created.
+
+* **ec2_instance_create_instance_type**: (Required)
+  The instance type for the EC2 instance (e.g., `t2.micro`, `m5.large`).
+
+* **ec2_instance_create_ami_id**: (Required)
+  The AMI ID for the EC2 instance.
+
+* **ec2_instance_create_key_name**: (Required)
+  The name of the key pair to use for SSH access to the EC2 instance.
+
+* **ec2_instance_create_vpc_subnet_id**: (Required)
+  The ID of the VPC subnet in which the instance will be launched.
+
+* **ec2_instance_create_tags**: (Optional)
+  A dictionary of tags to assign to the EC2 instance.
+
+* **ec2_instance_create_wait_for_boot**: (Optional)
+  Whether to wait for the EC2 instance to be in the "running" state before continuing. Default is `true`.
+
+### Optional Networking Resources
+
+#### Elastic IP
+
+* **ec2_instance_create_associate_eip**: (Optional)
+  Whether to create an Elastic IP (EIP) and associate it with the EC2 instance. Default is `false`.
+  If set to `true` and provided VPC doesn't have an Internet Gateway (IGW) attached, please set `ec2_instance_create_associate_igw` to true to avoid failure due to VPC not having IGW attached.
+
+* **ec2_instance_create_eip_tags**: (Optional)
+  Tags to assign to the elastic IP.
+
+#### Internet Gateway
+
+* **ec2_instance_create_associate_igw**: (Optional)
+  Whether to create and associate an internet gateway with the EC2 instance. Default is `false`.
+  If set to `true`, an internet gateway will be created or associated with the instance.
+
+* **ec2_instance_create_igw_tags**: (Optional)
+  Tags to assign to the internet gateway.
+
+#### External Security Group
+
+* **ec2_instance_create_associate_external_sg**: (Optional)
+  Whether to create and associate a security group with the EC2 instance for external access. Default is `false`.
+  If set to `true`, a security group will be created or associated with the instance.
+
+* **ec2_instance_create_external_sg_name**: (Optional)
+  The name of the security group to create. Default is `default-external-sg`.
+
+* **ec2_instance_create_external_sg_description**: (Optional)
+  A description for the security group. Default is `Security group for external access`.
+
+* **ec2_instance_create_external_sg_port**: (Optional)
+  The port to open in the security group. Default is `22`.
+
+* **ec2_instance_create_external_sg_rules**: (Optional)
+  A list of custom rules to add to the security group. Each rule is a dictionary with `proto`, `ports`, and `cidr_ip` keys. Default is to allow SSH (port 22) from `0.0.0.0/0`.
+
+* **ec2_instance_create_sg_tags**: (Optional)
+  Tags to assign to the security group.
+
+### Example:
+
+Here's an example of how to use the role in a playbook.
+
+```yaml
+---
+- name: Playbook for creating EC2 instance using cloud.aws_ops.ec2_instance_create role
+  hosts: localhost
+  gather_facts: false
+  roles:
+    - role: cloud.aws_ops.ec2_instance_create
+      vars:
+          ec2_instance_create_aws_region: us-west-2
+          ec2_instance_create_instance_name: my-test-instance
+          ec2_instance_create_instance_type: t2.micro
+          ec2_instance_create_ami_id: ami-066a7fbaa12345678
+          ec2_instance_create_vpc_subnet_id: subnet-071443aa123456789
+          ec2_instance_create_tags:
+            Component: my-test-instance
+            Environment: Testing
+          ec2_instance_create_wait_for_boot: true
+          # Optionally, enable security group creation
+          ec2_instance_create_associate_external_sg: true
+          ec2_instance_create_external_sg_name: my-custom-sg
+          ec2_instance_create_external_sg_description: Security group for my custom access
+          ec2_instance_create_external_sg_port: 22
+          ec2_instance_create_external_sg_rules:
+            - proto: tcp
+              ports:
+                - 80
+              cidr_ip: "0.0.0.0/0"
+          ec2_instance_create_sg_tags:
+            Component: my-custom-sg
+            Environment: Testing
+          # Optionally, enable Elastic IP association
+          ec2_instance_create_associate_eip: true
+          ec2_instance_create_eip_tags:
+            Component: my-custom-eip
+            Environment: Testing
+
+License
+-------
+
+GNU General Public License v3.0 or later
+
+See [LICENSE](../../LICENSE) to see the full text.
+
+Author Information
+------------------
+
+- Ansible Cloud Content Team

roles/ec2_instance_create/defaults/main.yml

@@ -0,0 +1,12 @@
+---
+ec2_instance_create_associate_eip: false
+ec2_instance_create_associate_external_sg: false
+ec2_instance_create_associate_igw: false
+ec2_instance_create_external_sg_description: "Security group for external access"
+ec2_instance_create_external_sg_name: "default-external-sg"
+ec2_instance_create_external_sg_port: 22
+ec2_instance_create_wait_for_boot: true
+ec2_instance_create_external_sg_rules:
+  - proto: tcp
+    ports: 22
+    cidr_ip: "0.0.0.0/0"

roles/ec2_instance_create/meta/argument_specs.yml

@@ -0,0 +1,91 @@
+---
+argument_specs:
+  main:
+    short_description: A role to create an EC2 instance with optional networking resources.
+    description:
+      - A role to create an EC2 instance.
+      - Optionally can create a security group and associate an Elastic IP with the instance.
+      - Supports custom configurations for instance settings, including instance type, AMI, key pair, tags, VPC/subnet, and networking configurations.
+    options:
+      ec2_instance_create_aws_region:
+        description:
+          - The AWS region in which to create the EC2 instance.
+        required: true
+        type: str
+      ec2_instance_create_instance_name:
+        description:
+          - The name of the EC2 instance to be created.
+        required: true
+        type: str
+      ec2_instance_create_instance_type:
+        description:
+          - The instance type for the EC2 instance.
+        required: true
+        type: str
+      ec2_instance_create_ami_id:
+        description:
+          - The AMI ID for the EC2 instance.
+        required: true
+        type: str
+      ec2_instance_create_key_name:
+        description:
+          - The name of the key pair to use for SSH access to the EC2 instance.
+        required: true
+        type: str
+      ec2_instance_create_vpc_subnet_id:
+        description:
+          - The ID of the VPC subnet in which the instance will be launched.
+        required: true
+        type: str
+      ec2_instance_create_tags:
+        description:
+          - A dictionary of tags to assign to the EC2 instance.
+        required: false
+        type: dict
+      ec2_instance_create_wait_for_boot:
+        description:
+          - Whether to wait for the EC2 instance to be in the running state before continuing.
+        required: false
+        default: true
+        type: bool
+      ec2_instance_create_associate_eip:
+        description:
+          - Whether to create and associate an Elastic IP (EIP) with the EC2 instance.
+        required: false
+        default: false
+        type: bool
+      ec2_instance_create_associate_external_sg:
+        description:
+          - Whether to create and associate a security group for external access.
+        required: false
+        default: false
+        type: bool
+      ec2_instance_create_external_sg_name:
+        description:
+          - The name of the security group to create.
+        required: false
+        default: "default-external-sg"
+        type: str
+      ec2_instance_create_external_sg_description:
+        description:
+          - A description of the security group.
+        required: false
+        default: "Security group for external access"
+        type: str
+      ec2_instance_create_external_sg_port:
+        description:
+          - The SSH port to open in the security group.
+        required: false
+        default: 22
+        type: int
+      ec2_instance_create_sg_tags:
+        description:
+          - Tags to assign to the security group.
+        required: false
+        type: dict
+      ec2_instance_create_associate_igw:
+        description:
+          - Whether to create and associate a internal gateway.
+        required: false
+        default: false
+        type: bool

roles/ec2_instance_create/meta/main.yml

@@ -0,0 +1,3 @@
+---
+dependencies:
+  - role: cloud.aws_ops.aws_setup_credentials

roles/ec2_instance_create/tasks/main.yml

@@ -0,0 +1,80 @@
+---
+- name: Run 'ec2_instance_create' role
+  module_defaults:
+    group/aws: "{{ aws_setup_credentials__output }}"
+  block:
+    - name: Create EC2 instance with provided configuration
+      amazon.aws.ec2_instance:
+        region: "{{ ec2_instance_create_aws_region }}"
+        name: "{{ ec2_instance_create_instance_name }}"
+        instance_type: "{{ ec2_instance_create_instance_type }}"
+        image_id: "{{ ec2_instance_create_ami_id }}"
+        key_name: "{{ ec2_instance_create_key_name }}"
+        vpc_subnet_id: "{{ ec2_instance_create_vpc_subnet_id }}"
+        tags: "{{ ec2_instance_create_tags | default(omit) }}"
+        wait: "{{ ec2_instance_create_wait_for_boot }}"
+      register: ec2_instance
+
+    - name: Create security group if enabled
+      when: ec2_instance_create_associate_external_sg is true
+      block:
+        - name: Define security group
+          amazon.aws.ec2_security_group:
+            name: "{{ ec2_instance_create_external_sg_name | default('default-external-sg') }}"
+            description: "{{ ec2_instance_create_external_sg_description | default('Security group for external access') }}"
+            vpc_id: "{{ ec2_instance_create_vpc_id }}"
+            rules: "{{ ec2_instance_create_external_sg_rules }}"
+            tags: "{{ ec2_instance_create_sg_tags | default(omit) }}"
+          register: ec2_group_creation
+
+        - name: Associate security group with EC2 instance
+          amazon.aws.ec2_instance:
+            instance_ids:
+              - "{{ ec2_instance.instance_ids[0] }}"
+            security_groups:
+              - "{{ ec2_instance_create_external_sg_name | default('default-external-sg') }}"
+            vpc_subnet_id: "{{ ec2_instance_create_vpc_subnet_id }}"
+          register: ec2_instance_associate_external_sg
+
+    - name: Create and Attach Internet Gateway if enabled
+      when: ec2_instance_create_associate_igw is true
+      block:
+        - name: Create an Internet Gateway
+          amazon.aws.ec2_vpc_igw:
+            region: "{{ ec2_instance_create_aws_region }}"
+            vpc_id: "{{ ec2_instance_create_vpc_id }}"
+            state: present
+            tags: "{{ ec2_instance_create_igw_tags | default(omit) }}"
+          register: internet_gateway
+
+        - name: Modify the route table to route internet traffic to Internet Gateway
+          amazon.aws.ec2_vpc_route_table:
+            region: "{{ ec2_instance_create_aws_region }}"
+            vpc_id: "{{ ec2_instance_create_vpc_id }}"
+            routes:
+              - dest: "0.0.0.0/0"
+                gateway_id: "{{ internet_gateway.gateway_id }}"
+            state: present
+
+    - name: Create and associate Elastic IP if enabled
+      when: ec2_instance_create_associate_eip is true
+      block:
+        - name: Allocate and associate Elastic IP
+          amazon.aws.ec2_eip:
+            device_id: "{{ ec2_instance.instance_ids[0] }}"
+            state: present
+            release_on_disassociation: true
+            tags: "{{ ec2_instance_create_eip_tags | default(omit) }}"
+          register: instance_eip
+
+    - name: Get EC2 instance info
+      amazon.aws.ec2_instance_info:
+        instance_ids: "{{ ec2_instance.instance_ids[0] }}"
+        region: "{{ ec2_instance_create_aws_region }}"
+      register: _ec2_instance
+
+    - name: Output details of the created EC2 instance
+      ansible.builtin.debug:
+        msg:
+          - "EC2 instance {{ ec2_instance.instance_ids[0] }} created successfully"
+          - "Instance details: {{ _ec2_instance.instances[0] }}"

tests/integration/targets/test_ec2_instance_create/aliases

@@ -0,0 +1,2 @@
+cloud/aws
+role/ec2_instance_create

tests/integration/targets/test_ec2_instance_create/defaults/main.yml

@@ -0,0 +1,16 @@
+---
+aws_security_token: "{{ security_token | default(omit) }}"
+
+# VPC and Subnet Configuration
+vpc_name: "{{ resource_prefix }}-vpc"
+test_vpc_name: 'vpc-{{ resource_prefix }}'
+test_vpc_cidr: '101.{{ 255 | random(seed=resource_prefix) }}.0.0/16'
+test_subnet_cidr: '101.{{ 255 | random(seed=resource_prefix) }}.0.0/24'
+
+# EC2 Instance Configuration
+ec2_instance_type: t2.micro
+ec2_key_name: "{{ resource_prefix }}-ec2-key"
+
+# External Security Group Configuration
+external_sg_name: "{{ resource_prefix }}-external-sg"
+external_sg_description: "External Security Group for EC2"

tests/integration/targets/test_ec2_instance_create/tasks/main.yml

@@ -0,0 +1,20 @@
+- name: Integration tests for ec2_networking_resources role
+  module_defaults:
+    group/aws:
+      aws_access_key: "{{ aws_access_key }}"
+      aws_secret_key: "{{ aws_secret_key }}"
+      security_token: "{{ security_token | default(omit) }}"
+      region: "{{ aws_region }}"
+  block:
+    - name: Create resources required for test
+      include_tasks: setup.yml
+
+    - name: Run tests for case 1 - EC2 with no external sg, igw, eip
+      include_tasks: tasks/test_ec2_only.yml
+
+    - name: Run tests for case 2 - EC2 with external sg, igw, eip
+      include_tasks: tasks/test_ec2_with_igw_sg_eip.yml
+
+  always:
+    - name: Delete resources required for test
+      ansible.builtin.include_tasks: teardown.yml