Skip to content

Commit f11090c

Browse files
authored
AAP-52256-B updated automation dashboard guide (#4273)
1 parent d14d1ef commit f11090c

File tree

5 files changed

+27
-18
lines changed

5 files changed

+27
-18
lines changed

downstream/titles/automation-dashboard/automation-dashboard/automation-dashboard/con-filter-automation-data.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ You can select one or more of the following options to customize your report:
1212
* **Template:** Select one or more Job Templates.
1313
* **Organization:** Select one or more Organizations.
1414
* **Project:** Select one or more Projects.
15-
* **Label:** Select one or more automations by label. Labels must be preconfigured and assigned to {PlatformNameShort} before they display in {AutomationDashboardName}. For more on configuring labels, see the _Creating a job template_ procedure.
16-
//emurtoug update the link to Creating Job Templates procedure
15+
* **Label:** Select one or more automations by label. Labels must be preconfigured and assigned to {PlatformNameShort} before they display in {AutomationDashboardName}. For more on configuring labels, see link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_execution/controller-job-templates#controller-create-job-template[Creating a job template].
1716

1817
== Time period and currency
1918

@@ -26,4 +25,4 @@ Changing from one currency to another does not convert the value. You must manua
2625

2726
== Save a report
2827

29-
Use *Save as report* to save this report to your {AutomationDashboardName}. You can retrieve it at any time by using *Select a report*.
28+
Use *Save as Report* to save this report to your {AutomationDashboardName}. You can retrieve it at any time by using *Select a Report*.

downstream/titles/automation-dashboard/automation-dashboard/automation-dashboard/proc-analyzing-costs-savings.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ To calculate your savings, use the following procedure:
99

1010
.Procedure
1111

12-
. Use the **Average cost of an employee minut**e field to enter the average cost per minute for an engineer to manually run jobs.
13-
. Use the **Cost per minute of {PlatformNameShort}** field to enter an average cost per minute of running a job using {PlatformNameShort}. You can include the costs associated with creating the initial or ongoing automation execution.
12+
. Use the **Average cost per minute to manually run the job** field to enter the average cost per minute for an engineer to manually run jobs.
13+
. Use the **Average cost per minute of running on {PlatformNameShort}** field to enter an average cost per minute of running a job using {PlatformNameShort}. You can include the costs associated with creating the initial or ongoing automation execution.
14+
. Select **Time taken to create automation into calculation** to include the costs associated with creating the initial or ongoing automation execution.
15+
1416
Based on these inputs, {AutomationDashboardName} provides the following data:
1517

1618

@@ -19,6 +21,8 @@ Based on these inputs, {AutomationDashboardName} provides the following data:
1921
* **Total savings/cost avoided**: This is the difference between the **Cost of manual automation** and the **Cost of automated execution**. This is a key metric for demonstrating the return on investment attainable by using {PlatformNameShort}.
2022
* **Total hours saved/avoided**: This figure is calculated by adding host executions and automation creation time, then subtracting the running time in minutes.
2123
* **Time taken to manually execute (min)**: This metric represents the amount of time it would take for a user to perform the task manually on a host. It is an input provided to compare the value of manual execution and automated execution using the time taken by the organization to manually automate.
22-
24+
+
2325
[NOTE]
24-
You can export the data from your cost and savings analysis as a CSV.
26+
====
27+
You can export the data from your cost and savings analysis as a CSV.
28+
====

downstream/titles/automation-dashboard/automation-dashboard/automation-dashboard/proc-installing-automation-dashboard.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,5 @@ ec2-54-147-26-173.compute-1.amazonaws.com : ok=126 changed=51 unreachable=0
125125
localhost : ok=12 changed=0 unreachable=0 failed=0 skipped=9 rescued=0 ignored=0
126126
----
127127

128-
.Troubleshooting
129-
130-
* Alternative configurations are possible (for example, the database for {AutomationDashboardName} can be set on a different host). This requires additional changes to variables in the inventory file.
131-
* Consult the section “Inventory variables” below for available variables.
128+
Alternative configurations are possible (for example, the database for {AutomationDashboardName} can be set on a different host). This requires additional changes to variables in the inventory file. For more information, see the Inventory variables section of this guide
129+
//emurtoug note to add link to appendix

downstream/titles/automation-dashboard/automation-dashboard/automation-dashboard/proc-integrating-automation-dashboard.adoc

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,21 @@ Integrate your {PlatformNameShort} instances into the {AutomationDashboardName}
1111
.Procedure
1212

1313
. Verify that {AutomationDashboardName} is running on https port 8447 on your RHEL host. This verification will require your login details as defined in the inventory file.
14-
[NOTE]
15-
Port 8447 is enabled by default, but this is configurable.
14+
+
15+
[NOTE]
16+
====
17+
Port 8447 is enabled by default, but this is configurable.
18+
====
1619
. Enter `admin` as the username and use `reporter_admin_password` as the password.
1720
. Your {PlatformNameShort} instances are added into `clusters.yml` using the following information:
1821
* Your {PlatformNameShort} URLs/ports for front-end access
1922
* A preconfigured {PlatformNameShort} 0Auth token for read access
20-
[NOTE]
23+
+
24+
[NOTE]
25+
====
2126
If you don’t have access to {PlatformNameShort}, consult your administrator.
22-
. Configure a personal access token. For more information, see Configuring access to external applications with token-based authentication.
23-
//emurtoug reminder to add link for Configuring access to external apps
27+
====
28+
. Configure a personal access token. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/access_management_and_authentication/gw-token-based-authentication[Configuring access to external applications with token-based authentication].
2429
. After you have configured your access token, run the following command:
2530
+
2631
[source,bash]
@@ -30,8 +35,11 @@ vi clusters.yml
3035
----
3136

3237
. You can add one or more {PlatformNameShort} instances into the {AutomationDashboardName} configuration for pulling and combining data by using the following:
33-
[NOTE]
38+
+
39+
[NOTE]
40+
====
3441
If you only have one {PlatformNameShort} instance, then remove the second entry.
42+
====
3543
+
3644
[source,bash]
3745
----

downstream/titles/automation-dashboard/automation-dashboard/automation-dashboard/proc-uninstalling-automation-dashboard.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This procedure describes how to uninstall {AutomationDashboardName} by running a
1010

1111
.Procedure
1212

13-
Run the following command to uninstall {AutomationDashboardName} and its dependencies, including the PostgreSQL database container:
13+
. Run the following command to uninstall {AutomationDashboardName} and its dependencies, including the PostgreSQL database container:
1414
+
1515
[source,bash,subs="+attributes"]
1616
----

0 commit comments

Comments
 (0)