* There are 2 data-structures that django channels redis uses: (1) zset and (2) list. (1) is used for group membership where the key is the logic user group and the value(s) are websocket clients. The score of the zset entry is used for group expiration. We can not rely on group expiration for clean-up because there is no interface privided by redis channels to refresh the expiration. Choosing a small value for group_expiry could result on our websocket backplane group expiring, which would result in job events not being delivered. Instead, we increase the group expiration to 5 years and clean up on daphne service start. * The list (2) data-structure is used by django channels redis to queue websocket events per-websocket-client as needed. The need arises to queue per-websocket-client events when the consumer can not keep up with the producer. The consumer here is daphne, the producer is AWX. * When AWX is operating healthy group membership in Redis is reflective of the real-world. When AWX is unhealthy i.e. daphne cycles, the zset will contain stale websocket client entries. This can be observed by running `zrange asgi::group:jobs-status_changed 0 -1`. If the entries returned look like: specific.fUkXXpYj!DKOIfwPICNgw specific.fUkXXpYj!FQcdopZeiRdG specific.lpTSAgnk!IOKldfzcfdDp specific.lpTSAgnk!NbvRUZsDpIQx The entries with `fUkXXpYj` are stale. Note that this changeset fixes this by removing all `asgi:*` entries on daphne start. * Also note that individual message themselves have an expiration that is configurable and defaults to 60. * Also note that zset's tracking group membership will be deleted by django channels redis when they are empty.
AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is the upstream project for Tower, a commercial derivative of AWX.
To install AWX, please view the Install guide.
To learn more about using AWX, and Tower, view the Tower docs site.
The AWX Project Frequently Asked Questions can be found here.
The AWX logos and branding assets are covered by our trademark guidelines.
Contributing
- Refer to the Contributing guide to get started developing, testing, and building AWX.
- All code submissions are done through pull requests against the
develbranch. - All contributors must use git commit --signoff for any commit to be merged, and agree that usage of --signoff constitutes agreement with the terms of DCO 1.1
- Take care to make sure no merge commits are in the submission, and use
git rebasevsgit mergefor this reason. - If submitting a large code change, it's a good idea to join the
#ansible-awxchannel on irc.freenode.net, and talk about what you would like to do or add first. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed.
Reporting Issues
If you're experiencing a problem that you feel is a bug in AWX, or have ideas for how to improve AWX, we encourage you to open an issue, and share your feedback. But before opening a new issue, we ask that you please take a look at our Issues guide.
Code of Conduct
We ask all of our community members and contributors to adhere to the Ansible code of conduct. If you have questions, or need assistance, please reach out to our community team at codeofconduct@ansible.com
Get Involved
We welcome your feedback and ideas. Here's how to reach us with feedback and questions:
- Join the
#ansible-awxchannel on irc.freenode.net - Join the mailing list