mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-26 21:33:14 +00:00
50 lines
2.8 KiB
Markdown
50 lines
2.8 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.
|
|
|
|
<!-- Regenerate this table of contents using https://github.com/ekalinin/github-markdown-toc -->
|
|
<!-- gh-md-toc --insert README.md -->
|
|
<!--ts-->
|
|
|
|
# AWX Operator Documentation
|
|
|
|
The AWX Operator documentation is now available at https://awx-operator.readthedocs.io/
|
|
|
|
For docs changes, create PRs on the appropriate files in the /docs folder.
|
|
|
|
## Contributing
|
|
|
|
Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md).
|
|
|
|
## Release Process
|
|
|
|
The first step is to create a draft release. Typically this will happen in the [Stage Release](https://github.com/ansible/awx/blob/devel/.github/workflows/stage.yml) workflow for AWX and you don't need to do it as a separate step.
|
|
|
|
If you need to do an independent release of the operator, you can run the [Stage Release](https://github.com/ansible/awx-operator/blob/devel/.github/workflows/stage.yml) in the awx-operator repo. Both of these workflows will run smoke tests, so there is no need to do this manually.
|
|
|
|
After the draft release is created, publish it and the [Promote AWX Operator image](https://github.com/ansible/awx-operator/blob/devel/.github/workflows/promote.yaml) will run, which will:
|
|
|
|
- Publish image to Quay
|
|
- Release Helm chart
|
|
|
|
## 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 mailing list and IRC channel 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)
|