Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre-release updates to Using automation execution #1952

Merged
merged 6 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ By using an inventory file, Ansible can manage a large number of hosts with a si
Inventories also help you use Ansible more efficiently by reducing the number of command line options you have to specify.
Inventories are divided into groups and these groups contain the hosts.

Groups may be sourced manually, by entering host names into {ControllerName}, or from one of its supported cloud providers.
Groups can be sourced manually, by entering host names into {ControllerName}, or from one of its supported cloud providers.

[NOTE]
====
If you have a custom dynamic inventory script, or a cloud provider that is not yet supported natively in {ControllerName}, you can also import that into {ControllerName}.

For more information, see link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/automation_controller_administration_guide/index#assembly-inventory-file-importing[Inventory file importing] in _{ControllerAG}_.
For more information, see link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html-single/configuring_automation_execution/index#assembly-inventory-file-importing[Inventory file importing] in _{ControllerAG}_.
====

From the navigation panel, select {MenuInfrastructureInventories}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[id="assembly-controller-topology-viewer"]

= Topology viewer
= Topology View

Use the topology viewer to view node type, node health, and specific details about each node if you already have a mesh topology deployed.
Use the *Topology View* to view node type, node health, and specific details about each node if you already have a mesh topology deployed.

To access the topology viewer from the {ControllerName} UI, you must have *System Administrator* permissions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

= Jobs in {ControllerName}

A job is an instance of {ControllerName} launching an Ansible playbook against an inventory of hosts.
A job is an instance of {ControllerName} launching an Ansible Playbook against an inventory of hosts.

The *Jobs* list view displays a list of jobs and their statuses, shown as completed successfully, failed, or as an active (running) job.
The default view is collapsed (Compact) with the job name, status, job type, start, and finish times.
Expand All @@ -27,7 +27,7 @@ image::ug-job-details-view-filters.png[Job details view filters]
* The *Event* option in the *Search output* list enables you to filter by the events of interest, such as errors, host failures, host retries, and items skipped.
You can include as many events in the filter as necessary.
//* The *Advanced* option is a refined search that gives you a combination of including or excluding criteria, searching by key, or by lookup type.
For more information on using the search, refer to the xref:assembly-controller-search[Search] section.
For more information about using the search, see the xref:assembly-controller-search[Search] section.

include::platform/con-controller-inventory-sync-jobs.adoc[leveloffset=+1]
include::platform/ref-controller-inventory-sync-details.adoc[leveloffset=+2]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[id="controller-notifications"]

= Notifications
= Notifiers

A xref:controller-notification-types[Notification type] such as Email, Slack or a Webhook, is an instance of a Notification Template, and has a name, description and configuration defined in the Notification template.

Expand Down
Binary file modified downstream/images/sort-order-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified downstream/images/ug-jobs-events-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified downstream/images/ug-schedules-sample-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ From here, you can create, view, and edit:
//activity stream is an unconnected procedure. It needs a home.
* xref:assembly-controller-activity-stream[Activity Stream]
* xref:controller-approval-nodes[Workflow Approvals]
* xref:controller-notifications[Notifications]
* xref:controller-notifications[Notifiers]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/automation_controller_administration_guide/assembly-controller-management-jobs[Management Jobs]


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Custom fact caching could conflict with the controller's fact caching feature.
You must use the fact caching module that includes {ControllerName}.
====

You can select to use cached facts in your job by checking the *Enable Fact Storage* option when you create or edit a job template.
You can select to use cached facts in your job by checking the *Enable fact storage* option when you create or edit a job template.

image::ug-job-templates-options-use-factcache.png[Cached facts]
//image::ug-job-templates-options-use-factcache.png[Cached facts]

To clear facts, run the Ansible `clear_facts` link:https://docs.ansible.com/ansible/latest/collections/ansible/builtin/meta_module.html#examples[meta task].
The following is an example playbook that uses the Ansible `clear_facts` meta task.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

= {ControllerNameStart} capacity determination and job impact

