In the previous post, we have described basic introduction of Ansible and its advantages . In this post lets build a skeleton of the project hierarchy we follow . I will explain what each of these structure does and how it would benefit us.
Now before we dive into the structure, Ansible uses YAML syntax inside its file called playbook(playbook means simply a file with set of tasks bundled together) . If you are not comfortable with YAML syntax or if you want to skim it through please refer Ansible documentation. They have the best explanation out there. http://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html
now lets create our first basic ansible playbook.
Create a file named test.yml inside project folder,And paste this content.
– hosts: remoteMachines
– shell: echo “Hi!”
Save the file . Before running this append this line to the host under remoteMachines in the hosts file we created in the previous tutorial.
like this ,
This line specifies this user is used to SSH into the remote Host.(by default it takes the current user of the ansible server machine)
and to run the playbook we just created , use the following command :
> ansible-playbook test.yml
this should return “Hi!” from both the remote machine output. And in the playbook we just created, hosts specifies the hosts we want to run the tasks on. It has a single task which uses the shell module to run echo “Hi!” command.
Now lets assume a scenario in which we have many common tasks to be run on multiple playbooks. To address such scenario , we will follow a specific structure and in order to reuse tasks spread across multiple playbooks, we will use a feature called “roles”.
Inside the project folder create a folder called as “roles”. Inside roles directory we will create another folder this folder is the name of role we want to use.(ex: webserver).
Inside webserver folder we will create these folders and files respectively. hierarchy as follows,
Roles > Webserver > defaults > main.yml
Roles > Webserver > tasks > main.yml
Roles > Webserver > handlers > main.yml
Roles > Webserver > templates
Inside defaults folder ,we will find variables and default values in format of “name:value” pair inside main.yml file, these are extensively used in playbooks , templates and are placed to increase re usability.
Inside tasks folder , we will find set of tasks associated to the role inside main.yml file .
Inside handlers folder, we will find different handlers associated with the tasks. Handlers are similar to tasks . only difference is handlers are invoked only by another task.
Inside templates folder, we will find templates , which contains changing values inside configuration files and these can be replaced by values inside defaults folder. They are processed by Jinja 2 template language.
Now in order to run this role, create a file named play.yml file inside project root folder. and place the following content and save
– hosts: remoteMachines
As we can see there is a granularity of different type of functionalities and reusability of tasks can be achieved by the concept of roles.
In the next tutorial , we will look at how to use this hierarchy to write a functional role and execute this playbook. Thank you!