Skip to content

Commit

Permalink
Merge pull request #14 from netboxlabs/doc-patch
Browse files Browse the repository at this point in the history
rename project template to job template
  • Loading branch information
netboxlabs-nvp authored Dec 1, 2024
2 parents 04ecd25 + bc535e7 commit 5c5296f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/configure-awx-aap.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,9 @@ Navigate to Resources > Projects in AWX, and create a new Project called 'netbox

Click the 'Sync' button in the AWX UI to ensure that git synchronization is successful. If this step is *not* successful, then *do not proceed* -- as you troubleshoot. Otherwise, proceed.

#### Add (project) Templates to AWX
#### Add (job) Templates to AWX

In AWX, a (project) template provides a web accessible means of triggering automation, i.e. via a webhook. Each (project) template represents an Ansible playbook -- each Ansible playbook represents a file that was synchronized from git when you created the project in AWX -- where the playbook will perform Proxmox automation.
In AWX, a (job) template provides a web accessible means of triggering automation, i.e. via a webhook. Each (job) template represents an Ansible playbook -- each Ansible playbook represents a file that was synchronized from git when you created the project in AWX -- where the playbook will perform Proxmox automation.

For example, when you have defined a Proxmox VM in NetBox (alongside its default resources), you can use `awx-clone-vm-and-set-resources.yml` to automate the cloning of a VM and setting its resources in Proxmox.

Expand All @@ -210,7 +210,7 @@ When you create *any* template in AWX for Proxmox automation, you will need to s

![NetBox Proxmox clone vm and set resources edit image](./images/awx-netbox-proxmox-template-clone-resources-edit.png)

`netbox-proxmox-ansible` provides a series of Ansible playbooks that you can use to create fully-functioning Proxmox VMs based on their desired configuration states in NetBox. You will need to create a (project) template for each playbook in AWX.
`netbox-proxmox-ansible` provides a series of Ansible playbooks that you can use to create fully-functioning Proxmox VMs based on their desired configuration states in NetBox. You will need to create a (job) template for each playbook in AWX.

`netbox-proxmox-automation` implements the following Ansible playbooks.

Expand Down
6 changes: 3 additions & 3 deletions docs/netbox-event-rules-and-webhooks-awx-aap.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Regardless of whether you are using a Flask (or other) application for Proxmox a

### AWX/Tower/AAP

As noted earlier, AWX/Tower/AAP will perform Proxmox automation through separate (project) templates. This section walks you through how (NetBox) webhooks and (NetBox) event rules are handled by AWX.
As noted earlier, AWX/Tower/AAP will perform Proxmox automation through separate (job) templates. This section walks you through how (NetBox) webhooks and (NetBox) event rules are handled by AWX.

#### AWX/Tower/AAP Webhook

To use NetBox webhooks with AWX, each NetBox webhook for Proxmox VM management will point at a separate AWX (project) template. In AWX, each (project) template has a unique ID. When we execute a webhook in NetBox, in this case we're using AWX, the (NetBox) webhook will in turn point at the (project) template ID in AWX -- and tell AWX to launch the template, i.e. to run the automation.
To use NetBox webhooks with AWX, each NetBox webhook for Proxmox VM management will point at a separate AWX (job) template. In AWX, each (job) template has a unique ID. When we execute a webhook in NetBox, in this case we're using AWX, the (NetBox) webhook will in turn point at the (job) template ID in AWX -- and tell AWX to launch the template, i.e. to run the automation.

AWX webhooks are created this way in NetBox.

Expand Down Expand Up @@ -81,7 +81,7 @@ Regardless of which AWX template you use as a (NetBox) webhook, you must include

#### AWX/Tower/AAP Event Rules

Now let's take a look at the NetBox event rules that call an AWX webhook (project template) with Proxmox VM and VM disk object changes in Netbox.
Now let's take a look at the NetBox event rules that call an AWX webhook (job template) with Proxmox VM and VM disk object changes in Netbox.

![NetBox Proxmox VM event rules AWX image](./images/netbox-proxmox-event-rules-awx.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/proxmox-vm-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

*-or-*

- You are running AWX and have created (project) templates to handle events via webhooks
- You are running AWX and have created (job) templates to handle events via webhooks


## Initial Configuration: Creating Proxmox VM templates from (cloud-init) images
Expand Down

0 comments on commit 5c5296f

Please sign in to comment.