Chapters

30 Chapters | 2:45:48 |

01

Hello Ansible!

5:53
02

Modules

6:34
03

Hosts & the Inventory File

4:45
04

Vagrant <3's Ansible

6:30
05

Create your Playbook!

3:18
06

Install Stuff: The apt Module

3:12
07

apt Package Upgrades & Requirements

6:13
08

PHP 7, Nginx & MySQL

6:09
09

Extensions, php.ini & lineinfile

7:23
10

git & Variables

5:21
11

Installing Composer & the script Module

6:45
12

Installing Composer Deps

4:31
13

Nginx Configuration & Ansible Templates

7:24
14

Handlers: For Handling Serious Biz

7:12
15

Cache Permissions

2:19
16

Symfony Console Commands

5:38
17

Tagging Tasks

4:46
18

Idempotency, changed_when & Facts

6:48
19

vars_prompt & Environment Variables

5:38
20

pre_tasks and set_fact

6:35
21

Faster Smarter Playbook

5:48
22

Skipping Tasks based on Changed

3:01
23

Organizing with include

2:10
24

Organizing into Roles

7:37
25

Using a 3rd Party to Install Redis

4:36
26

Variables and parameters.yml

3:06
27

The Variable Vault

7:22
28

Deploy to AWS!

6:06
29

Host Group Vars

3:30
30

Launch a Cloud Instance!

9:43

> Dev Tools > Ansible for Automation!

Buy Access to Course

23.

Organizing with include

Autoplay

Keep on Learning!

If you liked what you've learned so far, dive in! Subscribe to get
access to this tutorial plus video, code and script downloads.

Start your All-Access Pass

Buy just this tutorial for $10.00

Previous Chapter

Next Chapter

Our playbook is a mess: there's just a lot of tasks in one file. Let's get organized!

There are a few "categories" of things in the playbook. One category deals with "Bootstrapping Symfony", like installing the composer dependencies, fixing the var directory permissions and all of our Symfony console commands:

            Copy Code

                            Show All Lines

                        250 lines
            |
            ansible/playbook.yml
        
            ---
        
            - hosts: vb
        
                Show Lines

                                                    // ... lines 3 - 26
                            
              tasks:
        
                Show Lines

                                                    // ... lines 28 - 188
                            
                - name: Install Composer's dependencies
        
                  composer:
        
                    working_dir: "{{ symfony_root_dir }}"
        
                    no_dev: "{{ 'yes' if ('prod' == symfony_env) else 'no' }}"
        
                  tags:
        
                    - deploy
        
                  when: code_changed
        
                - name: Fix var directory permissions
        
                  file:
        
                    path: "{{ symfony_var_dir }}"
        
                    state: directory
        
                    mode: 0777
        
                    recurse: yes
        
                  changed_when: false
        
                  tags:
        
                    - permissions
        
                    - deploy
        
                # Symfony console commands
        
                - name: Create DB if not exists
        
                  command: '{{ symfony_console_path }} doctrine:database:create --if-not-exists'
        
                  register: db_create_result
        
                  changed_when: "not db_create_result.stdout|search('already exists. Skipped')"
        
                  tags:
        
                    - deploy
        
                - name: Execute migrations
        
                  command: '{{ symfony_console_path }} doctrine:migrations:migrate --no-interaction'
        
                  register: db_migrations_result
        
                  changed_when: "not db_migrations_result.stdout|search('No migrations to execute')"
        
                  tags:
        
                    - deploy
        
                  when: code_changed
        
                - name: Load data fixtures
        
                  command: '{{ symfony_console_path }} hautelook_alice:doctrine:fixtures:load --no-interaction'
        
                  when: symfony_env != "prod"
        
                  changed_when: false
        
                  tags:
        
                    - deploy
        
                - name: Clear cache
        
                  command: '{{ symfony_console_path }} cache:clear --env={{ symfony_env }}'
        
                  changed_when: false
        
                  tags:
        
                    - deploy
        
                  when: code_changed
        
                Show Lines

                                                    // ... lines 237 - 250

Using include()

I'd like to isolate these tasks into their own file. And... there are 2 good ways to do that. The first is.... just to include it. Create a new directory inside ansible called includes/, and inside there, a new file called symfony-bootstrap.yml. Start with the --- on top:

50 lines | ansible/includes/symfony-bootstrap.yml

	---
Show Lines	// ... lines 2 - 50

