mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-30 07:13:10 +00:00
* 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>
37 lines
2.1 KiB
Markdown
37 lines
2.1 KiB
Markdown
# AWX Operator
|
|
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
[](https://github.com/ansible/awx-operator/actions)
|
|
[](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
|
|
[](https://groups.google.com/g/awx-project)
|
|
[](https://libera.chat)
|
|
|
|
An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built with [Operator SDK](https://github.com/operator-framework/operator-sdk) and Ansible.
|
|
|
|
The AWX Operator is meant to be deployed in your Kubernetes cluster(s) and can be used to install and manage the lifecycle of an AWX instance in the same namespace.
|
|
|
|
## Documentation
|
|
|
|
The AWX Operator documentation is available at <https://ansible.readthedocs.io/projects/awx-operator/>
|
|
|
|
## Contributing
|
|
|
|
Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md).
|
|
|
|
For docs changes, create PRs on the appropriate files in the `/docs` folder.
|
|
|
|
## Author
|
|
|
|
This operator was originally built in 2019 by [Jeff Geerling](https://www.jeffgeerling.com) and is now maintained by the Ansible Team
|
|
|
|
## Code of Conduct
|
|
|
|
We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com)
|
|
|
|
## Get Involved
|
|
|
|
We welcome your feedback and ideas. The AWX operator uses the same Matrix channel and Ansible Community Forum as AWX itself. Here's how to reach us with feedback and questions:
|
|
|
|
- Join the [Ansible AWX channel on Matrix](https://matrix.to/#/#awx:ansible.com)
|
|
- Join the [Ansible Community Forum](https://forum.ansible.com)
|