added alt-text in projects.rst (#14544)

Signed-off-by: c0de-slayer <fsali315@gmail.com>
Co-authored-by: TVo <thavo@redhat.com>
This commit is contained in:
Sayyed Faisal Ali 2023-10-20 00:09:58 +05:30 committed by GitHub
parent 447ac77535
commit a82c03e2e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -19,18 +19,24 @@ The Projects page displays the list of the projects that are currently available
|Projects - home with example project|
.. |Projects - home with example project| image:: ../common/images/projects-list-all.png
:alt: Compact Projects list view with two projects shown.
.. image:: ../common/images/projects-list-all-expanded.png
:alt: Projects list view showing arrows used to expand and collapse projects in the view.
For each project listed, you can get the latest SCM revision (|refresh|), edit the project (|edit|), or copy the project attributes (|copy|), using the respective icons next to each project. Projects are allowed to be updated while a related job is running. In cases where you have a big project (around 10 GB), disk space on ``/tmp`` may be an issue.
.. |edit-icon| image:: ../common/images/edit-button.png
:alt: edit button
.. |copy| image:: ../common/images/copy-button.png
:alt: copy button
.. |refresh| image:: ../common/images/refresh-gray.png
:alt: Refresh button
.. |edit| image:: ../common/images/edit-button.png
:alt: edit button
**Status** indicates the state of the project and may be one of the following (note that you can also filter your view by specific status types):
@ -72,6 +78,7 @@ To create a new project:
|Projects - create new project|
.. |Projects - create new project| image:: ../common/images/projects-create-new-project.png
:alt: Create New Project form
2. Enter the appropriate details into the following required fields:
@ -119,6 +126,7 @@ If you have trouble adding a project path, check the permissions and SELinux con
Correct this issue by creating the appropriate playbook directories and checking out playbooks from your SCM or otherwise copying playbooks into the appropriate playbook directories.
.. |Projects - create new warning| image:: ../common/images/projects-create-manual-warning.png
:alt: Create New Project form showing warning associated with selecting Source Control Credential Type of Manual
.. _ug_projects_scm_types:
@ -147,12 +155,14 @@ To configure playbooks to use source control, in the Project **Details** tab:
|Projects - create SCM project|
.. |Projects - create SCM project| image:: ../common/images/projects-create-scm-project.png
:alt: Create New Project form for Git Source Control Credential Type.
2. Enter the appropriate details into the following fields:
- **SCM URL** - See an example in the tooltip |tooltip|.
.. |tooltip| image:: ../common/images/tooltips-icon.png
:alt: tooltips icon
- **SCM Branch/Tag/Commit** - Optionally enter the SCM branch, tags, commit hashes, arbitrary refs, or revision number (if applicable) from the source control (Git or Subversion) to checkout. Some commit hashes and refs may not be available unless you also provide a custom refspec in the next field. If left blank, the default is HEAD which is the last checked out Branch/Tag/Commit for this project.
- **SCM Refspec** - This field is an option specific to git source control and only advanced users familiar and comfortable with git should specify which references to download from the remote repository. For more detail, see :ref:`job branch overriding <ug_job_branching>`.
@ -168,6 +178,7 @@ To configure playbooks to use source control, in the Project **Details** tab:
- **Allow Branch Override** - Allows a job template or an inventory source that uses this project to launch with a specified SCM branch or revision other than that of the project's. For more detail, see :ref:`job branch overriding <ug_job_branching>`.
.. image:: ../common/images/projects-create-scm-project-branch-override-checked.png
:alt: create scm project branch override checked
4. Click **Save** to save your project.
@ -198,6 +209,7 @@ To configure playbooks to use Red Hat Insights, in the Project **Details** tab:
- **Update Revision on Launch** - Updates the revision of the project to the current revision in the remote source control, as well as cache the roles directory from :ref:`Galaxy <ug_galaxy>` or :ref:`Collections <ug_collections>`. AWX ensures that the local revision matches and that the roles and collections are up-to-date with the last update. Also, to avoid job overflows if jobs are spawned faster than the project can sync, selecting this allows you to configure a Cache Timeout to cache prior project syncs for a certain number of seconds.
.. image:: ../common/images/projects-create-scm-insights.png
:alt: Create New Project form for Red Hat Insights Source Control Credential Type.
3. Click **Save** to save your project.
@ -230,6 +242,7 @@ To configure playbooks to use a remote archive, in the Project **Details** tab:
- **Allow Branch Override** - Not recommended, as this option allows a job template that uses this project to launch with a specified SCM branch or revision other than that of the project's.
.. image:: ../common/images/projects-create-scm-rm-archive.png
:alt: Create New Project form for Remote Archive Source Control Credential Type.
.. note::
Since this SCM type is intended to support the concept of unchanging artifacts, it is advisable to disable Galaxy integration (for roles, at minimum).
@ -253,15 +266,18 @@ Updating projects from source control
|projects - list all|
.. |projects - list all| image:: ../common/images/projects-list-all.png
:alt: Projects list view with the latest revision information of the projects that synched.
2. Click on project's status under the **Status** column to get further details about the update process.
.. image:: ../common/images/projects-list-status-more.png
:alt: Projects list view with example project with a successful status.
|Project - update status|
.. |Project - update status| image:: ../common/images/projects-update-status.png
:alt: Example project with real-time standard output details.
Work with Permissions
@ -276,6 +292,7 @@ You can access the project permissions via the **Access** tab next to the **Deta
|Projects - permissions list for example project|
.. |Projects - permissions list for example project| image:: ../common/images/projects-permissions-example.png
:alt: Access tab of a sample project that shows list of users who have permissions to this project.
Add Permissions
@ -290,12 +307,14 @@ Work with Notifications
Clicking the **Notifications** tab allows you to review any notification integrations you have setup.
.. image:: ../common/images/projects-notifications-example-list.png
:alt: List of notifications configured for this project.
Use the toggles to enable or disable the notifications to use with your particular project. For more detail, see :ref:`ug_notifications_on_off`.
If no notifications have been set up, you can configure them from the **Notifications** link from the left navigation bar to create a new notification.
.. image:: ../common/images/project-notifications-empty.png
:alt: Notifications Templates page with no notification templates found.
Refer to :ref:`ug_notifications_types` for additional details on configuring various notification types.
@ -306,14 +325,17 @@ Work with Job Templates
Clicking on **Job Templates** allows you to add and review any job templates or workflow templates associated with this project.
.. image:: ../common/images/projects-templates-example-list.png
:alt: List of job templates associated with this project.
Click on the recent jobs that ran using that template to see its details and other useful information. You can sort this list by various criteria, and perform a search to filter the templates of interest.
.. image:: ../common/images/projects-templates-search-dropdown.png
:alt: Job Templates tab of the project showing an example drop-down menu that can be used to filter your search.
From this view, you can also launch (|launch|), edit (|edit|), or copy (|copy|) the template configuration.
.. |launch| image:: ../common/images/launch-button.png
:alt: launch button
Work with Schedules
@ -326,6 +348,7 @@ Work with Schedules
Clicking on **Schedules** allows you to review any schedules set up for this project.
.. image:: ../common/images/generic-schedules-list-configured.png
:alt: List of configured schedules that may be used with this project.
Schedule a Project
@ -358,12 +381,14 @@ At the end of a Project update, AWX searches for a file called ``requirements.ym
This file allows you to reference Galaxy roles or roles within other repositories which can be checked out in conjunction with your own project. The addition of this Ansible Galaxy support eliminates the need to create git submodules for achieving this result. Given that SCM projects (along with roles/collections) are pulled into and executed from a private job environment, a <private job directory> specific to the project within ``/tmp`` is created by default. However, you can specify another **Job Execution Path** based on your environment in the Jobs Settings tab of the Settings window:
.. image:: ../common/images/configure-awx-jobs-execution-path.png
:alt: Job Settings page showing where to configure the Job execution path.
The cache directory is a subdirectory inside the global projects folder. The content may be copied from the cache location to ``<job private directory>/requirements_roles`` location.
By default, AWX has a system-wide setting that allows roles to be dynamically downloaded from the ``roles/requirements.yml`` file for SCM projects. You may turn off this setting in the **Jobs settings** screen of the Settings menu by switching the **Enable Role Download** toggle button to **OFF**.
.. image:: ../common/images/configure-awx-jobs-download-roles.png
:alt: Job Settings page showing the option to Enable Role Download.
Whenever a project sync runs, AWX determines if the project source and any roles from Galaxy and/or Collections are out of date with the project. Project updates will download the roles inside the update.
@ -377,6 +402,7 @@ In short, jobs would download the most recent roles before every job run. Roles
|update-on-launch|
.. |update-on-launch| image:: ../common/images/projects-scm-update-options-update-on-launch-checked.png
:alt: SCM update options Update Revision on Launch checked.
.. end reused section
@ -405,6 +431,7 @@ In the User Interface, you can configure these settings in the Jobs settings win
.. image:: ../common/images/configure-awx-jobs-path-to-expose.png
:alt: Job Settings page showing example paths to expose to isolated jobs.
.. _ug_collections:
@ -421,6 +448,7 @@ AWX supports project-specific `Ansible collections <https://docs.ansible.com/ans
By default, AWX has a system-wide setting that allows collections to be dynamically downloaded from the ``collections/requirements.yml`` file for SCM projects. You may turn off this setting in the **Jobs settings** tab of the Settings menu by switching the **Enable Collections Download** toggle button to **OFF**.
.. image:: ../common/images/configure-awx-jobs-download-collections.png
:alt: Job Settings page showing where to enable collection(s) download.
Roles and collections are locally cached for performance reasons, and you will need to select **Update Revision on Launch** in the project SCM Update Options to ensure this:
@ -439,6 +467,7 @@ Before AWX can use |ah| as the default source for collections content, you need
2. Click the copy icon to copy the API token to the clipboard.
.. image:: ../common/images/projects-ah-loaded-token-shown.png
:alt: Connect to Hub page showing where to copy the offline token.
3. To use the public |ah|, create an |ah| credential using the copied token and pointing to the URLs shown in the **Server URL** and **SSO URL** fields of the token page:
@ -449,15 +478,19 @@ Before AWX can use |ah| as the default source for collections content, you need
4. To use a private |ah|, create an |ah| credential using a token retrieved from the Repo Management dashboard of your local |ah| and pointing to the published repo URL as shown:
.. image:: ../common/images/projects-ah-repo-mgmt-get-token.png
:alt: The Repo Management dashboard of your local Automation Hub.
.. image:: ../common/images/projects-ah-repo-mgmt-repos-published.png
:alt: The Get token button next to the published repo URL in the Repo Management dashboard of your local Automation Hub.
You can create different repos with different namespaces/collections in them. But for each repo in |ah| you need to create a different |ah| credential. Copy the **Ansible CLI URL** from the |ah| UI in the format of ``https://$<hub_url>/api/galaxy/content/<repo you want to pull from>`` into the **Galaxy Server URL** field of the *Create Credential* form:
.. image:: ../common/images/projects-create-ah-credential.png
:alt: Create New Credential form for Ansible Galaxy/Automation Hub API Token Credential Type.
5. Navigate to the organization for which you want to be able to sync content from |ah| and add the new |ah| credential to the organization. This step allows you to associate each organization with the |ah| credential (i.e. repo) that you want to be able to use content from.
.. image:: ../common/images/projects-organizations-add-ah-credential.png
:alt: Edit example default organizations form with Ansible Galaxy and Automation Hub credentials.
.. note::
@ -472,14 +505,17 @@ You can create different repos with different namespaces/collections in them. Bu
6. If the |ah| has self-signed certificates, click the toggle to enable the setting **Ignore Ansible Galaxy SSL Certificate Verification**. For **public Automation Hub**, which uses a signed certificate, click the toggle to disable it instead. Note this is a global setting:
.. image:: ../common/images/settings-jobs-ignore-galaxy-certs.png
:alt: Job Settings page showing where to enable the option to ignore Ansible Galaxy SSL Certificate Verification.
7. Create a project, where the source repository specifies the necessary collections in a requirements file located in the ``collections/requirements.yml`` file. Refer to the syntax described in the corresponding `Ansible documentation <https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#install-multiple-collections-with-a-requirements-file>`_.
.. image:: ../common/images/projects-add-ah-source-repo.png
:alt: The URL for the Source Control URL in the Type Details section of the Create New Project form.
8. In the Projects list view, click |update| to run an update against this project. AWX fetches the Galaxy collections from the ``collections/requirements.yml`` file and report it as changed; and the collections will now be installed for any job template using this project.
.. |update| image:: ../common/images/refresh-gray.png
:alt: Refresh button.
.. note::