internet/awx-operator
3
0
Fork 0
mirror of https://github.com/ansible/awx-operator.git synced 2026-04-17 22:31:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
test-python-module-fix
awx-operator/docs/user-guide/advanced-configuration/pods-termination-grace-period.md
kurokobo 2b0221bbc6 docs: overall minor renovations (#1874) 
* docs: simplify README.md and make index.md to refer to it
* docs: change order for pages in navigation and add missing pages
* docs: fix headings to improve navigation, transform notes to admonition, fix indentation, linting issues and minor issues
* docs: merge docs for using images from private registries
* docs: add example to integrate LDAP configuration via extra_settings_files
* Apply suggestions from code review
docs: apply suggested changes

Co-authored-by: Don Naro <dnaro@redhat.com>

* docs: update the doc site url as same as the url in https://www.ansible.com/ecosystem/
* docs: minor fixes for hpa page
* docs: expand note block
* docs: apply #1904 to README.md

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
2024-07-20 18:34:21 -04:00

2.1 KiB
Raw Permalink Blame History

Pods termination grace period

During deployment restarts or new rollouts, when old ReplicaSet Pods are being terminated, the corresponding jobs which are managed (executed or controlled) by old AWX Pods may end up in Error state as there is no mechanism to transfer them to the newly spawned AWX Pods. To work around the problem one could set termination_grace_period_seconds in AWX spec, which does the following:

  • It sets the corresponding terminationGracePeriodSeconds Pod spec of the AWX Deployment to the value provided

    • The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal

  • It adds a PreStop hook script, which will keep AWX Pods in terminating state until it finished, up to terminationGracePeriodSeconds.

    • This grace period applies to the total time it takes for both the PreStop hook to execute and for the Container to stop normally
    • While the hook script just waits until the corresponding AWX Pod (instance) no longer has any managed jobs, in which case it finishes with success and hands over the overall Pod termination process to normal AWX processes.

One may want to set this value to the maximum duration they accept to wait for the affected Jobs to finish. Keeping in mind that such finishing jobs may increase Pods termination time in such situations as kubectl rollout restart, AWX upgrade by the operator, or Kubernetes API-initiatedevictions.

Name Description Default
termination_grace_period_seconds Optional duration in seconds pods needs to terminate gracefully not set