diff --git a/README.md b/README.md index 58c8140..96401f3 100644 --- a/README.md +++ b/README.md @@ -283,6 +283,7 @@ Refer [📁 **Back up AWX using AWX Operator**](backup) and [📁 **Restore AWX - [📁 **Use Customized Pod Specification for your Execution Environment**](containergroup) - The guide to use customized Pod of the Execution Environment using **Container Group**. - [📁 **Tips**](tips) + - [📝Create "Manual" type project](tips/manual-project.md) - [📝Deploy AWX using external PostgreSQL database](tips/external-db.md) - [📝Trust custom Certificate Authority](tips/trust-custom-ca.md) - [📝Expose `/etc/hosts` to Pods on K3s](tips/expose-hosts.md) diff --git a/tips/README.md b/tips/README.md index 8fa6d7d..ee4d23c 100644 --- a/tips/README.md +++ b/tips/README.md @@ -1,5 +1,6 @@ # Tips +- [📝Create "Manual" type project](manual-project.md) - [📝Deploy AWX using external PostgreSQL database](external-db.md) - [📝Trust custom Certificate Authority](trust-custom-ca.md) - [📝Expose `/etc/hosts` to Pods on K3s](expose-hosts.md) diff --git a/tips/manual-project.md b/tips/manual-project.md new file mode 100644 index 0000000..b65ba61 --- /dev/null +++ b/tips/manual-project.md @@ -0,0 +1,35 @@ +# Create "Manual" type project + +The Git repository is the most preferred place to store your playbooks, and [the guides and resources to deploy Private Git Repository on K3s](../git) are also provided in this repository. + +However, if you don't need such a rich version control system, or need to make frequent iterations of trial and error to develop new playbooks, creating a project with **Manual** type is very helpful. + +## Concepts + +The project directories have to exist under `/var/lib/awx/projects` of AWX, and if you have deployed AWX following the steps described in [the main guide on this repository](../README.md), `/data/projects` on your K3s host is mounted as `/var/lib/awx/projects` in AWX. + +So, to add project directories, simply, just placing it under `/data/projects` on your K3s host. + +## Procedure + +Create new directory under `/data/projects` on your K3s host, and place your playbooks under the directory you created. + +```bash +$ tree /data/projects/ +/data/projects/ +`-- my-first-manual-project 👈👈👈 + `-- my-playbook.yaml 👈👈👈 +``` + +Go to `Resources` > `Projects` > `Add` in AWX Web UI, fill `Name` field and select `Manual` as `Source Control Type`. + +Now you can select your project directory (`my-first-manual-project` in this example) as `Playbook Directory`. + +After `Save` the project, your playbooks can be selected in the Job Templates. + +## Troubleshooting + +If you got following warning while selecting `Playbook Directory`, try super-reloading your browser (`Shift + F5` or `Ctrl (Cmd) + Shift + R`) to refresh the page without using the cache stored in the browser. + +> ⚠️WARNING: +> There are no available playbook directories in /var/lib/awx/projects