{"id":2542,"date":"2023-03-24T18:28:38","date_gmt":"2023-03-24T18:28:38","guid":{"rendered":"https:\/\/blog.samarthya.me\/wps\/?p=2542"},"modified":"2023-03-24T18:28:40","modified_gmt":"2023-03-24T18:28:40","slug":"async-poll-notify-ansible-long-running-process","status":"publish","type":"post","link":"https:\/\/blog.samarthya.me\/wps\/2023\/03\/24\/async-poll-notify-ansible-long-running-process\/","title":{"rendered":"Async\/Poll & Notify: Ansible Long running process"},"content":{"rendered":"\n
<\/span>\"\"
\n

ASYNC & Poll<\/p>\n<\/div><\/div>\n\n\n\n

Recently during our discussion with a client a problem was raised how to show progress for a long running Ansible<\/code> playbook task & this blog is just an outcome of the things I tried and delivered.<\/p>\n\n\n\n

Ansible<\/code> is a powerful automation tool that allows you to automate tasks across multiple hosts. However, some tasks can take a long time to complete, which can leave users wondering if the task is still running or if it has completed successfully. To provide feedback during long running tasks, Ansible provides several modules, including async<\/code>, poll<\/code>, and notify<\/code>.<\/p>\n\n\n\n

async<\/code> and poll<\/code> Options in Ansible<\/code>:<\/h2>\n\n\n\n

The async<\/code> option allows you to run a task asynchronously, which means that it will run in the background and Ansible<\/code> will not wait for it to complete before moving on to the next task. This can be useful for long running tasks, as it allows Ansible to continue running other tasks while the long running task is in progress.<\/p>\n\n\n\n

The poll<\/code> option specifies how often Ansible should check the status of the asynchronous task. By default, Ansible will check the status every 10 seconds. You can adjust this value to suit your needs.<\/p>\n\n\n\n

Here’s an example playbook that uses the async<\/code> and poll<\/code> options to provide feedback during a long running task:<\/p>\n\n\n\n

- name: Long Running Task\n  command: \/path\/to\/long_running_task.sh\n  async: 300\n  poll: 60\n  register: task_result\n\n- name: Check Task Status\n  async_status:\n    jid: \"{{ task_result.ansible_job_id }}\"\n  register: task_status\n  until: task_status.finished\n\n- name: Task Output\n  debug:\n    var: task_status.stdout_lines<\/code><\/pre>\n\n\n\n
In this example, the command<\/code> module is used to run a long running task. The async<\/code> option is set to 300, which means that the task will run asynchronously for up to 300 seconds (5 minutes). The poll<\/code> option is set to 60, which means that Ansible will check the status of the task every 60 seconds.<\/p>\n\n\n\n
The register<\/code> keyword is used to capture the output of the command<\/code> module in a variable called task_result<\/code>.<\/p>\n\n\n\n
After the task has been started, the async_status<\/code> module is used to check the status of the task. The jid<\/code> option is set to the ansible_job_id<\/code> of the long running task. The until<\/code> keyword is used to keep checking the status of the task until it has finished.<\/p>\n\n\n\n
Finally, the stdout_lines<\/code> of the task output are printed using the debug<\/code> module.<\/p>\n\n\n\n
With this playbook, users will be able to see the progress of the long running task and know when it has completed successfully.<\/p>\n\n\n\n
notify<\/code> Module in Ansible<\/code>:<\/h2>\n\n\n\n
The notify<\/code> module in Ansible allows you to send a notification to a handler at the end of a task. This can be useful for providing real-time feedback during long running tasks.<\/p>\n\n\n\n
Here’s an example playbook that uses the notify<\/code> module to provide feedback during a long running task:<\/p>\n\n\n\n
- name: Long Running Task\n  command: \/path\/to\/long_running_task.sh\n  async: 300\n  poll: 60\n  register: task_result\n  notify: Update Status\n\n- name: Wait for Task to Complete\n  async_status:\n    jid: \"{{ task_result.ansible_job_id }}\"\n  register: task_status\n  until: task_status.finished\n\n- name: Task Output\n  debug:\n    var: task_status.stdout_lines\n\n- name: Update Status\n  debug:\n    msg: \"Task is still running\"\n  run_once: true\n  when: task_result | changed<\/code><\/pre>\n\n\n\n
In this example, the notify<\/code> module is used to call a task named Update Status<\/code> for every poll. The run_once<\/code> option is set to true, which means that the task will only be run once.<\/p>\n\n\n\n
Example<\/h2>\n\n\n\n
Let’s consider the following scenario: We have a web application running on a remote server. The application requires a database to function properly. We want to automate the process of creating a new database, configuring it, and starting the application. This process can take several minutes to complete. We want to provide feedback to the user about the status of the task during the process.<\/p>\n\n\n\n
To solve this problem, we can use the async<\/code>, poll<\/code>, and notify<\/code> modules in Ansible.<\/p>\n\n\n\n
First, we create a playbook that contains the following tasks:<\/p>\n\n\n\n
- name: Create database\n  command: create_database.sh\n  async: 3600\n  poll: 30\n  register: db_task\n  notify: Update Status\n\n- name: Configure database\n  command: configure_database.sh\n  async: 3600\n  poll: 30\n  register: config_task\n  notify: Update Status\n\n- name: Start application\n  command: start_application.sh\n  async: 3600\n  poll: 30\n  register: app_task\n  notify: Update Status\n\n- name: Check database status\n  command: check_database_status.sh<\/code><\/pre>\n\n\n\n
In this playbook, we have three tasks that create a database, configure it, and start the application. We have set the async<\/code> option to 3600 seconds (1 hour), which means that the task will run asynchronously for up to 1 hour. We have set the poll<\/code> option to 30 seconds, which means that Ansible will check the status of the task every 30 seconds.<\/p>\n\n\n\n
We have also registered the output of each task in a variable (i.e., db_task<\/code>, config_task<\/code>, and app_task<\/code>). This will allow us to check the status of each task later.<\/p>\n\n\n\n
Finally, we have a task that checks the status of the database.<\/p>\n\n\n\n
Next, we create a handler that will be called by the notify<\/code> module:<\/p>\n\n\n\n
- name: Update Status\n  debug:\n    msg: \"{{ ansible_job_id }}: {{ lookup('pipe', 'tail -1 \/proc\/' + ansible_job_id + '\/stat') }}\"\n  run_once: true\n  when: db_task | changed or config_task | changed or app_task | changed\n<\/code><\/pre>\n\n\n\n
This handler will print a message to the console every time one of the tasks changes status. The message will contain the Ansible job ID and the status of the task. We have set the run_once<\/code> option to true, which means that the handler will only be run once even if there are multiple hosts.<\/p>\n\n\n\n
Finally, we have used the when<\/code> keyword to run the Update Status<\/code> task only if one of the tasks has changed since the last poll. This means that the task will only be run if there is new progress to report.<\/p>\n\n\n\n
Explanation<\/h3>\n\n\n\n
When we run this playbook, Ansible will execute each task asynchronously. This means that Ansible will not wait for the task to complete before moving on to the next task.<\/p>\n\n\n\n
The poll<\/code> option specifies how often Ansible should check the status of the asynchronous task. In our example, Ansible will check the status every 30 seconds.<\/p>\n\n\n\n
The notify<\/code> module is used to call a handler named Update Status<\/code> for every poll. The when<\/code> keyword is used to run the Update Status<\/code> task only if one<\/p>\n\n\n\n
Help<\/h2>\n\n\n\n