The {ControllerNameStart} capacity system determines how many jobs can run on an instance given the amount of resources available to the instance and the size of the jobs that are running (referred to as Impact).
The {ControllerName} capacity system determines how many jobs can run on an instance given the amount of resources available to the instance and the size of the jobs that are running (referred to as Impact).
The algorithm used to determine this is based on the following two things:

* How much memory is available to the system (`mem_capacity`)
Expand All @@ -22,5 +22,5 @@ This guarantees that jobs do not get stuck as a result of an under-provisioned s

.Additional resources

* For information on container groups, see link:{BaseURL}red_hat_ansible_automation_platform/{PlatformVers}/html/automation_controller_administration_guide/controller-instance-and-container-groups#controller-container-capacity[Container capacity limits] in _{ControllerAG}_.
* For information on sliced jobs and their impact to capacity, see xref:controller-job-slice-execution-behavior[Job slice execution behavior].
* For information about container groups, see link:{BaseURL}red_hat_ansible_automation_platform/{PlatformVers}/html/automation_controller_administration_guide/controller-instance-and-container-groups#controller-container-capacity[Container capacity limits] in _{ControllerAG}_.
* For information about sliced jobs and their impact to capacity, see xref:controller-job-slice-execution-behavior[Job slice execution behavior].
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

When an inventory synchronization is executed, the results display in the *Output* tab.

For more information on inventory synchronization, see xref:ref-controller-constructed-inventories[Constructed inventories].
For more information about inventory synchronization, see xref:ref-controller-constructed-inventories[Constructed inventories].

If used, the Ansible CLI displays the same information.
This can be useful for debugging.
The `ANSIBLE_DISPLAY_ARGS_TO_STDOUT` parameter is set to `False` for all playbook runs.
This parameter matches Ansible's default behavior and does not display task arguments in task headers in the *Job Detail* interface to avoid leaking certain sensitive module parameters to `stdout`.
To restore the previous behavior, set `ANSIBLE_DISPLAY_ARGS_TO_STDOUT` to `True` through the `AWX_TASK_ENV` configuration setting.
To restore the earlier behavior, set `ANSIBLE_DISPLAY_ARGS_TO_STDOUT` to `True` through the `AWX_TASK_ENV` configuration setting.

For more information, see link:http://docs.ansible.com/ansible/latest/reference_appendices/config.html#envvar-ANSIBLE_DISPLAY_ARGS_TO_STDOUT[ANSIBLE_DISPLAY_ARGS_TO_STDOUT] in the ansible documentation.

Use the icons to relaunch image:rightrocket.png[Launch,15,15], download image:download.png[Download,15,15] the job output, or delete image:delete-button.png[Delete,15,15] the job.
You can btn:[Relaunch job], btn:[Cancel job], download image:download.png[Download,15,15] the job output, or delete image:delete-button.png[Delete,15,15] the job.

image::ug-show-job-results-for-inv-sync.png[Job results inventory sync]
//image::ug-show-job-results-for-inv-sync.png[Job results inventory sync]

[NOTE]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ These are represented by the values specified in the *Type Details* fields:

image::ug-scm-project-branching-emphasized.png[Project branching emphasized]

