8000 Update Templates with new information by ianf77 · Pull Request #3364 · ansible/aap-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update Templates with new information #3364

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

Merged
merged 3 commits into from
Apr 30, 2025
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 @@ -10,9 +10,9 @@ A job template is a definition and set of parameters for running an Ansible job.
Job templates are useful to run the same job many times.
They also encourage the reuse of Ansible Playbook content and collaboration between teams.

The *Templates* page shows both job templates and workflow job templates that are currently available.
The default view is collapsed (Compact), showing the template name, template type, and the timestamp of the last job that ran using that template.
You can click the arrow image:arrow.png[Arrow,15,15] icon next to each entry to expand and view more information.
The *Automation Templates* page shows both job templates and workflow job templates that are currently available.
The default view is to show each template as a card, showing the template name and template type.
Select the template name to display more information about the tenmplate, including when it last ran.
This list is sorted alphabetically by name, but you can sort by other criteria, or search by various fields and attributes of a template.

[NOTE]
Expand All @@ -22,7 +22,7 @@ Search functionality for Job templates is limited to alphanumeric characters onl

//image::ug-job-templates-home.png[Job templates home]

From this screen you can launch image:rightrocket.png[Rightrocket,15,15], edit image:leftpencil.png[Leftpencil,15,15], duplicate image:copy.png[Copy,15,15] and delete image:delete-button.png[Delete,15.15] a job template.
From the template card you can launch image:rightrocket.png[Rightrocket,15,15], edit image:leftpencil.png[Leftpencil,15,15] a template, or, using the {MoreActionsIcon} icon, you can duplicate image:copy.png[Duplicate,15,15] or delete image:delete-button.png[Delete,15,15] a template.

Workflow templates have the workflow visualizer image:visualizer.png[Workflow visualizer,15,15] icon as a shortcut for accessing the workflow editor.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ These resources include the following:
* Project syncs
* Inventory source syncs

The *Templates* page shows the workflow and job templates that are currently available.
The default view is collapsed (Compact), showing the template name, template type, and the statuses of the jobs that have run by using that template.
You can click the arrow next to each entry to expand and view more information.
The *Automation Templates* page shows the workflow and job templates that are currently available.
The default view is to show each template as a card, showing the template name and template type.
Select the template name to display more information about the template, including when it last ran.
This list is sorted alphabetically by name, but you can sort by other criteria, or search by various fields and attributes of a template.
From this screen you can launch image:rightrocket.png[Launch,15,15], edit image:leftpencil.png[Edit,15,15], and duplicate image:copy.png[Copy,15,15] a workflow job template.

From the template card you can launch image:rightrocket.png[Rightrocket,15,15], edit image:leftpencil.png[Leftpencil,15,15] a template, or, using the {MoreActionsIcon} icon, you can duplicate image:copy.png[Duplicate,15,15] or delete image:delete-button.png[Delete,15,15]a template.

Only workflow templates have the workflow visualizer image:visualizer.png[Workflow visualizer,15,15] icon as a shortcut for accessing the workflow editor.

Expand Down
Binary file modified downstream/images/delete-button.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 @@ -5,9 +5,10 @@
The *Jobs* tab provides the list of job templates that have run.
Click the expand icon next to each job to view the following details:

* Status
* ID and name
* ID and name
* Status
* Type of job
* Duration of run
* Time started and completed
* Who started the job and which template, inventory, project, and credential were used.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[id="controller-copy-a-job-template"]

= Copying a job template
= Duplicating a job template

If you copy a job template, it does not copy any associated schedule, notifications, or permissions.
Schedules and notifications must be recreated by the user or administrator creating the copy of the job template.
The user copying the Job Template is granted administrator permission, but no permissions are assigned (copied) to the job template.
If you duplicate a job template, it does not duplicate any associated schedule, notifications, or permissions.
Schedules and notifications must be recreated by the user or administrator creating the duplicate of the job template.
The user duplicating the Job Template is granted administrator permission, but no permissions are assigned (duplicated) to the job template.

.Procedure

. From the navigation panel, select {MenuAETemplates}.
. Click image:options_menu.png[options menu,15,15] and the copy image:copy.png[Copy,15,15] icon associated with the template that you want to copy.
* The new template with the name of the template from which you copied and a timestamp displays in the list of templates.
. Click the {MoreActionIcon} icon associated with the template that you want to duplicate and select the image:copy.png[Duplicate Template,15,15] Duplicate Template icon.
* The new template with the name of the template from which you duplicated and a timestamp displays in the list of templates.
. Click to open the new template and click btn:[Edit template].
. Replace the contents of the *Name* field with a new name, and give or change the entries in the other fields to complete this page.
. Click btn:[Save job template].
Original file line number Diff line number Diff line change
@@ -1,30 +1,27 @@
[id="controller-copy-workflow-job-template"]

= Copying a workflow job template
= Duplicating a workflow job template

With {ControllerName} you can copy a workflow job template.
When you copy a workflow job template, it does not copy any associated schedule, notifications, or permissions.
Schedules and notifications must be recreated by the user or system administrator creating the copy of the workflow template.
The user copying the workflow template is granted the administrator permission, but no permissions are assigned (copied) to the workflow template.
With {ControllerName} you can duplicate a workflow job template.
When you duplicate a workflow job template, it does not duplicate any associated schedule, notifications, or permissions.
Schedules and notifications must be recreated by the user or system administrator creating the duplicate of the workflow template.
The user duplicating the workflow template is granted the administrator permission, but no permissions are assigned (duplicated) to the workflow template.

