diff --git a/ara/static/css/ara.css b/ara/static/css/ara.css index 7a4bd357..1513296e 100644 --- a/ara/static/css/ara.css +++ b/ara/static/css/ara.css @@ -121,32 +121,36 @@ } .link-report { - float: left; - padding-top: 3px; - font-size: 12px; - font-weight: bold; - line-height: 1; + float: left; + padding-top: 3px; + font-size: 12px; + font-weight: bold; + line-height: 1; } .link-modal { - float: right; - margin-right: 12px; - padding-top: 3px; - font-size: 18px; - font-weight: bold; - line-height: 1; + float: right; + margin-right: 12px; + padding-top: 3px; + font-size: 18px; + font-weight: bold; + line-height: 1; } .link:hover, .link:focus { - color: #000; - text-decoration: none; - cursor: pointer; - opacity: 0.5; - filter: alpha(opacity=50); + color: #000; + text-decoration: none; + cursor: pointer; + opacity: 0.5; + filter: alpha(opacity=50); } button.link { - cursor: pointer; - background: transparent; - border: 0; - -webkit-appearance: none; + cursor: pointer; + background: transparent; + border: 0; + -webkit-appearance: none; +} + +.help-icon { + font-size: 18px; } \ No newline at end of file diff --git a/ara/templates/report.html b/ara/templates/report.html index 20cd2c9e..d508d4af 100644 --- a/ara/templates/report.html +++ b/ara/templates/report.html @@ -82,26 +82,15 @@
-
+

Playbook parameters +

-
-
-

Browsing tips

-
-
-
    -
  • All table columns are sortable
    • -
-
-
-
-
- + @@ -117,45 +106,21 @@
-
+

Hosts +

-
-
-

Browsing tips

-
-
-
    -
  • All table columns are sortable
    • -
  • If facts have been gathered: -
      -
    • Hover hosts to see a quick highlight summary of the recorded host facts
      • -
    • Click on a host to browse the full list of recorded host facts
      • -
    -
    • -
  • Use the search box to find specific hosts based on their properties, for example: -
      -
    • localhost would match only 'localhost' (provided by default: the Ansible inventory hostname)
      • -
    • fedora would match all 'fedora' hosts (provided by the ansible_distribution fact)
      • -
    • 192.168.1 would match all hosts with an IP in the '192.168.1' range (provided by the ansible_all_ipv4_addresses fact)
      • -
    -
    • -
-
-
-
-
{% if stats_count -%}
ParameterParameter Value
- - - - - + + + + +
HostOKCHANGEDFAILEDSKIPPEDUNREACHABLEOKCHANGEDFAILEDSKIPPEDUNREACHABLE
@@ -176,24 +141,11 @@
-
+

Plays +

-
-
-

Browsing tips

-
-
-
    -
  • All table columns are sortable
    • -
  • Use the search box to find a specific play based on it's name
    • -
  • To see your playbook file, click the playbook file path in the playbook report list
    • -
-
-
-
-
{% if play_count -%} @@ -201,7 +153,7 @@ - +
Play Start EndDurationDuration
@@ -222,24 +174,13 @@
-
+

Files +

-
-
-

Browsing tips

-
-
-
    -
  • Click on any file to see it's contents
    • -
-
-
-
-
{% if file_count -%} -
+
{% else -%}

There is no recorded file for this playbook.

@@ -257,31 +198,11 @@
-
+

Tasks +

-
-
-

Browsing tips

-
-
-
    -
  • All table columns are sortable
    • -
  • Click on a task status (ex: 'failed') to see the detailed task result
    • -
  • Use the search box to find specific tasks based on their properties, for example: -
      -
    • do something would only match tasks with 'do something' in their name
      • -
    • localhost would only match tasks on the host 'localhost'
      • -
    • include would match tasks with 'include' in their task name or as the task action -
    • failed would only match tasks with the 'failed' status
      • -
    -
    • -
-
-
-
-
{% if task_count -%} @@ -312,23 +233,11 @@
-
+

Records +

-
-
-

Browsing tips

-
-
-
    -
  • Data recorded with the ara_record Ansible module will be displayed here
    • -
  • Use the search box to find a specific key based on it's name or expected contents.
    • -
-
-
-
-
{% if record_count -%}
diff --git a/ara/templates/report_list.html b/ara/templates/report_list.html index a0a724ae..ed725be7 100644 --- a/ara/templates/report_list.html +++ b/ara/templates/report_list.html @@ -4,12 +4,6 @@
-
-
- - Browse your playbook reports here: Get started by expanding the "Hosts", "Plays", "Files" or "Tasks" panels below. - You can mouse over most elements to have more details about them. -
{% for playbook in playbooks.items -%} diff --git a/ara/templates/tips/files.html b/ara/templates/tips/files.html new file mode 100644 index 00000000..53b44d39 --- /dev/null +++ b/ara/templates/tips/files.html @@ -0,0 +1,4 @@ +

Tips: Files

+
+

This panel contains all the files involved in your playbook.

+

You can click on the files in order to view them as they were when your playbook ran.

diff --git a/ara/templates/tips/hosts.html b/ara/templates/tips/hosts.html new file mode 100644 index 00000000..0fec747c --- /dev/null +++ b/ara/templates/tips/hosts.html @@ -0,0 +1,15 @@ +

Tips: Hosts

+
+

This panel contains all the hosts involved in the playbook, their tasks statistics and, if available, their host facts.

+

+ If host facts have been gathered, a summary will be available if you hover the host name. For the complete list of facts, click on the host. + Note that host facts are not in real time: they are saved at the time where facts are gathered. +

+

+ The search box searches through both the host name and the host fact summary, for example: +

    +
  • localhost would match only 'localhost' (provided by default: the Ansible inventory hostname)
    • +
  • fedora would match all 'fedora' hosts (provided by the ansible_distribution fact)
    • +
  • 192.168.1 would match all hosts with an IP in the '192.168.1' range (provided by the ansible_all_ipv4_addresses fact)
    • +
+

diff --git a/ara/templates/tips/parameters.html b/ara/templates/tips/parameters.html new file mode 100644 index 00000000..101c5f04 --- /dev/null +++ b/ara/templates/tips/parameters.html @@ -0,0 +1,4 @@ +

Tips: Parameters

+
+

This panel contains all the parameters and options passed to the ansible-playbook command.

+

You can control which parameters ARA should ignore with the ARA_IGNORE_PARAMETERS configuration.

diff --git a/ara/templates/tips/plays.html b/ara/templates/tips/plays.html new file mode 100644 index 00000000..21632e7e --- /dev/null +++ b/ara/templates/tips/plays.html @@ -0,0 +1,4 @@ +

Tips: Plays

+
+

This panel contains all the plays involved in your playbook run.

+

To see your playbook file, click the playbook file path in the playbook report list.

diff --git a/ara/templates/tips/records.html b/ara/templates/tips/records.html new file mode 100644 index 00000000..30f41cc5 --- /dev/null +++ b/ara/templates/tips/records.html @@ -0,0 +1,14 @@ +

Tips: Records

+
+

This panel contains persistent data recorded from your playbooks with the ara_record Ansible module.

+

ara_record is an Ansible module bundled with ARA that allows you to record and attach any arbitrary data that is displayed here.

+

+ Some examples of things that can be registered with ara_record: +

    +
  • The git version of your playbooks
    • +
  • The host from which your playbook ran
    • +
  • An URL to retrieve logs for the playbook
    • +
  • Important variables or debug information obtained throughout your playbook
    • +
+

+

For more information on how to use ara_record (and ara_read), refer to the documentation.

diff --git a/ara/templates/tips/tasks.html b/ara/templates/tips/tasks.html new file mode 100644 index 00000000..cbd542c3 --- /dev/null +++ b/ara/templates/tips/tasks.html @@ -0,0 +1,22 @@ +

Tips: Tasks

+
+

This panel contains all the tasks and their results on your hosts in your playbook.

+

Click on the action to view the task file in which that action is located.

+

Click on the task status in order to view the detailed results of that task.

+

+ All table columns are sortable. This allows you to, for example: +

    +
  • Sort tasks by duration to find which tasks took the longest time
    • +
  • Sort (or reverse) the elapsed column to have the beginning of the playbook (or the end) first
    • +
+

+

+ The search box searches through all fields as well as task tags. This allows you to search, for example: +

    +
  • do something would match tasks with 'do something' in their name
    • +
  • localhost would match tasks for the host 'localhost'
    • +
  • get_url would match tasks that use the 'get_url' Ansible module
    • +
  • failed would match tasks for which the status is 'failed'
    • +
  • production would match tasks that have the tag 'production'
    • +
+