When creating or editing a job you have the option to *Allow Branch Override*.
When creating or editing a job you have the option to *Allow branch override*.
When this option is checked, project administrators can delegate branch selection to the job templates that use that project, requiring only project `use_role`.
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ For more information, see xref:proc-controller-inv-source-satellite[Red Hat Sate

* Red Hat Insights integration, enabling Insights playbooks to be used as an {PlatformNameShort} project.

For more information, see xref:controller-setting-up-insights[Setting up Insights Remediations].
For more information, see xref:controller-setting-up-insights[Setting up Red Hat Insights for {PlatformName} Remediations].

* {HubNameStart} acts as a content provider for {ControllerName}, requiring both an {ControllerName} deployment and an {HubName} deployment running alongside each other.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
When a playbook is executed, the results display in the *Output* tab.
If used, the Ansible CLI displays the same information. This can be useful for debugging.

image::ug-results-for-example-job.png[Results for example job]
//image::ug-results-for-example-job.png[Results for example job]

The events summary displays the following events that are run as part of this playbook:

Expand All @@ -16,9 +16,9 @@ The events summary displays the following events that are run as part of this pl

image::ug-jobs-events-summary.png[Job events summary]

Use the icons next to the events to relaunch (image:rightrocket.png[Rightrocket,15,15]), download (image:download.png[Download,15,15]) the job output, or delete (image:delete-button.png[Delete,15,15]) the job.
You can btn:[Relaunch job], btn:[Cancel job], download image:download.png[Download,15,15] the job output, or delete image:delete-button.png[Delete,15,15] the job.

Hover over a section of the host status bar in the *Output* view and the number of hosts associated with that status displays.

The output for a playbook job is also available after launching a job from the *Jobs* tab of its *Jobs Templates* page.
View its host details by clicking on the line item tasks in the output.
View its host details by clicking the line item tasks in the output.
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

= Project revision behavior

During a project update, the revision of the default branch (specified in the *SCM Branch* field of the project) is stored when updated.
If providing a non-default *SCM Branch* (not a commit hash or tag) in a job, the newest revision is pulled from the source control remote immediately before the job starts.
This revision is shown in the *Source Control Revision* field of the job and its project update.
During a project update, the revision of the default branch (specified in the *Source control branch* field of the project) is stored when updated.
If providing a non-default *Source control branch* (not a commit hash or tag) in a job, the newest revision is pulled from the source control remote immediately before the job starts.
This revision is shown in the *Source control revision* field of the job and its project update.

image::ug-output-branch-override.png[Jobs output override example]
//image::ug-output-branch-override.png[Jobs output override example]

As a result, offline job runs are impossible for non-default branches.
To ensure that a job is running a static version from source control, use tags or commit hashes.
Project updates do not save all branches, only the project default branch.

The *SCM Branch* field is not validated, so the project must update to assure it is valid.
If this field is provided or prompted for, the *Playbook* field of job templates is not validated, and you have to launch the job template in order to verify presence of the expected playbook.
The *Source control branch* field is not validated, so the project must update to assure it is valid.
If this field is provided or prompted for, the *Playbook* field of job templates is not validated, and you have to launch the job template to verify presence of the expected playbook.
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ You must have permissions to all the resources used in a workflow, such as job t

For more information, see link:{URLCentralAuth}/index#gw-managing-access[Managing access with role based access control].

For more information on performing the tasks described in this section, see xref:controller-workflow-job-templates[Workflow job templates].
For more information about performing the tasks described, see xref:controller-workflow-job-templates[Workflow job templates].
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

When an inventory sourced from an SCM, for example git, is executed, the results are displayed in the *Output* tab.
If used, the Ansible CLI displays the same information. This can be useful for debugging.
Use the icons in the navigation menu to relaunch (image:rightrocket.png[Rightrocket,15,15]), download (image:download.png[Download,15,15]) the job output, or delete (image:delete-button.png[Delete,15,15]) the job.
Use the navigation menu to btn:[Relaunch job], btn:[Cancel job], download image:download.png[Download,15,15] the job output, or delete image:delete-button.png[Delete,15,15] the job.

image::ug-results-for-scm-job.png[Results for SCM job]
//image::ug-results-for-scm-job.png[Results for SCM job]
16 changes: 10 additions & 6 deletions downstream/modules/platform/con-controller-settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@

= The Settings menu

You can configure some {ControllerName} options using the *Settings* menu of the User Interface.

You can configure some {ControllerName} options by using the *Settings* menu of the User Interface.

The *Settings* page enables an administrator to configure the following:

* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatfromVers}/html/automation_controller_administration_guide/assembly-ag-controller-config#proc-controller-configure-subscriptions[Subscriptions]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/automation_controller_administration_guide/assembly-ag-controller-config#controller-configure-system[System]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/automation_controller_administration_guide/assembly-ag-controller-config#controller-configure-jobs[Jobs]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/automation_controller_administration_guide/assembly-ag-controller-config#proc-controller-configure-analytics[{Analytics}]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatfromVers}/html/access_management_and_authentication/index#proc-controller-configure-subscriptions[Subscription]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatfromVers}/html/access_management_and_authentication/index#proc-settings-platform-gateway[Platform gateway]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatfromVers}/html/access_management_and_authentication/index#proc-settings-user-preferences[User Preferences]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/configuring_automation_execution/index#proc-controller-configure-subscriptions[System]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/configuring_automation_execution/index#controller-configure-jobs[Job]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/configuring_automation_execution/index#proc-controller-set-up-logging[Logging]
* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/access_management_and_authentication/index#proc-settings-troubleshooting[Troubleshooting]
// [emcwhinn] Analytics has its own section in 2.5 UI
//* link:{BaseURL}/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/automation_controller_administration_guide/assembly-ag-controller-config#proc-controller-configure-analytics[{Analytics}]
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
= Work with notifications