.Procedure

. Open the workflow job template that you want to copy by using one of these methods:
** From the navigation panel, select {MenuAETemplates}.
** In the workflow job template *Details* view, click image:options_menu.png[15,15] next to the desired template.
*** Click the copy (image:copy.png[Copy icon,15,15]) icon.
+
The new template with the name of the template from which you copied and a timestamp displays in the list of templates.
+
//image::ug-wf-list-view-copy-example.png[Workflow template copy list view]
+
. Select the copied template and click btn:[Edit template].
. Replace the contents of the *Name* field with a new name, and give or change the entries in the other fields to complete this template.
..Procedure

. From the navigation panel, select {MenuAETemplates}.
. Click the {MoreActionIcon) icon associated with the template that you want to duplicate and select the image:copy.png[Duplicate Template,15,15] Duplicate Template icon.
* The new template with the name of the template from which you duplicated and a timestamp displays in the list of templates.
. Click to open the new template and click btn:[Edit template].
. Replace the contents of the *Name* field with a new name, and give or change the entries in the other fields to complete this page.
. Click btn:[Save job template].


[NOTE]
====
If a resource has a related resource that you do not have the right level of permission to, you cannot copy the resource. For example, in the case where a project uses a credential that a current user only has Read access.
However, for a workflow job template, if any of its nodes use an unauthorized job template, inventory, or credential, the workflow template can still be copied.
But in the copied workflow job template, the corresponding fields in the workflow template node are absent.
If a resource has a related resource that you do not have the right level of permission to, you cannot duplicate the resource. For example, in the case where a project uses a credential that a current user only has Read access.
However, for a workflow job template, if any of its nodes use an unauthorized job template, inventory, or credential, the workflow template can still be duplicated.
But in the duplicated workflow job template, the corresponding fields in the workflow template node are absent.
====
2E8E
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.Procedure

. From the navigation panel, select {MenuAETemplates}.
. On the *Templates* page, select *Create job template* from the *Create template* list.
. On the *Automation Templates* page, select *Create job template* from the *Create template* list.
. Enter the appropriate details in the following fields:
+
[NOTE]
Expand Down Expand Up @@ -41,14 +41,15 @@ Specify the overriding branch to use in your job run.
If left blank, the specified SCM branch (or commit hash or tag) from the project is used.

For more information, see xref:controller-job-branch-overriding[Job branch overriding]. | Yes
| Execution Environment | Select the container image to be used to run this job.
You must select a project before you can select an {ExecEnvShort}. | Yes.

Execution environment prompts show up as its own step in a later prompt window.
| Playbook | Choose the playbook to be launched with this job template from the available playbooks.
This field automatically populates with the names of the playbooks found in the project base path for the selected project.
Alternatively, you can enter the name of the playbook if it is not listed, such as the name of a file (such as foo.yml) you want to use to run with that playbook.
If you enter a filename that is not valid, the template displays an error, or causes the job to fail. | N/A
| Execution Environment | Select the container image to be used to run this job.
You must select a project before you can select an {ExecEnvShort}. | Yes.

Execution environment prompts show up as its own step in a later prompt window.

| Credentials | Select the image:examine.png[examine,15,15] icon to open a separate window.

Choose the credential from the available options to use with this job template.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This can lead to playbook failures if the limit is mandatory for the playbook th
.Procedure

. From the navigation panel, select {MenuAETemplates}.
. On the *Templates* list view, select *Create workflow job template* from the *Create template* list.
. On the *Automation Templates* page, select *Create workflow job template* from the *Create template* list.
+
//image::ug-create-new-wf-template.png[Create workflow template]
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Before deleting a job template, ensure that it is not used in a workflow job tem

.Procedure

. Delete a job template by using one of these methods:
* Select the checkbox next to one or more job templates. Click image:options_menu.png[options menu,15,15] and select btn:[Delete template].
* Select the required job template, on the *Details* page click image:options_menu.png[options menu,15,15] and select btn:[Delete template].
. Delete a job template using the following method:
* Click the {MoreActionsIcon} icon and select the Delete Templateimage:delete-icon.png[Delete Template,15,15] icon.
* Select the required job template, on the *Details* page click the {MoreActionsIcon} icon and select image:delete-button.png[Delete template,15,15] btn:[Delete template].

[NOTE]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Easier deployments drive consistency, by running your playbooks the same way eac
.Procedure

* Launch a job template by using one of these methods:
** From the navigation panel, select {MenuAETemplates} and click *Launch template* image:rightrocket.png[Rightrocket,15,15] next to the job template.
** From the navigation panel, select {MenuAETemplates} and click *Launch template* image:rightrocket.png[Rightrocket,15,15] on the job template card.
+
//image::ug-job-template-launch.png[Job template launch]
+
Expand Down Expand Up @@ -51,5 +51,5 @@ This endpoint accepts JSON and you can specify a list of unified job templates (
The user must have the appropriate permission to launch all the jobs.
If all jobs are not launched an error is returned indicating why the operation was not able to complete.
Use the `OPTIONS` request to return relevant schema.
For more information, see the link:https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html#/Bulk[Bulk endpoint] of the Reference section of the Automation Controller API Guide.
For more information, see the link:{LinkControllerAPIOverview}/api_ref.html#/Bulk[Bulk endpoint] of the Reference section of the {TitleControllerAPIOverview}.
====
0