mirror of
https://github.com/ansible/awx.git
synced 2026-01-09 15:02:07 -03:30
Cherrypick recent docs prs to docs branch (#15477)
* Update docs replacements to AWX (#15349) Update replacements to AWX Signed-off-by: Sandra McCann <samccann@redhat.com> (cherry picked from commit 9979fc659efbf4d54a39f9f36912d5ed7b0fa6cd) * Remove remnants of controller terms from quickstart docs (#15350) Remove remnants of controller terms from quickstart Signed-off-by: Sandra McCann <samccann@redhat.com> (cherry picked from commit 864a30e3d451e6daf39421a598f725419f105101) * Remove references to translated versions of the docs (#15354) remove references to translated versions of the docs Signed-off-by: Sandra McCann <samccann@redhat.com> Co-authored-by: TVo <thavo@redhat.com> (cherry picked from commit 5f42db67e6fbcffa8e5b26553d41273b7730344c) * update terminology (#15357) * update terminology Replace some instances of Tower with AWX and remove some references to enterprise left over from the migration of RST content from the Automation Controller docs. * Update docs/docsite/rst/userguide/overview.rst Co-authored-by: TVo <thavo@redhat.com> --------- Co-authored-by: TVo <thavo@redhat.com> (cherry picked from commit f1448fced1411b9d7cce19a0ad91df992e447014) * Replaced all references of downstream docs to upstream docs (#15388) * Replaced all references of downstream docs to upstream docs. * Update README.md Co-authored-by: Don Naro <dnaro@redhat.com> * Update README.md.j2 Co-authored-by: Don Naro <dnaro@redhat.com> * Update README.md.j2 Co-authored-by: Don Naro <dnaro@redhat.com> * Incorpor'd review feedback from @oraNod and @samccann * Updated with agreed link (for now) until further change is needed. --------- Co-authored-by: Don Naro <dnaro@redhat.com> (cherry picked from commit 018f235a645163ee820ff33b47a70194fabeea66) * Re-do PR #14685 for alt-text inventories. (#15394) (cherry picked from commit 6d0c47fdd0f0ca00c06afb5db5bd49c8da995a50) * Docs: add Communication guide (#15469) * Docs: add Communication guide * Update docs/docsite/rst/contributor/communication.rst Co-authored-by: Don Naro <dnaro@redhat.com> * Update docs/docsite/rst/contributor/communication.rst --------- Co-authored-by: Don Naro <dnaro@redhat.com> (cherry picked from commit 79c1921ea480ae26b0d7faf6e1a8e89b61f76c30) --------- Co-authored-by: Don Naro <dnaro@redhat.com> Co-authored-by: TVo <thavo@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
This commit is contained in:
parent
94e5795dfc
commit
8c4be1c529
2
.github/triage_replies.md
vendored
2
.github/triage_replies.md
vendored
@ -1,7 +1,7 @@
|
||||
## General
|
||||
- For the roundup of all the different mailing lists available from AWX, Ansible, and beyond visit: https://docs.ansible.com/ansible/latest/community/communication.html
|
||||
- Hello, we think your question is answered in our FAQ. Does this: https://www.ansible.com/products/awx-project/faq cover your question?
|
||||
- You can find the latest documentation here: https://docs.ansible.com/automation-controller/latest/html/userguide/index.html
|
||||
- You can find the latest documentation here: https://ansible.readthedocs.io/projects/awx/en/latest/userguide/index.html
|
||||
|
||||
|
||||
|
||||
|
||||
@ -35,7 +35,4 @@ We ask all of our community members and contributors to adhere to the [Ansible c
|
||||
Get Involved
|
||||
------------
|
||||
|
||||
We welcome your feedback and ideas. Here's how to reach us with feedback and questions:
|
||||
|
||||
- Join the [Ansible AWX channel on Matrix](https://matrix.to/#/#awx:ansible.com)
|
||||
- Join the [Ansible Community Forum](https://forum.ansible.com)
|
||||
We welcome your feedback and ideas. See the [AWX Communication guide](https://ansible.readthedocs.io/projects/awx/en/latest/contributor/communication.html) to learn how to join the conversation.
|
||||
|
||||
@ -32,7 +32,7 @@ Installing the `tar.gz` involves no special instructions.
|
||||
## Running
|
||||
|
||||
Non-deprecated modules in this collection have no Python requirements, but
|
||||
may require the official [AWX CLI](https://docs.ansible.com/ansible-tower/latest/html/towercli/index.html)
|
||||
may require the official [AWX CLI](https://pypi.org/project/awxkit/)
|
||||
in the future. The `DOCUMENTATION` for each module will report this.
|
||||
|
||||
You can specify authentication by a combination of either:
|
||||
@ -41,8 +41,7 @@ You can specify authentication by a combination of either:
|
||||
- host, OAuth2 token
|
||||
|
||||
The OAuth2 token is the preferred method. You can obtain a token via the
|
||||
AWX CLI [login](https://docs.ansible.com/ansible-tower/latest/html/towercli/reference.html#awx-login)
|
||||
command.
|
||||
``login`` command with the AWX CLI.
|
||||
|
||||
These can be specified via (from highest to lowest precedence):
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ requirements:
|
||||
- None
|
||||
description:
|
||||
- Returns GET requests from the Automation Platform Controller API. See
|
||||
U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage.
|
||||
U(https://docs.ansible.com/automation-controller/latest/html/towerapi/) for API usage.
|
||||
- For use that is cross-compatible between the awx.awx and ansible.controller collection
|
||||
see the controller_meta module
|
||||
options:
|
||||
|
||||
@ -16,9 +16,9 @@ DOCUMENTATION = '''
|
||||
---
|
||||
module: job_template
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
short_description: create, update, or destroy Automation Platform Controller job templates.
|
||||
short_description: create, update, or destroy job templates.
|
||||
description:
|
||||
- Create, update, or destroy Automation Platform Controller job templates. See
|
||||
- Create, update, or destroy job templates. See
|
||||
U(https://www.ansible.com/tower) for an overview.
|
||||
options:
|
||||
name:
|
||||
@ -320,8 +320,8 @@ extends_documentation_fragment: awx.awx.auth
|
||||
|
||||
notes:
|
||||
- JSON for survey_spec can be found in the API Documentation. See
|
||||
U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/api_ref.html#/Job_Templates/Job_Templates_job_templates_survey_spec_create)
|
||||
for POST operation payload example.
|
||||
U(https://docs.ansible.com/automation-controller/latest/html/towerapi)
|
||||
for job template survey creation and POST operation payload example.
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ This collection should be installed from [Content Hub](https://cloud.redhat.com/
|
||||
## Running
|
||||
|
||||
Non-deprecated modules in this collection have no Python requirements, but
|
||||
may require the official [AWX CLI](https://docs.ansible.com/ansible-tower/latest/html/towercli/index.html)
|
||||
may require the AWX CLI
|
||||
in the future. The `DOCUMENTATION` for each module will report this.
|
||||
|
||||
You can specify authentication by a combination of either:
|
||||
@ -46,8 +46,7 @@ You can specify authentication by a combination of either:
|
||||
- host, OAuth2 token
|
||||
|
||||
The OAuth2 token is the preferred method. You can obtain a token via the
|
||||
AWX CLI [login](https://docs.ansible.com/ansible-tower/latest/html/towercli/reference.html#awx-login)
|
||||
command.
|
||||
``login`` command with the AWX CLI.
|
||||
|
||||
These can be specified via (from highest to lowest precedence):
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ The Lightweight Directory Access Protocol (LDAP) is an open, vendor-neutral, ind
|
||||
|
||||
# Configure LDAP Authentication
|
||||
|
||||
Please see the [Tower documentation](https://docs.ansible.com/ansible-tower/latest/html/administration/ldap_auth.html) as well as [Ansible blog post](https://www.ansible.com/blog/getting-started-ldap-authentication-in-ansible-tower) for basic LDAP configuration.
|
||||
Please see the [AWX documentation](https://ansible.readthedocs.io/projects/awx/en/latest/administration/ldap_auth.html) for basic LDAP configuration.
|
||||
|
||||
LDAP Authentication provides duplicate sets of configuration fields for authentication with up to six different LDAP servers.
|
||||
The default set of configuration fields take the form `AUTH_LDAP_<field name>`. Configuration fields for additional LDAP servers are numbered `AUTH_LDAP_<n>_<field name>`.
|
||||
|
||||
@ -3,7 +3,7 @@ Security Assertion Markup Language, or SAML, is an open standard for exchanging
|
||||
|
||||
|
||||
# Configure SAML Authentication
|
||||
Please see the [Tower documentation](https://docs.ansible.com/ansible-tower/latest/html/administration/ent_auth.html#saml-authentication-settings) as well as the [Ansible blog post](https://www.ansible.com/blog/using-saml-with-red-hat-ansible-tower) for basic SAML configuration. Note that AWX's SAML implementation relies on `python-social-auth` which uses `python-saml`. AWX exposes three fields which are directly passed to the lower libraries:
|
||||
Please see the [AWX documentation](https://ansible.readthedocs.io/projects/awx/en/latest/administration/ent_auth.html#saml-settings) for basic SAML configuration. Note that AWX's SAML implementation relies on `python-social-auth` which uses `python-saml`. AWX exposes three fields which are directly passed to the lower libraries:
|
||||
* `SOCIAL_AUTH_SAML_SP_EXTRA` is passed to the `python-saml` library configuration's `sp` setting.
|
||||
* `SOCIAL_AUTH_SAML_SECURITY_CONFIG` is passed to the `python-saml` library configuration's `security` setting.
|
||||
* `SOCIAL_AUTH_SAML_EXTRA_DATA`
|
||||
|
||||
@ -71,8 +71,8 @@ rst_epilog = """
|
||||
.. |aap| replace:: Ansible Automation Platform
|
||||
.. |ab| replace:: ansible-builder
|
||||
.. |ap| replace:: Automation Platform
|
||||
.. |at| replace:: automation controller
|
||||
.. |At| replace:: Automation controller
|
||||
.. |at| replace:: AWX
|
||||
.. |At| replace:: AWX
|
||||
.. |ah| replace:: Automation Hub
|
||||
.. |EE| replace:: Execution Environment
|
||||
.. |EEs| replace:: Execution Environments
|
||||
|
||||
@ -23,7 +23,6 @@ Authentication
|
||||
.. index::
|
||||
single: social authentication
|
||||
single: authentication
|
||||
single: enterprise authentication
|
||||
pair: configuration; authentication
|
||||
|
||||
.. include:: ./configure_awx_authentication.rst
|
||||
|
||||
@ -13,10 +13,7 @@ Likewise content in this guide can be removed or replaced if it applies to funct
|
||||
|
||||
**Join us online**
|
||||
|
||||
We talk about AWX documentation on Matrix at `#docs:ansible.im <https://matrix.to/#/#docs:ansible.im>`_ and on libera IRC at ``#ansible-docs`` if you ever want to join us and chat about the docs!
|
||||
|
||||
You can also find lots of AWX discussion and get answers to questions at `forum.ansible.com <https://forum.ansible.com/>`_.
|
||||
|
||||
Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@ -18,7 +18,7 @@ For example, if you uploaded a specific logo, and added the following text:
|
||||
:alt: Edit User Interface Settings form populated with custom text and logo.
|
||||
|
||||
|
||||
The Tower login dialog would look like this:
|
||||
The AWX login dialog would look like this:
|
||||
|
||||
.. image:: ../common/images/configure-awx-ui-angry-spud-login.png
|
||||
:alt: AWX login screen with custom text and logo.
|
||||
|
||||
39
docs/docsite/rst/contributor/communication.rst
Normal file
39
docs/docsite/rst/contributor/communication.rst
Normal file
@ -0,0 +1,39 @@
|
||||
.. _communication:
|
||||
|
||||
Communication
|
||||
=============
|
||||
|
||||
We welcome your feedback, questions and ideas. Here's how to reach the community.
|
||||
|
||||
.. _code_of_conduct:
|
||||
|
||||
Code of Conduct
|
||||
---------------
|
||||
|
||||
All communication and interactions in the Ansible Community are governed by our :ref:`code_of_conduct`. Please read and abide by it!
|
||||
Reach out to our community team at `codeofconduct@ansible.com <mailto:codeofconduct@ansible.com>`_ if you have any questions or need assistance.
|
||||
|
||||
.. _forum:
|
||||
|
||||
Forum
|
||||
-----
|
||||
|
||||
Join the `Ansible Forum <https://forum.ansible.com>`_ as a single starting point and our default communication platform for questions and help, development discussions, events, and much more. `Register <https://forum.ansible.com/signup?>`_ to join the community. Search by categories and tags to find interesting topics or start a new one; subscribe only to topics you need!
|
||||
|
||||
* `Get Help <https://forum.ansible.com/c/help/6>`_: get help or help others. Please add appropriate tags if you start new discussions, for example `awx`, `ee`, and `documentation`.
|
||||
* `Posts tagged with 'awx' <https://forum.ansible.com/tag/awx>`_: subscribe to participate in project/technology-related conversations. There are other related tags in the forum you can use.
|
||||
* `Bullhorn newsletter <https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn>`_: used to announce releases and important changes.
|
||||
* `Social Spaces <https://forum.ansible.com/c/chat/4>`_: gather and interact with fellow enthusiasts.
|
||||
* `News & Announcements <https://forum.ansible.com/c/news/5>`_: track project-wide announcements including social events.
|
||||
|
||||
For more information on the forum navigation, see `Navigating the Ansible forum <https://forum.ansible.com/t/navigating-the-ansible-forum-tags-categories-and-concepts/39>`_ post.
|
||||
|
||||
Matrix
|
||||
------
|
||||
|
||||
For real-time interactions, conversations in the AWX community happen over the Matrix protocol in the following channels:
|
||||
|
||||
* `#awx:ansible.com <https://matrix.to/#/#awx:ansible.com>`_: AWX project-related discussions.
|
||||
* `#docs:ansible.im <https://matrix.to/#/#docs:ansible.im>`_: Ansible and AWX documentation-related discussions.
|
||||
|
||||
For more information, see the community-hosted `Matrix FAQ <https://hackmd.io/@ansible-community/community-matrix-faq>`_.
|
||||
@ -10,13 +10,14 @@ There are so many ways you can contribute to AWX.
|
||||
|
||||
**Join us online**
|
||||
|
||||
You can chat with us and ask questions on Matrix at `#awx:ansible.com <https://matrix.to/#/#awx:ansible.com>`_ or visit the `Ansible Community Forum <https://forum.ansible.com/c/project/7/>`_ to find contributor resources.
|
||||
Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:numbered:
|
||||
|
||||
intro
|
||||
communication
|
||||
setting_up
|
||||
work_items
|
||||
report_issues
|
||||
report_issues
|
||||
|
||||
@ -4,6 +4,4 @@ Introduction
|
||||
|
||||
Hi there! We're excited to have you as a contributor.
|
||||
|
||||
Have questions about this document or anything not covered here? Come chat with us and ask questions on Matrix at `#awx:ansible.com <https://matrix.to/#/#awx:ansible.com>`_.
|
||||
|
||||
Also visit the `Ansible Community Forum <https://forum.ansible.com/c/project/7/>`_ to find contributor resources where you can also submit your questions or concerns.
|
||||
Get started with joining the community! See the :ref:`Communication guide<communication>` to learn how.
|
||||
|
||||
@ -9,14 +9,13 @@ as possible. Version information, and an accurate reproducing scenario are criti
|
||||
|
||||
Be sure to attach the ``component:docs`` label to your issue. These labels are determined by the template data. Please use the template and fill it out as accurately as possible.
|
||||
|
||||
Please don't use the issue tracker as a way to ask how to do something. Instead, discuss it on on the `Ansible Community Forum <https://forum.ansible.com/c/project/7/>`_, or you can chat with us and ask questions on Matrix at `#awx:ansible.com <https://matrix.to/#/#awx:ansible.com>`_.
|
||||
Please don't use the issue tracker as a way to ask how to do something. Instead, discuss it on on the Ansible Forum, or you can chat with us and ask questions on Matrix. See the :ref:`Communication guide<communication>` for details.
|
||||
|
||||
Before opening a new issue, please use the issue search feature to see if what you're experiencing has already been reported. If you have any extra detail to provide, please comment. Otherwise, rather than posting a "me too" comment, please consider giving it a `"thumbs up" <https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comment>`_ to give us an indication of the severity of the problem.
|
||||
|
||||
See `How issues are resolved <https://github.com/ansible/awx/blob/devel/ISSUES.md#how-issues-are-resolved>`_ for more information about the triaging and resolution process.
|
||||
|
||||
|
||||
Getting help
|
||||
-------------
|
||||
|
||||
If you require additional assistance, join the discussions on the `Ansible Community Forum <https://forum.ansible.com/c/project/7/>`_. Specify with tags ``#documentation`` and ``#awx`` to narrow down the area(s) of interest. For more information on tags, see `Navigating the Ansible forum — Tags, Categories, and Concepts <https://forum.ansible.com/t/navigating-the-ansible-forum-tags-categories-and-concepts/39>`_. You may also reach out to us and ask questions on Matrix at `#awx:ansible.com <https://matrix.to/#/#awx:ansible.com>`_.
|
||||
See the :ref:`Communication guide<communication>` to learn how to get help.
|
||||
|
||||
@ -18,19 +18,18 @@ Fixing and updating the documentation are always appreciated, so reviewing the b
|
||||
Things to know prior to submitting revisions
|
||||
----------------------------------------------
|
||||
|
||||
- Please follow the `Ansible code of conduct <http://docs.ansible.com/ansible/latest/community/code_of_conduct.html>`_ in all your interactions with the community.
|
||||
- All doc revisions or additions are done through pull requests against the ``devel`` branch.
|
||||
- You must use ``git commit --signoff`` for any commit to be merged, and agree that usage of ``--signoff`` constitutes agreement with the terms of `DCO 1.1 <https://github.com/ansible/awx/blob/devel/DCO_1_1.md>`_.
|
||||
- Take care to make sure no merge commits are in the submission, and use ``git rebase`` vs ``git merge`` for this reason.
|
||||
- If collaborating with someone else on the same branch, consider using ``--force-with-lease`` instead of ``--force``. This will prevent you from accidentally overwriting commits pushed by someone else. For more information, see `git push docs <https://git-scm.com/docs/git-push#git-push---force-with-leaseltrefnamegt>`_.
|
||||
- If submitting a large doc change, it's a good idea to join the `Ansible Community Forum <https://forum.ansible.com/c/project/7/>`_, and talk about what you would like to do or add first. Use the ``#documentation`` and ``#awx`` tags to help notify relevant people of the topic. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed. For more information on tags, see `Navigating the Ansible forum — Tags, Categories, and Concepts <https://forum.ansible.com/t/navigating-the-ansible-forum-tags-categories-and-concepts/39>`_.
|
||||
- We ask all of our community members and contributors to adhere to the `Ansible code of conduct <http://docs.ansible.com/ansible/latest/community/code_of_conduct.html>`_. If you have questions, or need assistance, please reach out to our community team at `codeofconduct@ansible.com <mailto:codeofconduct@ansible.com>`_.
|
||||
|
||||
- If submitting a large doc change, it's a good idea to join the :ref:`Ansible Forum<forum>`, and talk about what you would like to do or add first. Use the ``#documentation`` and ``#awx`` tags to help notify relevant people of the topic. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed.
|
||||
|
||||
.. Note::
|
||||
|
||||
- Issue assignment will only be done for maintainers of the project. If you decide to work on an issue, please feel free to add a comment in the issue to let others know that you are working on it; but know that we will accept the first pull request from whomever is able to fix an issue. Once your PR is accepted we can add you as an assignee to an issue upon request.
|
||||
|
||||
- If you work in a part of the docs that is going through active development, your changes may be rejected, or you may be asked to `rebase`. A good idea before starting work is to have a discussion with us and ask questions on Matrix at `#awx:ansible.com <https://matrix.to/#/#awx:ansible.com>`_ or discuss your ideas on the `Ansible Community Forum <https://forum.ansible.com/c/project/7/>`_.
|
||||
- If you work in a part of the docs that is going through active development, your changes may be rejected, or you may be asked to `rebase`. A good idea before starting work is to have a :ref:`discussion with the community<communication>`.
|
||||
|
||||
- If you find an issue with the functions of the UI or API, please see the `Reporting Issues <https://github.com/ansible/awx/blob/devel/CONTRIBUTING.md#reporting-issues>`_ section to open an issue.
|
||||
|
||||
@ -40,6 +39,4 @@ Things to know prior to submitting revisions
|
||||
Translations
|
||||
-------------
|
||||
|
||||
At this time we do not accept PRs for adding additional language translations as we have an automated process for generating our translations. This is because translations require constant care as new strings are added and changed in the code base. Because of this the .po files are overwritten during every translation release cycle. We also can't support a lot of translations on AWX as its an open source project and each language adds time and cost to maintain. If you would like to see AWX translated into a new language please create an issue and ask others you know to upvote the issue. Our translation team will review the needs of the community and see what they can do around supporting additional language.
|
||||
|
||||
If you find an issue with an existing translation, please see the `Reporting Issues <https://github.com/ansible/awx/blob/devel/CONTRIBUTING.md#reporting-issues>`_ section to open an issue and our translation team will work with you on a resolution.
|
||||
At this time we do not accept PRs for language translations.
|
||||
|
||||
@ -9,7 +9,7 @@ An organization is a logical collection of users, teams, projects, and inventori
|
||||
From the left navigation bar, click **Organizations**.
|
||||
|
||||
.. note::
|
||||
AWX creates a default organization automatically. Users of Tower with a Self-support level license only have the
|
||||
AWX creates a default organization automatically.
|
||||
|
||||
|Organizations - default view|
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ You can manage playbooks and playbook directories by either placing them manuall
|
||||
|
||||
.. note::
|
||||
|
||||
It is recommended that, whenever possible, you use source control to manage your playbooks. This type of best practice provides the ability to treat your infrastructure as code and is in line with DevOps ideals. While this Quick Start Guide uses lightweight examples to get you up and running, we suggest using source control to manage playbook for production purposes.
|
||||
It is recommended that, whenever possible, you use source control to manage your playbooks. This type of best practice provides the ability to treat your infrastructure as code and is in line with DevOps ideals. While this Quick Start Guide uses lightweight examples to get you up and running, we suggest using source control to manage your actual playbooks.
|
||||
|
||||
To review existing projects, click **Projects** from the left navigation bar.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ Examine the AWX Dashboard
|
||||
pair: settings menu; help about
|
||||
|
||||
|
||||
The Dashboard offers a friendly graphical framework for your IT orchestration needs. Along the left side of the Dashboard is the navigation menu, where you can quickly display different views, navigate to your resources, grant access, and administer certain AWX features in the UI.
|
||||
The Dashboard offers a friendly graphical framework for your Ansible needs. Along the left side of the Dashboard is the navigation menu, where you can quickly display different views, navigate to your resources, grant access, and administer certain AWX features in the UI.
|
||||
|
||||
.. note::
|
||||
|
||||
@ -40,7 +40,7 @@ On the main Dashboard view, a summary appears listing your current **Job Status*
|
||||
|
||||
The very last item in the navigation bar is **Settings**, which provides access to the AWX configuration Settings.
|
||||
|
||||
The Settings page allows administrators to configure authentication, jobs, system-level attributes, customize the user interface, and product license information. Refer to :ref:`ag_configure_awx` section for more detail.
|
||||
The Settings page allows administrators to configure authentication, jobs, system-level attributes, and customize the user interface. Refer to :ref:`ag_configure_awx` section for more detail.
|
||||
|
||||
.. image:: ../common/images/ug-settings-menu-screen.png
|
||||
|
||||
@ -50,4 +50,4 @@ Regardless of the window or action you're performing, the very top of each page
|
||||
.. |about| image:: ../common/images/help-about-icon.png
|
||||
|
||||
.. note::
|
||||
Keep in mind that the goal of this Quick Start is to launch a simple playbook. To do this, a number of configuration options must be setup. Completing the quick start configuration tasks now ensures that tAWX is configured properly and allows for easier executions of more involved playbooks later on.
|
||||
Keep in mind that the goal of this Quick Start is to launch a simple playbook. To do this, a number of configuration options must be setup. Completing the quick start configuration tasks now ensures that AWX is configured properly and allows for easier executions of more involved playbooks later on.
|
||||
@ -12,9 +12,7 @@ Likewise content in this guide can be removed or replaced if it applies to funct
|
||||
|
||||
**Join us online**
|
||||
|
||||
We talk about AWX documentation on Matrix at `#docs:ansible.im <https://matrix.to/#/#docs:ansible.im>`_ and on libera IRC at ``#ansible-docs`` if you ever want to join us and chat about the docs!
|
||||
|
||||
You can also find lots of AWX discussion and get answers to questions at `forum.ansible.com <https://forum.ansible.com/>`_.
|
||||
Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@ -12,9 +12,7 @@ Likewise content in this guide can be removed or replaced if it applies to funct
|
||||
|
||||
**Join us online**
|
||||
|
||||
We talk about AWX documentation on Matrix at `#docs:ansible.im <https://matrix.to/#/#docs:ansible.im>`_ if you ever want to join us and chat about the docs!
|
||||
|
||||
You can also find lots of AWX discussion and get answers to questions on the `Ansible Community Forum <https://forum.ansible.com/c/project/7/>`_.
|
||||
Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@ -25,4 +23,4 @@ You can also find lots of AWX discussion and get answers to questions on the `An
|
||||
known_issues
|
||||
supported_locales
|
||||
|
||||
.. include:: ../common/copyright.rst
|
||||
.. include:: ../common/copyright.rst
|
||||
|
||||
@ -8,7 +8,7 @@ Authentication Methods Using the API
|
||||
pair: OAuth 2 Token; authentication
|
||||
pair: SSO; authentication
|
||||
|
||||
This chapter describes the numerous enterprise authentication methods, the best use case for each, and examples:
|
||||
This chapter describes different authentication methods, the best use case for each, and examples:
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
@ -12,9 +12,7 @@ Likewise content in this guide can be removed or replaced if it applies to funct
|
||||
|
||||
**Join us online**
|
||||
|
||||
We talk about AWX documentation on Matrix at `#docs:ansible.im <https://matrix.to/#/#docs:ansible.im>`_ and on libera IRC at ``#ansible-docs`` if you ever want to join us and chat about the docs!
|
||||
|
||||
You can also find lots of AWX discussion and get answers to questions at `forum.ansible.com <https://forum.ansible.com/>`_.
|
||||
Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@ -12,9 +12,7 @@ Likewise content in this guide can be removed or replaced if it applies to funct
|
||||
|
||||
**Join us online**
|
||||
|
||||
We talk about AWX documentation on Matrix at `#docs:ansible.im <https://matrix.to/#/#docs:ansible.im>`_ and on libera IRC at ``#ansible-docs`` if you ever want to join us and chat about the docs!
|
||||
|
||||
You can also find lots of AWX discussion and get answers to questions at `forum.ansible.com <https://forum.ansible.com/>`_.
|
||||
Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@ -13,9 +13,7 @@ Likewise content in this guide can be removed or replaced if it applies to funct
|
||||
|
||||
**Join us online**
|
||||
|
||||
We talk about AWX documentation on Matrix at `#docs:ansible.im <https://matrix.to/#/#docs:ansible.im>`_ and on libera IRC at ``#ansible-docs`` if you ever want to join us and chat about the docs!
|
||||
|
||||
You can also find lots of AWX discussion and get answers to questions at `forum.ansible.com <https://forum.ansible.com/>`_.
|
||||
Need help or want to discuss AWX including the documentation? See the :ref:`Communication guide<communication>` to learn how to join the conversation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@ -170,10 +170,13 @@ To use ``ansible_facts`` to define the host filter when creating Smart Inventori
|
||||
1. In the *Create new smart inventory screen*, click the |search| button next to the **Smart host filter** field to open a pop-up window to filter hosts for this inventory.
|
||||
|
||||
.. image:: ../common/images/inventories-smart-create-filter-highlighted.png
|
||||
:alt: Create smart inventory window with Smart host filter highlighted
|
||||
|
||||
|
||||
2. In the search pop-up window, change the search criteria from **Name** to **Advanced** and select **ansible_facts** from the **Key** field.
|
||||
|
||||
.. image:: ../common/images/inventories-smart-define-host-filter.png
|
||||
:alt: Host filter with drop-down menu options
|
||||
|
||||
|
||||
If you wanted to add an ansible fact of
|
||||
@ -186,24 +189,29 @@ If you wanted to add an ansible fact of
|
||||
In the search field, enter ``ansible_processor[]="GenuineIntel"`` (no extra spaces or ``__`` before the value) and press **[Enter]**.
|
||||
|
||||
.. image:: ../common/images/inventories-smart-define-host-filter-facts.png
|
||||
:alt: Example of an advanced search for host filter Ansible facts
|
||||
|
||||
The resulting search criteria for the specified ansible fact populates in the lower part of the window.
|
||||
|
||||
.. image:: ../common/images/inventories-smart-define-host-filter-facts2.png
|
||||
:alt: Selected search criteria for host filter Ansible facts listed below search field
|
||||
|
||||
3. Click **Select** to add it to the **Smart host filter** field.
|
||||
|
||||
.. image:: ../common/images/inventories-smart-create-filter-added.png
|
||||
:alt: Specified search criteria for host filter Ansible facts shown in the Smart host filter field of the Create new smart inventory window
|
||||
|
||||
4. Click **Save** to save the new Smart Inventory.
|
||||
|
||||
The Details tab of the new Smart Inventory opens and displays the specified ansible facts in the **Smart host filter** field.
|
||||
|
||||
.. image:: ../common/images/inventories-smart-create-details.png
|
||||
:alt: Details tab of the new Smart Inventory displaying the specified Ansible facts in the Smart host filter field
|
||||
|
||||
5. From the Details view, you can edit the **Smart host filter** field by clicking **Edit** and delete existing filter(s), clear all existing filters, or add new ones.
|
||||
|
||||
.. image:: ../common/images/inventories-smart-define-host-filter-facts-group.png
|
||||
:alt: Specified search criteria consisting of host filter Ansible facts and groups listed below search field
|
||||
|
||||
|
||||
.. _ug_inventories_constructed:
|
||||
@ -246,6 +254,7 @@ The hosts inside the input inventory will fit one condition, the other condition
|
||||
neither, or both. This results in four hosts total for demonstration purposes.
|
||||
|
||||
.. image:: ../common/images/inventories-constructed-inventory-venn.png
|
||||
:alt: Venn diagram describing the input inventory content for a constructed inventory
|
||||
|
||||
|
||||
This folder defines the inventory as an ini type named ``two_conditions.ini``:
|
||||
@ -459,7 +468,7 @@ Follow the procedure described in the subsequent section, :ref:`ug_inventories_a
|
||||
Example of a constructed inventory details view:
|
||||
|
||||
.. image:: ../common/images/inventories-constructed-inventory-details.png
|
||||
|
||||
:alt: Constructed inventory details
|
||||
|
||||
|
||||
.. _ug_inventories_plugins:
|
||||
@ -517,6 +526,7 @@ The type of inventory is identified at the top of the create form.
|
||||
|Inventories_create_new - create new inventory|
|
||||
|
||||
.. |Inventories_create_new - create new inventory| image:: ../common/images/inventories-create-new-inventory.png
|
||||
:alt: Create new inventory form
|
||||
|
||||
2. Enter the appropriate details into the following fields:
|
||||
|
||||
@ -530,6 +540,7 @@ The type of inventory is identified at the top of the create form.
|
||||
- **Instance Groups**: Click the |search| button to open a separate window. Choose the instance group(s) for this inventory to run on. If the list is extensive, use the search to narrow the options. You may select multiple instance groups and sort them in the order you want them ran.
|
||||
|
||||
.. image:: ../common/images/select-instance-groups-modal.png
|
||||
:alt: Select instance groups dialog
|
||||
|
||||
- **Labels**: Optionally supply labels that describe this inventory, so they can be used to group and filter inventories and jobs.
|
||||
|
||||
@ -561,6 +572,7 @@ The type of inventory is identified at the top of the create form.
|
||||
|Inventories_create_new_saved - create new inventory|
|
||||
|
||||
.. |Inventories_create_new_saved - create new inventory| image:: ../common/images/inventories-create-new-saved-inventory.png
|
||||
:alt: Example Create new inventory form filled out
|
||||
|
||||
3. Click **Save** when done.
|
||||
|
||||
@ -604,6 +616,7 @@ To create a new group for an inventory:
|
||||
|Inventories_manage_group_add|
|
||||
|
||||
.. |Inventories_manage_group_add| image:: ../common/images/inventories-add-group-new.png
|
||||
:alt: Create new group form for inventories
|
||||
|
||||
2. Enter the appropriate details into the required and optional fields:
|
||||
|
||||
@ -636,12 +649,16 @@ The **Create Group** window closes and the newly created group displays as an en
|
||||
|Inventories add group subgroup|
|
||||
|
||||
.. |Inventories add group subgroup| image:: ../common/images/inventories-add-group-subgroup-added.png
|
||||
:alt: Related Groups tab of the Groups form for inventories
|
||||
|
||||
|
||||
If you chose to add an existing group, available groups will appear in a separate selection window.
|
||||
|
||||
|Inventories add group existing subgroup|
|
||||
|
||||
.. |Inventories add group existing subgroup| image:: ../common/images/inventories-add-group-existing-subgroup.png
|
||||
:alt: Existing group appearing in a separate selection window
|
||||
|
||||
|
||||
Once a group is selected, it displays as an entry in the list of groups associated with the group.
|
||||
|
||||
@ -657,6 +674,7 @@ The list view displays all your inventory groups at once, or you can filter it t
|
||||
You may be able to delete a subgroup without concern for dependencies, since AWX will look for dependencies such as any child groups or hosts. If any exists, a confirmation dialog displays for you to choose whether to delete the root group and all of its subgroups and hosts; or promote the subgroup(s) so they become the top-level inventory group(s), along with their host(s).
|
||||
|
||||
.. image:: ../common/images/inventories-groups-delete-root-with-children.png
|
||||
:alt: Delete group confirmation dialog box with a prompt to select whether to delete all groups and hosts or promote child groups and hosts
|
||||
|
||||
.. _ug_inventories_add_host:
|
||||
|
||||
@ -672,6 +690,8 @@ You can configure hosts for the inventory as well as for groups and groups withi
|
||||
3. If creating a new host, select the |toggle button| button to specify whether or not to include this host while running jobs.
|
||||
|
||||
.. |toggle button| image:: ../common/images/on-off-toggle-button.png
|
||||
:alt: Toggle button to include this host while running jobs
|
||||
|
||||
|
||||
4. Enter the appropriate details into the required and optional fields:
|
||||
|
||||
@ -686,12 +706,16 @@ The **Create Host** window closes and the newly created host displays as an entr
|
||||
|Inventories add group host|
|
||||
|
||||
.. |Inventories add group host| image:: ../common/images/inventories-add-group-host-added.png
|
||||
:alt: Hosts tab of the Groups window showing available hosts
|
||||
|
||||
|
||||
If you chose to add an existing host, available hosts will appear in a separate selection window.
|
||||
|
||||
|Inventories add existing host|
|
||||
|
||||
.. |Inventories add existing host| image:: ../common/images/inventories-add-existing-host.png
|
||||
:alt: Existing host appearing in a separate selection window
|
||||
|
||||
|
||||
Once a host is selected, it displays as an entry in the list of hosts associated with the group. You can disassociate a host from this screen by selecting the host and click the **Disassociate** button.
|
||||
|
||||
@ -706,12 +730,16 @@ list of hosts.
|
||||
|Inventories add group host emphasized|
|
||||
|
||||
.. |Inventories add group host emphasized| image:: ../common/images/inventories-add-group-host-added-emphasized.png
|
||||
:alt: Inventories add host emphasized
|
||||
|
||||
|
||||
This opens the Details tab of the selected host.
|
||||
|
||||
|Inventories add group host details|
|
||||
|
||||
.. |Inventories add group host details| image:: ../common/images/inventories-add-group-host-details.png
|
||||
:alt: Host details tab for the selected inventory
|
||||
|
||||
|
||||
7. Click the **Groups** tab to configure groups for the host.
|
||||
|
||||
@ -720,6 +748,7 @@ This opens the Details tab of the selected host.
|
||||
Available groups appear in a separate selection window.
|
||||
|
||||
.. image:: ../common/images/inventories-add-group-hosts-add-groups.png
|
||||
:alt: Select Groups dialog showing two available groups
|
||||
|
||||
b. Click to select the group(s) to associate with the host and click **Save**.
|
||||
|
||||
@ -728,13 +757,14 @@ This opens the Details tab of the selected host.
|
||||
8. If a host was used to run a job, you can view details about those jobs in the **Completed Jobs** tab of the host and click **Expanded** to view details about each job.
|
||||
|
||||
.. image:: ../common/images/inventories-add-host-view-completed-jobs.png
|
||||
:alt: Jobs tab showing list of completed jobs associated with the selected host
|
||||
|
||||
|
||||
.. _ug_inventories_add_host_bulk_api:
|
||||
|
||||
.. note::
|
||||
|
||||
You may create hosts in bulk using the newly added endpoint in the API, ``/api/v2/bulk/host_create``. This endpoint accepts JSON and you can specify the target inventory and a list of hosts to add to the inventory. These hosts must be unique within the inventory. Either all hosts are added, or 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 `Bulk endpoint <https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|.
|
||||
You may create hosts in bulk using the newly added endpoint in the API, ``/api/v2/bulk/host_create``. This endpoint accepts JSON and you can specify the target inventory and a list of hosts to add to the inventory. These hosts must be unique within the inventory. Either all hosts are added, or 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 `Bulk endpoint <https://ansible.readthedocs.io/projects/awx/en/latest/rest_api/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|.
|
||||
|
||||
.. _ug_inventories_add_source:
|
||||
|
||||
@ -752,6 +782,7 @@ This opens the Create Source window.
|
||||
|Inventories create source|
|
||||
|
||||
.. |Inventories create source| image:: ../common/images/inventories-create-source.png
|
||||
:alt: Create new source form for inventory source
|
||||
|
||||
|
||||
3. Enter the appropriate details into the required and optional fields:
|
||||
@ -818,6 +849,7 @@ This opens the Create Source window.
|
||||
The **Notifications** tab is only present after you save the newly-created source.
|
||||
|
||||
.. image:: ../common/images/inventories-create-source-with-notifications-tab.png
|
||||
:alt: Notification tab for the inventory source
|
||||
|
||||
12. To configure notifications for the source, click the **Notifications** tab.
|
||||
|
||||
@ -833,6 +865,7 @@ Once a source is defined, it displays as an entry in the list of sources associa
|
||||
|Inventories view sources|
|
||||
|
||||
.. |Inventories view sources| image:: ../common/images/inventories-view-sources.png
|
||||
:alt: Sources tab of the inventory showing one inventory source
|
||||
|
||||
|
||||
.. _ug_inventory_sources:
|
||||
@ -862,12 +895,14 @@ An inventory that is sourced from a project means that is uses the SCM type from
|
||||
This field only displays if the sourced project has the **Allow Branch Override** option checked:
|
||||
|
||||
.. image:: ../common/images/projects-create-scm-project-branch-override-checked.png
|
||||
:alt: Inventory sourced from a project with SCM project branch override checked
|
||||
|
||||
- **Credential**: Optionally specify the credential to use for this source.
|
||||
- **Project**: Required. Pre-populates with a default project, otherwise, specify the project this inventory is using as its source. Click the |search| button to choose from a list of projects. If the list is extensive, use the search to narrow the options.
|
||||
- **Inventory File**: Required. Select an inventory file associated with the sourced project. If not already populated, you can type it into the text field within the drop down menu to filter the extraneous file types. In addition to a flat file inventory, you can point to a directory or an inventory script.
|
||||
|
||||
.. image:: ../common/images/inventories-create-source-sourced-from-project-filter.png
|
||||
:alt: Inventory file field of the Sourced from a project inventory type
|
||||
|
||||
3. You can optionally specify the verbosity, host filter, enabled variable/value, and update options as described in the main procedure for :ref:`adding a source <ug_add_inv_common_fields>`.
|
||||
|
||||
@ -903,6 +938,8 @@ Amazon Web Services EC2
|
||||
|Inventories - create source - AWS EC2 example|
|
||||
|
||||
.. |Inventories - create source - AWS EC2 example| image:: ../common/images/inventories-create-source-AWS-example.png
|
||||
:alt: Inventories create source AWS example
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
@ -923,6 +960,7 @@ Google Compute Engine
|
||||
|Inventories - create source - GCE example|
|
||||
|
||||
.. |Inventories - create source - GCE example| image:: ../common/images/inventories-create-source-GCE-example.png
|
||||
:alt: Inventories create source Google compute engine example
|
||||
|
||||
3. You can optionally specify the verbosity, host filter, enabled variable/value, and update options as described in the main procedure for :ref:`adding a source <ug_add_inv_common_fields>`.
|
||||
|
||||
@ -948,7 +986,7 @@ Microsoft Azure Resource Manager
|
||||
|Inventories - create source - Azure RM example|
|
||||
|
||||
.. |Inventories - create source - Azure RM example| image:: ../common/images/inventories-create-source-azurerm-example.png
|
||||
|
||||
:alt: Inventories create source Azure example
|
||||
|
||||
.. _ug_source_vmvcenter:
|
||||
|
||||
@ -973,7 +1011,7 @@ VMware vCenter
|
||||
|Inventories - create source - VMware example|
|
||||
|
||||
.. |Inventories - create source - VMWare example| image:: ../common/images/inventories-create-source-vmware-example.png
|
||||
|
||||
:alt: Inventories create source VMWare example
|
||||
|
||||
.. _ug_source_satellite:
|
||||
|
||||
@ -995,6 +1033,7 @@ Red Hat Satellite 6
|
||||
|Inventories - create source - RH Satellite example|
|
||||
|
||||
.. |Inventories - create source - RH Satellite example| image:: ../common/images/inventories-create-source-rhsat6-example.png
|
||||
:alt: Inventories create source Red Hat Satellite example
|
||||
|
||||
If you encounter an issue with AWX inventory not having the "related groups" from Satellite, you might need to define these variables in the inventory source. See the inventory plugins template example for :ref:`ir_plugin_satellite` in the |atir| for detail.
|
||||
|
||||
@ -1019,7 +1058,7 @@ Red Hat Insights
|
||||
|Inventories - create source - RH Insights example|
|
||||
|
||||
.. |Inventories - create source - RH Insights example| image:: ../common/images/inventories-create-source-insights-example.png
|
||||
|
||||
:alt: Inventories create source Red Hat Insights example
|
||||
|
||||
.. _ug_source_openstack:
|
||||
|
||||
@ -1041,7 +1080,7 @@ OpenStack
|
||||
|Inventories - create source - OpenStack example|
|
||||
|
||||
.. |Inventories - create source - OpenStack example| image:: ../common/images/inventories-create-source-openstack-example.png
|
||||
|
||||
:alt: Inventories create source OpenStack example
|
||||
|
||||
.. _ug_source_rhv:
|
||||
|
||||
@ -1062,6 +1101,8 @@ Red Hat Virtualization
|
||||
|Inventories - create source - RHV example|
|
||||
|
||||
.. |Inventories - create source - RHV example| image:: ../common/images/inventories-create-source-rhv-example.png
|
||||
:alt: Inventories create source Red Hat Virtualization example
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
@ -1083,6 +1124,7 @@ Red Hat Ansible Automation Platform
|
||||
3. You can optionally specify the verbosity, host filter, enabled variable/value, and update options as described in the main procedure for :ref:`adding a source <ug_add_inv_common_fields>`.
|
||||
|
||||
.. image:: ../common/images/inventories-create-source-rhaap-example.png
|
||||
:alt: Inventories create source Red Hat Ansible Automation Platform example
|
||||
|
||||
4. Use the **Source Variables** field to override variables used by the ``controller`` inventory plugin. Enter variables using either JSON or YAML syntax. Use the radio button to toggle between the two.
|
||||
|
||||
@ -1117,6 +1159,7 @@ This inventory source uses the `terraform_state <https://github.com/ansible-coll
|
||||
5. Enter an |ee| in the **Execution Environment** field that contains a Terraform binary. This is required for the inventory plugin to run the Terraform commands that read inventory data from the Terraform state file. Refer to the `Terraform EE readme <https://github.com/ansible-cloud/terraform_ee>`_ that contains an example |ee| configuration with a Terraform binary.
|
||||
|
||||
.. image:: ../common/images/inventories-create-source-terraform-example.png
|
||||
:alt: Inventories create source Terraform example
|
||||
|
||||
6. To add hosts for AWS EC2, GCE, and Azure instances, the Terraform state file in the backend must contain state for resources already deployed to EC2, GCE, or Azure. Refer to each of the Terraform providers' respective documentation to provision instances.
|
||||
|
||||
@ -1152,6 +1195,7 @@ This inventory source uses a cluster that is able to deploy OpenShift (OCP) virt
|
||||
|
||||
|
||||
.. image:: ../common/images/inventories-create-source-ocpvirt-example.png
|
||||
:alt: Inventories create source OpenShift virtualization example
|
||||
|
||||
5. Save the configuration and click the **Sync** button to sync the inventory.
|
||||
|
||||
@ -1233,10 +1277,7 @@ If an inventory was used to run a job, you can view details about those jobs in
|
||||
|Inventories view completed jobs|
|
||||
|
||||
.. |Inventories view completed jobs| image:: ../common/images/inventories-view-completed-jobs.png
|
||||
|
||||
|
||||
|
||||
|
||||
:alt: Inventories view completed jobs
|
||||
|
||||
.. _ug_inventories_run_ad_hoc:
|
||||
|
||||
@ -1255,12 +1296,15 @@ To run an ad hoc command:
|
||||
|ad hoc-commands-inventory-home|
|
||||
|
||||
.. |ad hoc-commands-inventory-home| image:: ../common/images/inventories-add-group-host-added.png
|
||||
:alt: Ad hoc commands inventory home
|
||||
|
||||
|
||||
2. Click the **Run Command** button.
|
||||
|
||||
The Run command window opens.
|
||||
|
||||
.. image:: ../common/images/ad-hoc-run-execute-command.png
|
||||
:alt: Ad hoc run execute command
|
||||
|
||||
3. Enter the details for the following fields:
|
||||
|
||||
@ -1290,10 +1334,13 @@ The Run command window opens.
|
||||
|ad hoc-commands-inventory-run-command|
|
||||
|
||||
.. |ad hoc-commands-inventory-run-command| image:: ../common/images/ad-hoc-commands-inventory-run-command.png
|
||||
:alt: Ad hoc commands inventory run command
|
||||
|
||||
|
||||
4. Click **Next** to choose the |ee| you want the ad-hoc command to be run against.
|
||||
|
||||
.. image:: ../common/images/ad-hoc-commands-inventory-run-command-ee.png
|
||||
:alt: Ad hoc run command dialog prompting for Execution Environments with two listed to choose from
|
||||
|
||||
5. Click **Next** to choose the credential you want to use and click the **Launch** button.
|
||||
|
||||
@ -1303,3 +1350,5 @@ The results display in the **Output** tab of the module's job window.
|
||||
|ad hoc-commands-inventory-results-example|
|
||||
|
||||
.. |ad hoc-commands-inventory-results-example| image:: ../common/images/ad-hoc-commands-inventory-results-example.png
|
||||
:alt: Ad hoc commands inventory results example
|
||||
|
||||
|
||||
@ -473,7 +473,7 @@ When slice jobs are running, job lists display the workflow and job slices, as w
|
||||
|
||||
.. note::
|
||||
|
||||
You may launch jobs in bulk using the newly added endpoint in the API, ``/api/v2/bulk/job_launch``. This endpoint accepts JSON and you can specify a list of unified job templates (such as job templates, project updates, etc) to launch. The user must have the appropriate permission to launch all the jobs. Either all jobs are launched, or 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 `Bulk endpoint <https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|.
|
||||
You may launch jobs in bulk using the newly added endpoint in the API, ``/api/v2/bulk/job_launch``. This endpoint accepts JSON and you can specify a list of unified job templates (such as job templates, project updates, etc) to launch. The user must have the appropriate permission to launch all the jobs. Either all jobs are launched, or 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 `Bulk endpoint <https://ansible.readthedocs.io/projects/awx/en/latest/rest_api/api_ref.html#/Bulk>`_ of the *Reference* section of the |atapi|.
|
||||
|
||||
|
||||
Copy a Job Template
|
||||
|
||||
@ -189,7 +189,7 @@ Authentication Enhancements
|
||||
pair: features; authentication
|
||||
pair: features; OAuth 2 token
|
||||
|
||||
AWX supports LDAP, SAML, token-based authentication. Enhanced LDAP and SAML support allows you to integrate your enterprise account information in a more flexible manner. Token-based Authentication allows for easily authentication of third-party tools and services with AWX via integrated OAuth 2 token support.
|
||||
AWX supports LDAP, SAML, token-based authentication. Enhanced LDAP and SAML support allows you to integrate your account information in a more flexible manner. Token-based Authentication allows for easily authentication of third-party tools and services with AWX via integrated OAuth 2 token support.
|
||||
|
||||
Cluster Management
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
@ -240,9 +240,8 @@ Job Distribution
|
||||
pair: features; jobs, slicing
|
||||
pair: features; jobs, distribution
|
||||
|
||||
As automation moves enterprise-wide, the need to automate at scale grows. AWX offer the ability to take a fact gathering or
|
||||
configuration job running across thousands of machines and slice it into individual job slices that can be distributed across your AWX cluster for increased reliability, faster job completion, and better cluster utilization. If you need to change a parameter across 15,000 switches at
|
||||
scale, or gather information across your multi-thousand-node RHEL estate, you can now do so easily.
|
||||
AWX offers the ability to take a fact gathering or configuration job running across thousands of machines and slice it into individual job slices that can be distributed across your AWX cluster for increased reliability, faster job completion, and better cluster utilization.
|
||||
If you need to change a parameter across 15,000 switches at scale, or gather information across your multi-thousand-node RHEL estate, you can now do so easily.
|
||||
|
||||
|
||||
Support for deployment in a FIPS-enabled environment
|
||||
|
||||
@ -21,7 +21,7 @@ DAB RBAC
|
||||
single: roles
|
||||
pair: DAB; RBAC
|
||||
|
||||
This section describes the latest changes to RBAC, involving use of the ``django-ansible-base`` (DAB) library, to enhance existing roles, provide a uniformed model that is compatible with platform (enterprise) components, and allow creation of custom roles. However, the internals of the system in the backend have changes implemented, but they are not reflected yet in the AWX UI. The change to the backend maintains a compatibility layer so the “old” roles in the API still exists temporarily, until a fully-functional compatible UI replaces the existing roles.
|
||||
This section describes the latest changes to RBAC, involving use of the ``django-ansible-base`` (DAB) library, to enhance existing roles, and allow creation of custom roles. However, the internals of the system in the backend have changes implemented, but they are not reflected yet in the AWX UI. The change to the backend maintains a compatibility layer so the “old” roles in the API still exists temporarily, until a fully-functional compatible UI replaces the existing roles.
|
||||
|
||||
New functionality, specifically custom roles, are possible through direct API clients or the API browser, but the presentation in the AWX UI might not reflect the changes made in the API.
|
||||
|
||||
|
||||
@ -187,14 +187,14 @@ This task spawns an `ansible` process, which then runs a command using Ansible.
|
||||
- Build a command line argument list for running Ansible, optionally using `ssh-agent` for public/private key authentication.
|
||||
- Return whether the task should use process isolation.
|
||||
|
||||
For more information on ad hoc commands, read the [Running Ad Hoc Commands section](https://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#running-ad-hoc-commands) of the Inventories page of the Ansible Tower User Guide.
|
||||
For more information on ad hoc commands, read the [Running Ad Hoc Commands section](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/inventories.html#running-ad-hoc-commands) of the Inventories chapter of _Automating with AWX_ guide.
|
||||
|
||||
|
||||
#### Run Job
|
||||
|
||||
This task is a definition and set of parameters for running `ansible-playbook` via a Job Template. It defines metadata about a given playbook run, such as a named identifier, an associated inventory to run against, the project and `.yml` playbook file to run, etc.
|
||||
|
||||
For more information, visit the [Jobs page](https://docs.ansible.com/ansible-tower/latest/html/userguide/jobs.html) of the Ansible Tower User Guide.
|
||||
For more information, visit the [Jobs chapter](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/jobs.html) of the _Automating with AWX_ guide.
|
||||
|
||||
|
||||
#### Run Project Update
|
||||
@ -203,7 +203,7 @@ When a Project Update is run in AWX, an `ansible-playbook` command is composed a
|
||||
|
||||
This task also includes a helper method to build SCM url and extra vars with parameters needed for authentication, as well as a method for returning search/replace strings to prevent output URLs from showing sensitive passwords.
|
||||
|
||||
To read more about this topic, visit the [Projects page](https://docs.ansible.com/ansible-tower/latest/html/userguide/projects.html) of the Ansible Tower User Guide.
|
||||
To read more about this topic, visit the [Projects chapter](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/projects.html) of the _Automating with AWX_ guide.
|
||||
|
||||
|
||||
#### Run Inventory Update
|
||||
@ -214,14 +214,14 @@ In older versions of AWX, the `INI` files were not exclusive for either specific
|
||||
|
||||
Additionally, inventory imports are run through a management command. Inventory in `args` get passed to that command, which results in it not being considered to be an Ansible inventory by Runner even though it is.
|
||||
|
||||
To read more about inventories, visit the [Inventories page](https://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html) of the Ansible Tower User Guide. For more detail about Runner, visit the [Ansible Runner Integration Overview](https://github.com/ansible/awx/blob/devel/docs/ansible_runner_integration.md) AWX documentation page.
|
||||
To read more about inventories, visit the [Inventories chapter](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/inventories.html) of the _Automating with AWX_ guide. For more detail about Runner, visit the [Ansible Runner Integration Overview](https://github.com/ansible/awx/blob/devel/docs/ansible_runner_integration.md) AWX documentation page.
|
||||
|
||||
|
||||
#### System Jobs
|
||||
|
||||
The main distinctive feature of a System Job (as compared to all other Unified Jobs) is that a system job runs management commands, which are given the highest priority for execution hierarchy purposes. They also implement a database lock while running, _i.e._, no other jobs can be run during that time on the same node. Additionally, they have a fixed fork impact of 5 vs 1.
|
||||
|
||||
You can read more about [Ansible Tower Capacity Determination and Job Impact](https://docs.ansible.com/ansible-tower/latest/html/userguide/jobs.html#at-capacity-determination-and-job-impact) in the Jobs section of the Ansible Tower User Guide.
|
||||
You can read more about [Ansible Tower Capacity Determination and Job Impact](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/jobs.html#awx-capacity-determination-and-job-impact) in the Jobs chapter of the _Automating with AWX_ guide.
|
||||
|
||||
|
||||
### Periodic Background Tasks
|
||||
@ -247,7 +247,7 @@ The `smart_inventories` field in AWX uses a membership lookup table that identif
|
||||
|
||||
An important thing to note is that this task is only run if the `AWX_REBUILD_SMART_MEMBERSHIP` is set to `True` (default is `False`).
|
||||
|
||||
For more information, visit the [Smart Inventories section](https://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#smart-inventories) of the Tower User Guide's "Inventory" page or the AWX documentation page [Inventory Refresh Overview page](https://github.com/ansible/awx/blob/devel/docs/inventory_refresh.md#inventory-changes) in this repo.
|
||||
For more information, visit the [Smart Inventories section](https://ansible.readthedocs.io/projects/awx/en/latest/userguide/inventories.html#smart-inventories) of the Inventories chapter of the _Automating with AWX_ guide.
|
||||
|
||||
|
||||
#### Deep Copy Model Object
|
||||
@ -277,7 +277,7 @@ This task allows the user to turn on a global profiler in their system, so that
|
||||
|
||||
The analytics collection `gather()` and `ship()` functions are called by an `awx-manage gather_analytics --ship` command, which runs on whichever instance it is invoked on. When these functions are called by Celery beat (currently at midnight local time), it is run on one `execution_node` by the Python in the AWX virtualenv.
|
||||
|
||||
For more details about analytics, please visit the [Usability Analytics and Data Collection](https://docs.ansible.com/ansible-tower/latest/html/administration/usability_data_collection.html) page.
|
||||
For more details about analytics, please visit the [Analytics gathering](https://ansible.readthedocs.io/projects/awx/en/latest/administration/awx-manage.html#analytics-gathering) section of the _Administering AWX Deployments_ guide.
|
||||
|
||||
|
||||
#### Run Administrative Checks
|
||||
@ -308,4 +308,4 @@ When a user creates a notification template in `/api/v2/notification_templates`,
|
||||
|
||||
Notifications assigned at certain levels will inherit traits defined on parent objects in different ways. For example, ad hoc commands will use notifications defined on the Organization that the inventory is associated with.
|
||||
|
||||
For more details on notifications, visit the [Notifications page](https://docs.ansible.com/ansible-tower/3.4.3/html/userguide/notifications.html) of the Tower user guide, or the AWX documentation on [Notification System Overview](https://github.com/ansible/awx/blob/devel/docs/notification_system.md) in this repository.
|
||||
For more details on notifications, visit the [Notifications chapter](hhttps://ansible.readthedocs.io/projects/awx/en/latest/userguide/notifications.html) of the _Automating with AWX_ guide.
|
||||
|
||||
@ -37,7 +37,7 @@ def post_webhook(file, webhook_key, url, verbose, event_type, insecure):
|
||||
|
||||
\b
|
||||
For setting up webhooks in AWX see:
|
||||
https://docs.ansible.com/ansible-tower/latest/html/userguide/webhooks.html
|
||||
https://ansible.readthedocs.io/projects/awx/en/latest/userguide/webhooks.html
|
||||
|
||||
\b
|
||||
Example usage for GitHub:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user