diff --git a/docs/_static/tasks.png b/docs/_static/tasks.png new file mode 100644 index 0000000000000000000000000000000000000000..b79a9195f3989f0b88fd89721d078bb5677bd2b2 Binary files /dev/null and b/docs/_static/tasks.png differ diff --git a/docs/_static/view_task.png b/docs/_static/view_task.png new file mode 100644 index 0000000000000000000000000000000000000000..d728c577ae0f4fd89a5ff9c2cde6afcf01f97474 Binary files /dev/null and b/docs/_static/view_task.png differ diff --git a/docs/_static/view_task_failed.png b/docs/_static/view_task_failed.png new file mode 100644 index 0000000000000000000000000000000000000000..12094e3b48bd7aa939e8d8ed319c1053362e8c1e Binary files /dev/null and b/docs/_static/view_task_failed.png differ diff --git a/docs/index.rst b/docs/index.rst index b3f04e90414a57e88630c236001b5764482e3106..70033b8fa85da012ae590fae9894e1ef7a1b33cb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,6 +34,7 @@ Please use the navigation sidebar on the left to begin. inventory network + task profile api changelog diff --git a/docs/network.rst b/docs/network.rst index 00a39ee4753846ebbe3e3efd603cddd7c14ca6c2..1aeec73e6da9f52b345abbff124131c8d2cc2561 100644 --- a/docs/network.rst +++ b/docs/network.rst @@ -53,6 +53,9 @@ DNS and DHCP update ------------------- Any creation or update of an host will automatically trigger an update of the core services on the Technical Network (DNS and DHCP). +See :ref:`task`. + +.. _vm_creation: VM creation ----------- diff --git a/docs/task.rst b/docs/task.rst new file mode 100644 index 0000000000000000000000000000000000000000..81eedc25df1c1f49ca8ab013dcb1bfb18ac83070 --- /dev/null +++ b/docs/task.rst @@ -0,0 +1,31 @@ +.. _task: + +Task +==== + +CSEntry can launch some background jobs. +Some are triggered automatically and others manually. + +Most tasks trigger an Ansible_ playbook on AWX_ via the API. +AWX_ is web-based user interface, REST API and task engine build on top of Ansible_. + +For example, when you create a new host, a job is automatically fired to update the DHCP and DNS services. +From the *View host* page, you can manually trigger a VM creation, see :ref:`vm_creation`. + +The *Task* page gives you a list of all the tasks that you triggered (admin users can see all the tasks). + +.. image:: _static/tasks.png + +Clicking on the **Id** of a task will take you to the *View task* page. +On that page you can see all the task's details. +It includes a link to the AWX_ job where you can find the full log of the job that was run. + +.. image:: _static/view_task.png + +If a task failed before the AWX_ job was run, the exception will be displayed: + +.. image:: _static/view_task_failed.png + + +.. _Ansible: https://docs.ansible.com/ansible/latest/index.html +.. _AWX: https://github.com/ansible/awx