Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Added hop node information and beefed up exec nodes section. #14787

Merged
merged 17 commits into from Jan 27, 2024

Conversation

tvo318
Copy link
Member

@tvo318 tvo318 commented Jan 19, 2024

SUMMARY

Provides hop node coverage and better instructions on CAs and execution nodes. Addresses https://github.com/ansible/product-docs/issues/1872

Preview changes here:

ISSUE TYPE
  • New or Enhanced Feature
COMPONENT NAME
  • Docs
AWX VERSION

latest (but primarily introduced in 4.5)

ADDITIONAL INFORMATION

Original issue opened in https://github.com/ansible/product-docs/issues/1872 but changes are now being made in the AWX community docs moving forward.

Copy link
Member

@kialam kialam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@@ -51,8 +71,36 @@ Prerequisites
- To manage instances from the AWX user interface, you must have System Administrator or System Auditor permissions.


Using a custom Receptor CA
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be better to move this section lower, since it is optional. Maybe before or after the troubleshooting section

~~~~~~~~~~~~~~
--------------

- |rhel| (RHEL) operating system. Bring a machine online with a compatible Red Hat family OS (e.g. RHEL 8 and 9). This machines require a static IP, or a resolvable DNS hostname that the AWX cluster can access. If the ``listener_port`` is defined, the machine will also need an available open port on which to establish inbound TCP connections (e.g. 27199).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can mention that Debian 11 is also supported.


::

ansible-galaxy collection install -r requirements.yml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can drop this line, as we mention it below


- |rhel| (RHEL) or Debian operating system. Bring a machine online with a compatible Red Hat family OS (e.g. RHEL 8 and 9) or Debian 11. This machines require a static IP, or a resolvable DNS hostname that the AWX cluster can access. If the ``listener_port`` is defined, the machine will also need an available open port on which to establish inbound TCP connections (e.g. 27199).

In general, the more CPU cores and memory the machine has, the more jobs that can be scheduled to run on that machine at once. See :ref:`ug_job_concurrency` for more information on capacity.

- The system that is going to run the ``ansible-playbook`` requires the collection ``ansible.receptor`` to be installed:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- The system that is going to run the ``ansible-playbook`` requires the collection ``ansible.receptor`` to be installed:
- The system that is going to run the install bundle to setup the remote node requires the collection ``ansible.receptor`` to be installed:

@fosterseth
Copy link
Member

fosterseth commented Jan 26, 2024

also we can update the link to https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html#downloading-a-collection-for-offline-use

for downloading a collection for offline usage

and remove the automation hub verbage

@fosterseth
Copy link
Member

also remove section
"If you are using the default |ee| (provided with AWX) to run on remote execution nodes,"

@tvo318 tvo318 merged commit 266e31d into ansible:devel Jan 27, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants