karvox/awx-operator

An Ansible AWX operator for Kubernetes built with Operator SDK and Ansible. 🤖

AWX Operator

An Ansible AWX operator for Kubernetes built with Operator SDK and Ansible.

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
• Table of Contents
  • Install and Configuration
  • Contributing
  • Release Process
  • Author
  • Code of Conduct
  • Get Involved

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
• Contributors Guide
  • Code of Conduct
  • Get Involved
  • Contributing
  • Release Process
  • Authors
• Installation
  • Basic Install
  • Creating a Minikube cluster for testing
  • Helm Install
• Migration
• Uninstall
• User Guide
  • Admin User Configuration
  • Database Configuration
  • Network and TLS Configuration
  • Advanced Configuration
    • No Log
    • Deploy a Specific Version of AWX
    • Resource Requirements
    • Extra Settings
    • Environment Variables
    • Custom Labels
    • Custom Volumes
    • Scaling Deployments
    • Auto Update Upon Operator Upgrade
    • Termination Grace Period
    • Node Selector for Deployments
    • Default EE from Private Registries
    • CSRF Cookie Secure
    • Disable IPv6
    • LDAP
    • Priority Clases
    • Priveleged Tasks
    • Redis Container Capabilities
    • Trusting a Custom Certificate Authority
    • Service Account
    • Persisting the Projects Directory
• Troubleshooting
  • General Debugging

Contributing

Please visit our contributing guidelines.

Release Process

The first step is to create a draft release. Typically this will happen in the Stage Release 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 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 will run, which will:

• Publish image to Quay
• Release Helm chart

Author

This operator was originally built in 2019 by Jeff Geerling 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. 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. 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 irc.libera.chat
• Join the mailing list