Now, let's move some tasks here! Grab "Install Composer Dependencies" and move it. We also want "Fix var directory permissions" all the way down to the end: "Clear Cache". Delete all of it and paste it into symfony-bootstrap.yml:

            Copy Code

                        50 lines
            |
            ansible/includes/symfony-bootstrap.yml
        
            ---
        
            - name: Install Composer's dependencies
        
              composer:
        
                working_dir: "{{ symfony_root_dir }}"
        
                no_dev: "{{ 'yes' if ('prod' == symfony_env) else 'no' }}"
        
              tags:
        
                - deploy
        
              when: code_changed
        
            - name: Fix var directory permissions
        
              file:
        
                path: "{{ symfony_var_dir }}"
        
                state: directory
        
                mode: 0777
        
                recurse: yes
        
              changed_when: false
        
              tags:
        
                - permissions
        
                - deploy
        
            # Symfony console commands
        
            - name: Create DB if not exists
        
              command: '{{ symfony_console_path }} doctrine:database:create --if-not-exists'
        
              register: db_create_result
        
              changed_when: "not db_create_result.stdout|search('already exists. Skipped')"
        
              tags:
        
                - deploy
        
            - name: Execute migrations
        
              command: '{{ symfony_console_path }} doctrine:migrations:migrate --no-interaction'
        
              register: db_migrations_result
        
              changed_when: "not db_migrations_result.stdout|search('No migrations to execute')"
        
              tags:
        
                - deploy
        
              when: code_changed
        
            - name: Load data fixtures
        
              command: '{{ symfony_console_path }} hautelook_alice:doctrine:fixtures:load --no-interaction'
        
              when: symfony_env != "prod"
        
              changed_when: false
        
              tags:
        
                - deploy
        
            - name: Clear cache
        
              command: '{{ symfony_console_path }} cache:clear --env={{ symfony_env }}'
        
              changed_when: false
        
              tags:
        
                - deploy
        
              when: code_changed

Now that these are in their own file, they should not be indented: so un-indent them twice.

In the playbook, to bring those in - it's really cool: where you would normally put a module, say include: ./includes/symfony-bootstrap.yml:

            Copy Code

                            Show All Lines

                        204 lines
            |
            ansible/playbook.yml
        
            ---
        
            - hosts: vb
        
                Show Lines

                                                    // ... lines 3 - 26
                            
              tasks:
        
                Show Lines

                                                    // ... lines 28 - 188
                            
                # Bootstrap Symfony app
        
                - include: ./includes/symfony-bootstrap.yml
        
              handlers:
        
                Show Lines

                                                    // ... lines 193 - 204

Tip

include module is deprecated since 2.4 and will be removed in version 2.8, use import_tasks module instead.

The tasks will run in a slightly different order than they did before, but it won't make any difference for us. But, to be sure try the playbook with -t deploy:

ansible-playbook ansible/playbook.yml -i ansible/hosts.ini -t deploy

All good! Including a file is the easiest way to organize and re-use tasks. But, there's a better, cooler, more robust, more hipster way. It's called roles.

10 Comments

Sort By

Andreas S. 5 years ago

For those coming here from the future ;)

Make sure to pass the variable code_changed to the include file, otherwise you will get code_changed undefined errors.

# Bootstrap Symfony app
- include: ./includes/symfony-bootstrap.yml code_changed=code_changed

| Reply |

Victor SFCASTS Andreas S. 5 years ago

Hey Norman

Thanks for sharing this with others! Btw, what Ansible version do you use so that you can't access code_changed variable inside of included task?

Cheers!

| Reply |

Andreas S. Victor 5 years ago

Hey Victor,
Ansible version: 2.7.5.

I copied the code from the course code final folder actually. I only adjusted my paths and removed the AWS stuff.

| Reply |

Victor SFCASTS Andreas S. 5 years ago edited

Hey Norman,

Hm, it's weird. I just double checked and it works well for me, so I don't need to pass that extra "code_changed=code_changed". Hm, probably you mistype something, or you don't have this "set_fact" task before:


    - name: Register code_changed variable
      set_fact:
        code_changed: repo_code.changed

I also have the latest Ansible 2.7.5, so, I don't think we should tweak anything in this tutorial's code.

Anyway, I'm glad you found the correct solution for you.

Cheers!

| Reply |

Andreas S. Victor 5 years ago

Thanks for checking!
Seems like I messed up somewhere. Will check and get back to you if I find it :)

