KO
|
EN
gitlite — search
Search
#javascript
#python
#hacktoberfest
#react
#ai
#typescript
#llm
#go
#golang
#android
#machine-learning
#rust
#deep-learning
#linux
awx-install-on-k3s
★ 12
Open GitHub ↗
Install AWX on k3s
Download README (.md)
Explore Similar Repositories
MiddleEllipsisText
:
A Text Component with ellipsis in the middle of text for Jetpack Compose and Compose Multiplatform
python-toolpathing
:
Small workshop on Python toolpathing in Blender.
react-india
:
Turborepo for my React India talk
FuzzyCode
:
A demonstration of Fuzzy logic within Python3.
pawprint
:
A substitution of systemd-tmpfiles
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
awx-install-on-k3s
?
Download (.md)
# 🚀 AWXai on k3s: AI-Maintained Ansible Automation Hub [](https://www.gnu.org/licenses/gpl-3.0) [](https://youtu.be/pNHh6Ic-64E) Deploy a full-featured **AWXai** instance on a lightweight k3s Kubernetes cluster with this automated Ansible playbook. ## 🎯 What is AWXai? **AWXai** is an AI-maintained fork of AWX (Ansible AWX) that extends the original project with enhanced features, optimizations, and modern automation workflows. - **Repository:** https://github.com/antuelle78/AWXai.git - **Base:** Forked from official AWX with AI-driven improvements - **Maintained by:** @antuelle78 This deployment is based on the excellent work of [@kurokobo](https://github.com/kurokobo) and his [awx-on-k3s](https://github.com/kurokobo/awx-on-k3s) repository, specifically modified to deploy **AWXai** instead of standard AWX. > **Note:** This role is optimized for **AWXai 25.2.0** and **awx-operator 2.19.1**. --- ## ✨ Features * **Deploy AWXai:** Installs the AI-maintained AWXai fork from https://github.com/antuelle78/AWXai.git * **Automated Deployment:** Sets up a single-node k3s cluster and deploys AWXai with a single command. * **Lightweight & Efficient:** Uses k3s for a minimal Kubernetes footprint. * **SSL Ready:** Includes a playbook for deploying with a valid Let's Encrypt certificate using cert-manager and Cloudflare. * **Backup & Restore:** Comes with playbooks to easily back up and restore your AWXai instance. * **Flexible Configuration:** Easily customize your deployment with a comprehensive set of Ansible variables. * **Ansible Navigator Support:** Includes a configuration for a seamless experience with `ansible-navigator`. --- ## ✅ Prerequisites Before you begin, ensure your control node and target host meet the following requirements: * **Operating System:** * Ubuntu 20.04 - 24.04 (Recommended) * CentOS 8 Stream * **Hardware:** * 4 GB RAM (minimum) * 2 CPU cores (minimum) * **60 GB disk space** (minimum) - Required for: * 25 Gi for PostgreSQL database * 25 Gi for AWX projects * 10 Gi for system and k3s overhead * **On your Ansible Control Node:** * The `kubernetes.core` Ansible collection must be installed: ```bash ansible-galaxy collection install kubernetes.core ``` --- ## 🚀 Quick Start 1. **Clone the repository:** ```bash git clone https://github.com/antuelle78/awx-install-on-k3s.git cd awx-install-on-k3s ``` 2. **Create your inventory file** (e.g., `inventory.yml`): ```yaml all: hosts: awxai-node: ansible_host: 192.168.122.46 ansible_user: your_user ``` 3. **Run the deployment playbook:** ```bash ansible-playbook -i inventory.yml deploy.yml ``` You will be prompted to enter values for the deployment. To accept the defaults, simply press Enter. 4. **Access AWXai:** Once the playbook is complete, open your browser and navigate to the hostname you configured (default: `http://awxai.antuelle78.com`). ## 💡 About AWXai AWXai is a fork of the upstream AWX project that incorporates AI-driven enhancements and optimizations. The project is maintained by @antuelle78 and is available at: **https://github.com/antuelle78/AWXai.git** Key differences from standard AWX: - AI-maintained codebase with automated improvements - Enhanced features for modern automation workflows - Regular updates with community-driven optimizations - Compatible with the AWX operator ecosystem --- ## 🛠️ Configuration You can customize the deployment by modifying the role variables. The most common variables are prompted during the execution of `deploy.yml`. ### Storage Configuration The deployment uses variables to control storage sizes for each volume: | Variable | Purpose | Default | Role File | | -------- | ------- | -------- | ---------- | | `postgres_storage_size` | PostgreSQL database storage | 25 Gi | `roles/awx_k3s/defaults/main.yml` | | `projects_storage_size` | AWX project files | 25 Gi | `roles/awx_k3s/defaults/main.yml` | | `backup_storage_size` | Backup storage (if using backups) | 25 Gi | `roles/backup_awx_k3s/defaults/main.yml` | **Note:** Backups are stored on a separate volume from the main AWX deployment. **Total host storage requirement:** 60 Gi minimum (25 Gi PostgreSQL + 25 Gi Projects + 10 Gi system overhead) #### Adjusting Storage Size To modify the storage allocation for your deployment, simply edit the corresponding variable in the role's `defaults/main.yml` file: ```yaml # roles/awx_k3s/defaults/main.yml (or awx_k3s_with_valid_ssl) postgres_storage_size: 25Gi # Adjust PostgreSQL storage projects_storage_size: 25Gi # Adjust projects storage ``` ```yaml # roles/backup_awx_k3s/defaults/main.yml backup_storage_size: 25Gi # Adjust backup storage ``` **Alternative:** You can also override these variables in your playbook or inventory: ```yaml # In your inventory.yml all: hosts: awxai-node: ansible_host: 192.168.122.46 ansible_user: your_user vars: postgres_storage_size: 50Gi projects_storage_size: 50Gi ``` The variables automatically propagate to all PersistentVolumes, PersistentVolumeClaims, and AWX/Backup specifications, ensuring consistency across your deployment. ### Deployment Variables | Variable | Description | Default Value | | ----------------------- | ------------------------------------------------------------------------------------------------------- | ------------------ | | `k3s_version` | The k3s release to deploy. | `v1.34.2+k3s1` | | `operator_version` | The awx-operator release to use. | `2.19.1` | | `awx_image` | The Docker image for AWXai. | `docker.io/antuelle78/awxai` | | `awx_version` | The AWXai version to deploy (from https://github.com/antuelle78/AWXai.git). | `25.2.0` | | `awx_admin_password` | The password for the AWXai web interface `admin` user. | `omm0uqhfbQxr8ypVBK4UhCFp8QR8wgmw` | | `postgres_password` | The password for the PostgreSQL database. | `mydbpasswd` | | `awx_hostname` | The hostname or FQDN for the AWXai web interface. | `awxai.antuelle78.com` | | `namespace_k3s` | The Kubernetes namespace for the deployment. | `awxai` | | `postgres_storage_size` | Storage size for PostgreSQL database (e.g., 25Gi, 50Gi, 100Gi). | `25Gi` | | `projects_storage_size` | Storage size for AWX projects (e.g., 25Gi, 50Gi, 100Gi). | `25Gi` | | `backup_storage_size` | Storage size for backups (see backup role defaults). | `25Gi` | | `cloudflare_api_key` | Your Cloudflare API key (for SSL deployment). Define in `roles/awx_k3s_with_valid_ssl/defaults/main.yml`. | `""` | | `email_for_letsencrypt` | A valid email for Let's Encrypt registration. Define in `roles/awx_k3s_with_valid_ssl/defaults/main.yml`. | `""` | --- ## 🔬 Advanced Usage ### Using Ansible Navigator This repository is pre-configured for use with `ansible-navigator`. The included `ansible-navigator.yml` uses the `antuelle78/awx-ee:latest` execution environment. ```bash ansible-navigator run deploy.yml -i inventory.yml -m stdout ``` ### Skipping the k3s Installation To speed up subsequent playbook runs, you can skip the k3s installation: ```bash ansible-playbook -i inventory.yml deploy.yml --skip-tags=k3s_install ``` ### Deploying with a Valid SSL Certificate (Cloudflare) 1. **Edit the defaults file:** Open `roles/awx_k3s_with_valid_ssl/defaults/main.yml` and set your `cloudflare_api_key` and `email_for_letsencrypt`. 2. **Run the SSL deployment playbook:** ```bash ansible-playbook -i inventory.yml deploy_nintr_cloudflare.yml ``` --- ## 📦 Backup and Restore This repository includes playbooks to back up your AWXai instance. ### Interactive Backup This playbook will prompt you for the backup name and retention period. ```bash ansible-playbook -i inventory.yml backup_awx_intr.yml ``` ### Automated Backup This playbook uses default values (30-day retention) and will automatically delete backups older than the retention period. ```bash ansible-playbook -i inventory.yml backup_awx.yml ``` --- ## 🤝 Contributing Contributions are welcome! Please feel free to open an issue or submit a pull request. ## 📄 License This project is licensed under the **GPLv3**. See the [LICENSE](LICENSE) file for details. --- ### **LET'S GET IT AUTOMATED AND BE LAZY :<)** *Michael Nelson*
