summaryrefslogtreecommitdiffstats
path: root/docs/docsite/rst/administration/troubleshooting.rst
diff options
context:
space:
mode:
authorTVo <thavo@redhat.com>2024-06-24 20:17:31 +0200
committerGitHub <noreply@github.com>2024-06-24 20:17:31 +0200
commit407194d320a750cf525d536c34dc1e6c3c2210e9 (patch)
tree22fcf75ddb993d0d8df6838a7b95fd49d8a001ce /docs/docsite/rst/administration/troubleshooting.rst
parentVarious RBAC fixes related to managed RoleDefinitions (#15287) (diff)
downloadawx-407194d320a750cf525d536c34dc1e6c3c2210e9.tar.xz
awx-407194d320a750cf525d536c34dc1e6c3c2210e9.zip
Added troubleshooting and tips tricks content (#15212)
* Added troubleshooting and tips tricks content * Added troubleshooting and tips tricks content * Moved DNS host entry override info to customize pod spec section of CG chapter. * Added troubleshooting and tips tricks content * Moved DNS host entry override info to customize pod spec section of CG chapter. * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Seth Foster <fosterseth@users.noreply.github.com> * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Seth Foster <fosterseth@users.noreply.github.com> * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Sandra McCann <samccann@redhat.com> * Incorp'd review feedback from @fosterseth and @samccann * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Sandra McCann <samccann@redhat.com> * Final revisions based on @fosterseth's inputs. --------- Co-authored-by: Seth Foster <fosterseth@users.noreply.github.com> Co-authored-by: Sandra McCann <samccann@redhat.com>
Diffstat (limited to 'docs/docsite/rst/administration/troubleshooting.rst')
-rw-r--r--docs/docsite/rst/administration/troubleshooting.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/docsite/rst/administration/troubleshooting.rst b/docs/docsite/rst/administration/troubleshooting.rst
index b6c2b19417..43c9bfa8d9 100644
--- a/docs/docsite/rst/administration/troubleshooting.rst
+++ b/docs/docsite/rst/administration/troubleshooting.rst
@@ -8,6 +8,21 @@ Troubleshooting AWX
single: troubleshooting
single: help
+
+Some troubleshooting tools are built in the AWX user interface that may help you address some issues you might encounter. To access these tools, navigate to **Settings** and select **Troubleshooting**.
+
+.. image:: ../common/images/settings_troubleshooting_highlighted.png
+
+The options available are:
+
+- **Enable or Disable tmp dir cleanup**: choose whether you want to clean up the ``tmp`` directory.
+- **Debug Web Requests**: choose whether you want web requests to log messages for debugging purposes.
+- **Release Receptor Work**: disables cleaning up job pods. If you disable this, the jobs pods will remain in your cluster indefinitely, allowing you to examine them post-run. If you are missing data there, run ``kubectl logs <job-pod-name>`` and provide the logs in a issue report.
+
+.. image:: ../common/images/troubleshooting_options.png
+
+Click **Edit** to modify the settings. Use the toggle to enable and disable the appropriate settings.
+
.. _admin_troubleshooting_extra_settings:
Error logging and extra settings
@@ -220,3 +235,4 @@ If you receive the message "Skipping: No Hosts Matched" when you are trying to r
- Make sure that if you have specified a Limit in the Job Template that it is a valid limit value and still matches something in your inventory. The Limit field takes a pattern argument, described here: http://docs.ansible.com/intro_patterns.html
Please file a support ticket if you still run into issues after checking these options.
+