simplemachines/ansible-template repository overview

⁠[DEPRECATED] Please move over to https://github.com/simple-machines/ansible-aws-infra-services⁠

⁠Getting Started

This template is supposed to live inside a deployable or infrastructure project and can self-update. To download and bootstrap a new template instance :

curl -L https://github.com/simple-machines/ansible-template/archive/master.tar.gz | tar zxv
mv ansible-template-master ansible
cd ansible
echo "12345" > .vaultpassword

⁠Running

Requires Docker to be installed (tested with Docker 1.12)

⁠Running playbooks after configuration

# Create a playbook (it will copy the roles/template folder to roles/<env>)
./create-role.sh dev
# Run the playbook
./run-playbook.sh dev

⁠Adding password file and edit the secret variables

echo "12345">.vaultpassword
./editvault.sh dev

⁠Configuration - Ansible Variables

infra vs env explanation

⁠Main Variables

⁠ECS

⁠Service / Task Definition

⁠Docker image

The AWS account ID where the docker images are stored (ECR). See docker_image_repo. Images are expected to be found at "{{ docker_image_repo }}/{{ application_name }}:{{ docker_image_tag }}".

⁠Autoscaling Group

To activate the creation of an ASG, place in infra/vars/main.yml the following:

• create_auto_scaling_group: true

⁠ELB

To activate the creation of an ELB, place in infra/vars/main.yml the following:

• create_elb: true

⁠EC2 Instances Shortcuts (alias and functions)

• dps: shortcut for docker ps
• dl : get the id of running docker container
• dlog : get the log of the running container
• dlogf : get the tailing log of the running container
• dlogt : get the log with timestamps of the running container
• dlog -ft : get the log of the running container with tailing and timestamps
• dex <command> : docker execute command (interactive mode) on the running container (ex: dex bash)
• dattach: print log as it streams (docker attach --no-stdin --sig-proxy=false)

⁠Directory Structure (aka what goes where)

• ansible/: root folder

  • run-playbook.sh: script to run deployment. ex ./run-playbook.sh dev.yml

  • editvault.sh: script to change secret variables ex ./editvault.sh dev modifies the file: ./dev/vars/secret.yml. This requires .vaultpassword to be present.

  • .vaultpassword: contains the password to decrypt the vault. Do not commit this file!

  • dev.yml, prod.yml, test.yml: orchestrate deployment. They should only contain information about the environment (profile) and roles to execute. Example:

    - hosts: localhost
      gather_facts: yes
      environment:
        AWS_PROFILE: "my-company-dev"
      roles:
        - dev
        - infra
    

    Copy

  • dev/, prod/, test/, etc: directory that contain environment specific variables

    • tasks/main.yml: File that should be edited to only include other variable files.
    • vars/: folder containing variables specific to the environment
      • secret.yml: encrypted variables (through editvault.sh)
      • main.yml: main variables
      • foo.yml: create as many as you want, but make sure to include them in your tasks/main.yml

  • infra/: directory that includes all the tasks. Could be seen as a "common" directory

    • vars/: define variables that are common. Can refer to your specific
    • tasks/: tasks that will be executed by ansible
      • main.yml: main file. references variables as defined in vars and then references other tasks in the same subfolder.
      • foo.yml: create as many as you want, but make sure to include them in your main.yml file.