{"id":1237,"date":"2024-04-17T08:21:18","date_gmt":"2024-04-17T08:21:18","guid":{"rendered":"http:\/\/shijuvarghese.com\/?p=1237"},"modified":"2024-04-17T08:30:31","modified_gmt":"2024-04-17T08:30:31","slug":"ansible-including-tasks-files-and-importing-playbooks","status":"publish","type":"post","link":"http:\/\/shijuvarghese.com\/?p=1237","title":{"rendered":"Ansible: Including tasks files and importing playbooks"},"content":{"rendered":"

The include_tasks module imports a list of tasks to the current playbook for execution. It is one way for organizing tasks in separate files and it also helps in reusing the tasks in other playbooks.<\/p>\n

The import_playbook imports the whole playbook that includes tasks, variables, etc from another file to the calling playbook.<\/p>\n

The below is an example where tasks and playbooks are included\/imported from separate files.<\/p>\n

[root@centos9vm ~]#<\/strong> cat environment.yml<\/p>\n

==== ====
\n– – –<\/em>
\n – name: Install the {{ package }} package<\/em>
\n     ansible.builtin.dnf:<\/em>
\n         name: “{{ package }}”<\/em>
\n         state: latest<\/em><\/p>\n

– name: Start the {{ service }} service<\/em>
\n     ansible.builtin.service:<\/em>
\n         name: “{{ service }}”<\/em>
\n         state: started<\/em>
\n         enabled: true<\/em><\/p>\n

==== ====<\/p>\n

[root@centos9vm ~]#<\/strong> cat test.yml<\/p>\n

==== ===
\n– – –<\/em>
\n– name: Test web service<\/em>
\n     hosts: testGRP<\/em>
\n     become: false<\/em>
\n     tasks:<\/em>
\n         – name: connect to internet web server<\/em>
\n             ansible.builtin.uri:<\/em>
\n                 url: “{{ url }}”<\/em>
\n                 status_code: 200<\/em><\/p>\n

==== ===<\/p>\n

[root@centos9vm ~]# cat firewall.yml<\/p>\n

===== ===
\n– – –<\/em>
\n – name: Install the firewall<\/em>
\n     ansible.builtin.dnf:<\/em>
\n         name: “{{ firewall_pkg }}”<\/em>
\n         state: latest<\/em><\/p>\n

– name: Start the firewall<\/em>
\n     ansible.builtin.service:<\/em>
\n         name: “{{ firewall_svc }}”<\/em>
\n         state: started<\/em>
\n         enabled: true<\/em><\/p>\n

– name: Open port for {{ rule }}<\/em>
\n     ansible.posix.firewalld:<\/em>
\n         service: “{{ item }}”<\/em>
\n         state: enabled<\/em>
\n         permanent: true<\/em>
\n         immediate: true<\/em>
\n     loop: “{{ rule }}”<\/em><\/p>\n

======<\/p>\n

Now let us put his into a main playbook, to manage the node 192.168.0.129.<\/p>\n

[root@centos9vm ~]#<\/strong> cat playbook.yml<\/p>\n

===== ===
\n– – –<\/em>
\n – name: Configure web server<\/em>
\n     hosts: 192.168.0.129<\/em>
\n     tasks:<\/em>
\n         – name: Include the environment task file and set the variable<\/em>
\n             include_tasks: environment.yml<\/em>
\n             vars:<\/em>
\n                 package: httpd<\/em>
\n                 service: httpd<\/em><\/p>\n

        – name: Include the firewall task file and set the variables<\/em>
\n             include_tasks: firewall.yml<\/em>
\n             vars:<\/em>
\n                 firewall_pkg: firewalld<\/em>
\n                 firewall_svc: firewalld<\/em>
\n                 rule:<\/em>
\n                     – http<\/em>
\n                     – https<\/em><\/p>\n

– name: Import test play and set the variable<\/em>
\n     import_playbook: test.yml<\/em>
\n     vars:<\/em>
\n         url: ‘http:\/\/192.168.0.129’<\/em><\/p>\n

===== ===<\/p>\n

[root@centos9vm ~]#<\/strong> ansible-navigator run -m stdout playbook.yml<\/p>\n

==== ===<\/p>\n

PLAY [Configure web server] ****************************************************<\/em><\/p>\n

TASK [Gathering Facts] *********************************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

TASK [Include the environment task file and set the variable] ******************<\/em>
\nincluded: \/root\/environment.yml for 192.168.0.129<\/em><\/p>\n

TASK [Install the httpd package] ***********************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

TASK [Start the httpd service] *************************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

TASK [Include the firewall task file and set the variables] ********************<\/em>
\nincluded: \/root\/firewall.yml for 192.168.0.129<\/em><\/p>\n

TASK [Install the firewall] ****************************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

TASK [Start the firewall] ******************************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

TASK [Open port for [‘http’, ‘https’]] *****************************************<\/em>
\nok: [192.168.0.129] => (item=http)<\/em>
\nok: [192.168.0.129] => (item=https)<\/em><\/p>\n

TASK [Include the placeholder task file and set the variable] ******************<\/em>
\nincluded: \/root\/placeholder.yml for 192.168.0.129<\/em><\/p>\n

TASK [Create placeholder file] *************************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

PLAY [Test web service] ********************************************************<\/em><\/p>\n

TASK [Gathering Facts] *********************************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

TASK [connect to internet web server] ******************************************<\/em>
\nok: [192.168.0.129]<\/em><\/p>\n

PLAY RECAP *********************************************************************<\/em>
\n192.168.0.129 : ok=12 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0<\/em><\/p>\n

=== ====<\/p>\n","protected":false},"excerpt":{"rendered":"

The include_tasks module imports a list of tasks to the current playbook for execution. It is one way for organizing tasks in separate files and […]<\/a><\/p>\n<\/div>","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[32,21,3],"tags":[],"class_list":["post-1237","post","type-post","status-publish","format-standard","hentry","category-ansible","category-devops","category-linux"],"_links":{"self":[{"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=\/wp\/v2\/posts\/1237","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1237"}],"version-history":[{"count":15,"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=\/wp\/v2\/posts\/1237\/revisions"}],"predecessor-version":[{"id":1252,"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=\/wp\/v2\/posts\/1237\/revisions\/1252"}],"wp:attachment":[{"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1237"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1237"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/shijuvarghese.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1237"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}