| Reply |

Victor SFCASTS Andreas S. 5 years ago

Hey Norman,

No problem, I'm glad it works for you. But I would be happy about your feedback ;)

Cheers!

| Reply |

gstanto 6 years ago

Just a heads up: I'm getting "includes" deprecated notice, change to "import_tasks"

| Reply |

Victor SFCASTS gstanto 6 years ago edited

Hey gstanto ,

Thanks for letting us know! Yeah, "includes" is deprecated and will be removed in 2.8. Anyway, time to add a note about it.

Cheers!

| Reply |

toporovvv gstanto 6 years ago

include_tasks didn't play tasks with "-t deploy" tags (on ansible 2.5.1). In my case import_task did the job done.

| Reply |

Victor SFCASTS toporovvv 6 years ago edited

Hey toporovvv ,

Ah, good point! It's probably exactly that subtle difference between include_tasks and import_tasks. And probably we need to use import_tasks in this screencast because we do want to filter by tags here. Thanks for letting us know, I'll tweak the note in order to suggest import_tasks instead.

Cheers!

| Reply |

This tutorial is built using an older version of Symfony, but the core concepts of Ansible are still valid. New versions of Ansible may contain some features that we don't use here.

Symfony 3 Ansible 2.1

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=5.5.9",
        "symfony/symfony": "3.1.*", // v3.1.4
        "doctrine/orm": "^2.5", // v2.7.2
        "doctrine/doctrine-bundle": "^1.6", // 1.6.4
        "doctrine/doctrine-cache-bundle": "^1.2", // 1.3.0
        "symfony/swiftmailer-bundle": "^2.3", // v2.3.11
        "symfony/monolog-bundle": "^2.8", // 2.11.1
        "symfony/polyfill-apcu": "^1.0", // v1.2.0
        "sensio/distribution-bundle": "^5.0", // v5.0.12
        "sensio/framework-extra-bundle": "^3.0.2", // v3.0.16
        "incenteev/composer-parameter-handler": "^2.0", // v2.1.2
        "doctrine/doctrine-migrations-bundle": "^1.2", // v1.2.0
        "snc/redis-bundle": "^2.0", // 2.0.0
        "predis/predis": "^1.1", // v1.1.1
        "composer/package-versions-deprecated": "^1.11" // 1.11.99
    },
    "require-dev": {
        "sensio/generator-bundle": "^3.0", // v3.0.8
        "symfony/phpunit-bridge": "^3.0", // v3.1.4
        "doctrine/data-fixtures": "^1.1", // 1.3.3
        "hautelook/alice-bundle": "^1.3" // v1.4.1
    }
}

Previous Chapter

Next Chapter

Organizing with include

Share this awesome video!

Keep on Learning!

Using include()

10 Comments

Delete comment?

What PHP libraries does this tutorial use?

	---
	- hosts: vb
Show Lines	// ... lines 3 - 26
	tasks:
Show Lines	// ... lines 28 - 188
	- name: Install Composer's dependencies
	composer:
	working_dir: "{{ symfony_root_dir }}"
	no_dev: "{{ 'yes' if ('prod' == symfony_env) else 'no' }}"
	tags:
	- deploy
	when: code_changed

	- name: Fix var directory permissions
	file:
	path: "{{ symfony_var_dir }}"
	state: directory
	mode: 0777
	recurse: yes
	changed_when: false
	tags:
	- permissions
	- deploy

	# Symfony console commands
	- name: Create DB if not exists
	command: '{{ symfony_console_path }} doctrine:database:create --if-not-exists'
	register: db_create_result
	changed_when: "not db_create_result.stdout\|search('already exists. Skipped')"
	tags:
	- deploy

	- name: Execute migrations
	command: '{{ symfony_console_path }} doctrine:migrations:migrate --no-interaction'
	register: db_migrations_result
	changed_when: "not db_migrations_result.stdout\|search('No migrations to execute')"
	tags:
	- deploy
	when: code_changed

	- name: Load data fixtures
	command: '{{ symfony_console_path }} hautelook_alice:doctrine:fixtures:load --no-interaction'
	when: symfony_env != "prod"
	changed_when: false
	tags:
	- deploy

	- name: Clear cache
	command: '{{ symfony_console_path }} cache:clear --env={{ symfony_env }}'
	changed_when: false
	tags:
	- deploy
	when: code_changed
Show Lines	// ... lines 237 - 250