Skip to content

Commit

Permalink
minor tower removals and replacements.
Browse files Browse the repository at this point in the history
  • Loading branch information
tvo318 committed Aug 31, 2023
1 parent d3d4998 commit 345e09a
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/docsite/rst/administration/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ AWX Administration
performance
secret_handling
security_best_practices
tower-manage
awx-manage
configure_awx
isolation_variables
oauth2_token_auth
Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/administration/tipsandtricks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Configuring the ``awxhost`` hostname for notifications
.. index::
pair: notifications; hostname configuration

In the :ref:`System Settings <configure_awx_system>`, you can replace ``https://towerhost`` in the **Base URL of the service** field with your preferred hostname to change the notification hostname.
In the :ref:`System Settings <configure_awx_system>`, you can replace ``https://awxhost`` in the **Base URL of the service** field with your preferred hostname to change the notification hostname.

.. image:: ../common/images/configure-awx-system-misc-baseurl.png

Expand Down
10 changes: 5 additions & 5 deletions docs/docsite/rst/administration/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ If you are unable to run the ``helloworld.yml`` example playbook from the Quick
Unable to login to AWX via HTTP
==================================

Access to AWX is intentionally restricted through a secure protocol (HTTPS). In cases where your configuration is set up to run a controller node behind a load balancer or proxy as "HTTP only", and you only want to access it without SSL (for troubleshooting, for example), you must add the following settings in the ``custom.py`` file located at ``/etc/tower/conf.d`` of your controller instance:
Access to AWX is intentionally restricted through a secure protocol (HTTPS). In cases where your configuration is set up to run an AWX node behind a load balancer or proxy as "HTTP only", and you only want to access it without SSL (for troubleshooting, for example), you must add the following settings in the ``custom.py`` file located at ``/etc/tower/conf.d`` of your AWX instance:

::

Expand All @@ -83,7 +83,7 @@ To apply the changes, run:

::

automation-controller-service restart
awx-service restart


WebSockets port for live events not working
Expand Down Expand Up @@ -146,20 +146,20 @@ If you are attempting to run a playbook Job and it stays in the "Pending" state

- Ensure all supervisor services are running via ``supervisorctl status``.
- Check to ensure that the ``/var/`` partition has more than 1 GB of space available. Jobs will not complete with insufficient space on the ``/var/`` partition.
- Run ``automation-controller-service restart`` on the AWX server.
- Run ``awx-service restart`` on the AWX server.


If you continue to have problems, run ``sosreport`` as root on the AWX server, then file a `support request`_ with the result.

.. _`support request`: http://support.ansible.com/


Cancel a controller job
Cancel an AWX job
=========================
.. index::
pair: troubleshooting; job cancellation

When issuing a ``cancel`` request on a currently running controller job, AWX issues a ``SIGINT`` to the ``ansible-playbook`` process. While this causes Ansible to stop dispatching new tasks and exit, in many cases, module tasks that were already dispatched to remote hosts will run to completion. This behavior is similar to pressing ``Ctrl-C`` during a command-line Ansible run.
When issuing a ``cancel`` request on a currently running AWX job, AWX issues a ``SIGINT`` to the ``ansible-playbook`` process. While this causes Ansible to stop dispatching new tasks and exit, in many cases, module tasks that were already dispatched to remote hosts will run to completion. This behavior is similar to pressing ``Ctrl-C`` during a command-line Ansible run.

With respect to software dependencies, if a running job is canceled, the job is essentially removed but the dependencies will remain.

Expand Down
3 changes: 1 addition & 2 deletions docs/docsite/rst/release_notes/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ Known Issues
pair: known issues; VMWare self-signed certs
pair: known issues; self-signed certs (VMWare)
pair: known issues; awx-manage inventory_import user
pair: known issues; upgrading tower 3.8 existing instance groups on OCP deployments
pair: known issues; duplicate Ansible-Galaxy credentials
pair: known issues; deleted default orgs