From the navigation panel, select {MenuAEAdminJobNotifications}.
This enables you to review any notification integrations you have set up and their statuses, if they have run.
You can review any notification integrations you have set up and their statuses, if they have run.

image::ug-job-template-completed-notifications-view.png[Job template completed notifications]
//image::ug-job-template-completed-notifications-view.png[Job template completed notifications]

Use the toggles to enable or disable the notifications to use with your particular template.
For more information, see xref:controller-enable-disable-notifications[Enable and Disable Notifications].
For more information, see xref:controller-enable-disable-notifications[Enable and disable notifications].

If no notifications have been set up, click btn:[Add notifier] to create a new notification.
For more information about configuring various notification types and extended messaging, see xref:controller-notification-types[Notification Types].
For more information about configuring various notification types and extended messaging, see xref:controller-notification-types[Notification types].
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ When you have added a group to a template, the Group *Details* page is displayed
.Procedure

. Select the *Related Groups* tab.
. Click btn:[Existing group] to add a group that already exists in your configuration or btn:[New group] to create a new group.
. Click btn:[Add existing group] to add a group that already exists in your configuration or btn:[Create group] to create a new group.
. If creating a new group, enter the appropriate details into the required and optional fields:

* *Name* (required):
* Optional: *Description*: Enter a description as appropriate.
* *Variables*: Enter definitions and values to be applied to all hosts in this group.
* Optional: *Variables*: Enter definitions and values to be applied to all hosts in this group.
Enter variables using either JSON or YAML syntax.
Use the radio button to toggle between the two.
. Click btn:[Save].
. The *Create Group* window closes and the newly created group is displayed as an entry in the list of groups associated with the group that it was
. Click btn:[Create group].
. The *Create group* window closes and the newly created group is displayed as an entry in the list of groups associated with the group that it was
created for.
//+
//image:inventories-add-group-subgroup-added.png[Inventories add group subgroup]
Expand Down
9 changes: 5 additions & 4 deletions downstream/modules/platform/proc-controller-add-groups.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,17 @@ All of these spawned groups can have hosts.
. From the navigation panel, select {MenuInfrastructureInventories}.
. Select the Inventory name you want to add groups to.
. In the Inventory *Details* page, select the *Groups* tab.
. Click btn:[Create group] to open the *Create new group* window.
. Click btn:[Create group].
//+
//image:inventories-add-group-new.png[Inventories_manage_group_add]

. Enter the appropriate details:

* *Name*: Required
* Optional: *Description*: Enter a description as appropriate.
* *Variables*: Enter definitions and values to be applied to all hosts in this group.
* Optional: *Variables*: Enter definitions and values to be applied to all hosts in this group.
Enter variables by using either JSON or YAML syntax.
Use the radio button to toggle between the two.
. Click btn:[Save].
. When you have added a group to a template, the Group *Details* page is displayed.
. Click btn:[Create group].

When you have added a group to a template, the Group *Details* page is displayed.
Loading