mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-26 21:33:14 +00:00
8518e0d1c7
- Added docs for securityContext - enabled web securityContext configuration Co-authored-by: Christian M. Adams <chadams@redhat.com>
115 lines
6.8 KiB
Markdown
115 lines
6.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-->
|
|
|
|
**Note**: We are in the process of moving this readme into official docs in the /docs folder. Please go there to find additional sections during this interim move phase.
|
|
|
|
|
|
Table of Contents
|
|
=================
|
|
|
|
- [AWX Operator](#awx-operator)
|
|
- [Table of Contents](#table-of-contents)
|
|
- [Install and Configuration](#install-and-configuration)
|
|
- [Contributing](#contributing)
|
|
- [Release Process](#release-process)
|
|
- [Author](#author)
|
|
- [Code of Conduct](#code-of-conduct)
|
|
- [Get Involved](#get-involved)
|
|
|
|
<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
|
|
|
|
<!--te-->
|
|
|
|
|
|
|
|
## Install and Configuration
|
|
|
|
All of our usage and configuration docs are nested in the `docs/` directory. Below is a Table of Contents for those.
|
|
|
|
- Introduction
|
|
- [Introduction](./docs/introduction/introduction.md)
|
|
- Contributors Guide
|
|
- [Code of Conduct](./docs/contributors-guide/code-of-conduct.md)
|
|
- [Get Involved](./docs/contributors-guide/get-involved.md)
|
|
- [Contributing](./docs/contributors-guide/contributing.md)
|
|
- [Release Process](./docs/contributors-guide/release-process.md)
|
|
- [Authors](./docs/contributors-guide/author.md)
|
|
- Installation
|
|
- [Basic Install](./docs/installation/basic-install.md)
|
|
- [Creating a Minikube cluster for testing](./docs/installation/creating-a-minikube-cluster-for-testing.md)
|
|
- [Helm Install](./docs/installation/helm-install-on-existing-cluster.md)
|
|
- [Migration](./docs/migration/migration.md)
|
|
- [Uninstall](./docs/uninstall/uninstall.md)
|
|
- User Guide
|
|
- [Admin User Configuration](./docs/user-guide/admin-user-account-configuration.md)
|
|
- [Database Configuration](./docs/user-guide/database-configuration.md)
|
|
- [Network and TLS Configuration](./docs/user-guide/network-and-tls-configuration.md)
|
|
- Advanced Configuration
|
|
- [No Log](./docs/user-guide/advanced-configuration/no-log.md)
|
|
- [Deploy a Specific Version of AWX](./docs/user-guide/advanced-configuration/deploying-a-specific-version-of-awx.md)
|
|
- [Resource Requirements](./docs/user-guide/advanced-configuration/containers-resource-requirements.md)
|
|
- [Extra Settings](./docs/user-guide/advanced-configuration/extra-settings.md)
|
|
- [Environment Variables](./docs/user-guide/advanced-configuration/exporting-environment-variables-to-containers.md)
|
|
- [Custom Labels](./docs/user-guide/advanced-configuration/labeling-operator-managed-objects.md)
|
|
- [Custom Volumes](./docs/user-guide/advanced-configuration/custom-volume-and-volume-mount-options.md)
|
|
- [Scaling Deployments](./docs/user-guide/advanced-configuration/scaling-the-web-and-task-pods-independently.md)
|
|
- [Auto Update Upon Operator Upgrade](./docs/user-guide/advanced-configuration/auto-upgrade.md)
|
|
- [Termination Grace Period](./docs/user-guide/advanced-configuration/pods-termination-grace-period.md)
|
|
- [Node Selector for Deployments](./docs/user-guide/advanced-configuration/assigning-awx-pods-to-specific-nodes.md)
|
|
- [Default EE from Private Registries](./docs/user-guide/advanced-configuration/default-execution-environments-from-private-registries.md)
|
|
- [CSRF Cookie Secure](./docs/user-guide/advanced-configuration/csrf-cookie-secure-setting.md)
|
|
- [Disable IPv6](./docs/user-guide/advanced-configuration/disable-ipv6.md)
|
|
- [LDAP](./docs/user-guide/advanced-configuration/enabling-ldap-integration-at-awx-bootstrap.md)
|
|
- [Priority Clases](./docs/user-guide/advanced-configuration/priority-classes.md)
|
|
- [Priveleged Tasks](./docs/user-guide/advanced-configuration/privileged-tasks.md)
|
|
- [Redis Container Capabilities](./docs/user-guide/advanced-configuration/redis-container-capabilities.md)
|
|
- [Trusting a Custom Certificate Authority](./docs/user-guide/advanced-configuration/trusting-a-custom-certificate-authority.md)
|
|
- [Service Account](./docs/user-guide/advanced-configuration/service-account.md)
|
|
- [Security Context](./docs/user-guide/advanced-configuration/security-context.md)
|
|
- [Persisting the Projects Directory](./docs/user-guide/advanced-configuration/persisting-projects-directory.md)
|
|
- Troubleshooting
|
|
- [General Debugging](./docs/troubleshooting/debugging.md)
|
|
|
|
|
|
## 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)
|
|
- Join the [mailing list](https://groups.google.com/forum/#!forum/awx-project)
|