Expand Down Expand Up @@ -117,7 +116,7 @@ Server error when accessing SAML metadata via hostname

When AWX is accessed via hostname only (e.g. https://my-little-awx), trying to read the SAML metadata from /sso/metadata/saml/ generates a ``sp_acs_url_invalid`` server error.

A configuration in which uses SAML when accessing AWX via hostname only instead of an FQDN, is not supported. Doing so will generate an error that is captured in the tower.log file and in the browser with full traceback information.
A configuration in which uses SAML when accessing AWX via hostname only instead of an FQDN, is not supported. Doing so will generate an error that is captured in the browser with full traceback information.


SAML authentication revokes admin role upon login
Expand Down
6 changes: 3 additions & 3 deletions docs/docsite/rst/userguide/credential_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Credential Types can also generate temporary files to support .ini files or cert
"template": "[mycloud]\ntoken={{ api_token }}"
},
"env": {
"MY_CLOUD_INI_FILE": "{{ tower.filename }}"
"MY_CLOUD_INI_FILE": "{{ awx.filename }}"
}
}
Expand Down Expand Up @@ -289,8 +289,8 @@ An example of referencing multiple files in a custom credential template is as f
"template.key_file": "[mykey]\n{{ key }}"
},
"env": {
"MY_CERT_INI_FILE": "{{ tower.filename.cert_file }}",
"MY_KEY_INI_FILE": "{{ tower.filename.key_file }}"
"MY_CERT_INI_FILE": "{{ awx.filename.cert_file }}",
"MY_KEY_INI_FILE": "{{ awx.filename.key_file }}"
}
}
Expand Down
2 changes: 0 additions & 2 deletions docs/docsite/rst/userguide/execution_environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,6 @@ Execution environment mount options
Rebuilding an |ee| is one way to add certs, but inheriting certs from the host provides a more convenient solution.

.. https://github.com/ansible/tower/issues/5383
Additionally, you may customize |ee| mount options and mount paths in the **Paths to expose to isolated jobs** field of the Job Settings page, where it supports podman-style volume mount syntax. Refer to the `Podman documentation <https://docs.podman.io/en/latest/markdown/podman-run.1.html#volume-v-source-volume-host-dir-container-dir-options>`_ for detail.

In some cases where the ``/etc/ssh/*`` files were added to the |ee| image due to customization of an |ee|, an SSH error may occur. For example, exposing the ``/etc/ssh/ssh_config.d:/etc/ssh/ssh_config.d:O`` path allows the container to be mounted, but the ownership permissions are not mapped correctly.
Expand Down
4 changes: 2 additions & 2 deletions docs/docsite/rst/userguide/inventories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ Inventory updates use dynamically-generated YAML files which are parsed by their
- :ref:`ug_source_insights`
- :ref:`ug_source_openstack`
- :ref:`ug_source_rhv`
- :ref:`ug_source_tower`
- :ref:`ug_source_rhaap`


Newly created configurations for inventory sources will contain the default plugin configuration values. If you want your newly created inventory sources to match the output of legacy sources, you must apply a specific set of configuration values for that source. To ensure backward compatibility, AWX uses "templates" for each of these sources to force the output of inventory plugins into the legacy format. Refer to :ref:`ir_inv_plugin_templates_reference` section of this guide for each source and their respective templates to help you migrate to the new style inventory plugin output.
Expand Down Expand Up @@ -1065,7 +1065,7 @@ Red Hat Virtualization

Red Hat Virtualization (ovirt) inventory source requests are secure by default. To change this default setting, set the key ``ovirt_insecure`` to **true** in ``source_variables``, which is only available from the API details of the inventory source at the ``/api/v2/inventory_sources/N/`` endpoint.

.. _ug_source_tower:
.. _ug_source_rhaap:

Red Hat Ansible Automation Platform
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 345e09a

Please sign in to comment.