Added troubleshooting and tips tricks content #15212
Merged
+38
−10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samccann
reviewed
May 22, 2024
| Adding host entries in execution environments | ||
| =============================================== | ||
|
|
||
| In order to override DNS/host entries, add the following entries in the in the ``/etc/hosts`` file of the pod spec via the ``hostAliases`` attribute: |
There was a problem hiding this comment.
Suggested change
| In order to override DNS/host entries, add the following entries in the in the ``/etc/hosts`` file of the pod spec via the ``hostAliases`` attribute: | |
| In order to override DNS/host entries, add the following entries in the ``/etc/hosts`` file of the pod spec with the ``hostAliases`` attribute: |
There was a problem hiding this comment.
Keep in mind I know zero about all of this, but I got the impression from the issue that the hostAliases entry was not in /etc/hosts but some podman file. I don't know if this meands hand-editing the ContainerFile produced by ansible-builder or some other file...
There was a problem hiding this comment.
...okay a bit of poking in this troubleshooting page and I now think the entries go in the AWX spec file.. But again... I'm doing major guessing here.
|
According to @fosterseth, we can add it like that to the container group pod spec so any job that is started with that pod spec with have |
fosterseth
reviewed
Jun 7, 2024
fosterseth
reviewed
Jun 7, 2024
fosterseth
reviewed
Jun 7, 2024
| @@ -370,7 +385,7 @@ Container groups and instance groups are labeled accordingly. | |||
|
|
|||
| .. note:: | |||
|
|
|||
| Despite the fact that customers have custom Pod specs, upgrades may be difficult if the default ``pod_spec`` changes. Most any manifest can be applied to any namespace, with the namespace specified separately, most likely you will only need to override the namespace. Similarly, pinning a default image for different releases of the platform to different versions of the default job runner container is tricky. If the default image is specified in the Pod spec, then upgrades do not pick up the new default changes are made to the default Pod spec. | |||
| Despite the fact that customers have custom pod specs, upgrades may be difficult if the default ``pod_spec`` changes. Most any manifest can be applied to any namespace, with the namespace specified separately, most likely you will only need to override the namespace. Similarly, pinning a default image for different releases of the platform to different versions of the default job runner container is tricky. If the default image is specified in the pod spec, then upgrades do not pick up the new default changes are made to the default pod spec. | |||
There was a problem hiding this comment.
"Most any manifest can be applied to any namespace, with the namespace specified separately, most likely you will only need to override the namespace."
Should this say "Since any"?
There was a problem hiding this comment.
"Despite the fact that customers have custom pod specs, upgrades may be difficult if the default pod_spec changes"
maybe,
"Note that using custom pod specs may cause issues on upgrade if the default pod spec changes"
samccann
reviewed
Jun 10, 2024
|
|
||
| The options available are: | ||
|
|
||
| - **Enable or Disable tmp dir cleanup**: choose whether you want to clean up the ``temp`` directory. |
There was a problem hiding this comment.
Not familiar with AWX but the UI calls it the tmp dir, so should the text say tmp directory here as well?
Co-authored-by: Seth Foster <[email protected]>
Co-authored-by: Seth Foster <[email protected]>
Co-authored-by: Sandra McCann <[email protected]>
samccann
approved these changes
Jun 14, 2024
Co-authored-by: Sandra McCann <[email protected]>
fosterseth
reviewed
Jun 14, 2024
| @@ -370,7 +382,7 @@ Container groups and instance groups are labeled accordingly. | |||
|
|
|||
| .. note:: | |||
|
|
|||
| Despite the fact that customers have custom Pod specs, upgrades may be difficult if the default ``pod_spec`` changes. Most any manifest can be applied to any namespace, with the namespace specified separately, most likely you will only need to override the namespace. Similarly, pinning a default image for different releases of the platform to different versions of the default job runner container is tricky. If the default image is specified in the Pod spec, then upgrades do not pick up the new default changes are made to the default Pod spec. | |||
| Using a custom pod spec may cause issues on upgrades if the default ``pod_spec`` changes. Most any manifest can be applied to any namespace, with the namespace specified separately, most likely you will only need to override the namespace. Similarly, pinning a default image for different releases of the platform to different versions of the default job runner container is tricky. If the default image is specified in the pod spec, then upgrades do not pick up the new default changes that are made to the default pod spec. | |||
There was a problem hiding this comment.
Most any manifest
is this supposed to say "Since any manifest"?
fosterseth
approved these changes
Jun 14, 2024
djyasin
pushed a commit
to djyasin/awx
that referenced
this pull request
Sep 16, 2024
* 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 <[email protected]> * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Seth Foster <[email protected]> * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Sandra McCann <[email protected]> * Incorp'd review feedback from @fosterseth and @samccann * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Sandra McCann <[email protected]> * Final revisions based on @fosterseth's inputs. --------- Co-authored-by: Seth Foster <[email protected]> Co-authored-by: Sandra McCann <[email protected]>
djyasin
pushed a commit
to djyasin/awx
that referenced
this pull request
Nov 11, 2024
* 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 <[email protected]> * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Seth Foster <[email protected]> * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Sandra McCann <[email protected]> * Incorp'd review feedback from @fosterseth and @samccann * Update docs/docsite/rst/administration/containers_instance_groups.rst Co-authored-by: Sandra McCann <[email protected]> * Final revisions based on @fosterseth's inputs. --------- Co-authored-by: Seth Foster <[email protected]> Co-authored-by: Sandra McCann <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Resolves issue #15040 (troubleshooting section of UI) and #15192 (host alias)
Rendered chapter: https://ansible--15212.org.readthedocs.build/projects/awx/en/15212/administration/containers_instance_groups.html#customize-the-pod-spec
ISSUE TYPE
COMPONENT NAME
AWX VERSION
latest