awx README

The project's README from github.com/ansible/awx. As one markdown file: README.md.

CI codecov Code of Conduct Apache v2 License AWX on the Ansible Forum Ansible Matrix Ansible Discourse

AWX

[!CAUTION] The last release of this repository was released on Jul 2, 2024. Releases of this project are now paused during a large scale refactoring. For more information, follow the Forum and - more specifically - see the various communications on the matter:

AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is one of the upstream projects for Red Hat Ansible Automation Platform.

To install AWX, please view the Install guide.

To learn more about using AWX, view the AWX 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

Reporting Issues

If you're experiencing a problem that you feel is a bug in AWX or have ideas for improving 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 require 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 [email protected]

Get Involved

We welcome your feedback and ideas via the Ansible Forum.

For a full list of all the ways to talk with the Ansible Community, see the AWX Communication guide.

awx (ansible/awx)

Searching Database…

15.6K ·GitHub
What is this?AWX is a web-based user interface, REST API, and task engine built on top of Ansible — a self-hosted control center for launching and managing Ansible automation from a browser.
Is it an app I install on my machine, or a server I deploy?It's a server you deploy, not a local app: you get a web dashboard and a REST API, and its task engine runs your Ansible jobs on a central instance.
How do I get an AWX instance running?The README points to the AWX Install guide for deployment — installation is based on the AWX Operator — and day-to-day usage is covered on the AWX docs site.
Do I need to know Ansible before using it?Yes — AWX runs Ansible under the hood, so you bring your existing Ansible projects and playbooks; AWX wraps them with a web UI and REST API.
Is the project still getting new releases?Releases are paused: the last one shipped on Jul 2, 2024, while the team refactors AWX into a pluggable, service-oriented architecture. No resume date is given; updates go to the Ansible Forum and the project blog.
Who is AWX meant for?Teams and admins who want a shared web UI and API over Ansible instead of ad-hoc CLI runs — it is the upstream project for Red Hat Ansible Automation Platform.
What is AWX built with?The backend is Python on Django with Django REST Framework for the API, and the web UI is built with React.
How does AWX relate to Red Hat Ansible Automation Platform?AWX is one of the upstream projects for that platform — the open-source codebase that Red Hat's supported automation offering grows out of, so running AWX gives you the community version of that experience.
What does the big refactoring change?AWX is moving to a pluggable, service-oriented architecture: the AWX Operator installation methods are changing, and the AWX UI and credential types are transitioning to the new pluggable architecture.
Creator
ansible
Size
346.6 MB
Stars
15.6K
Age
9y
Commits · 90 Days