A GitHub Action that triggers execution of a named template on an AWX server.
In addition to running the template you can inject a value for a template
variable. If unused, the variable image_tag
is set to the value latest
.
This action essentially allows you to run templates in a remote AWX server, given a template name, and template user credentials.
This action is typically used after you've built and published a container image, and you then want to trigger an AWX template that would deploy that image, say to a Kubernetes cluster.
Required The name of the AWX template to run
Required The hostname of the AWX server
Required The username of a user that can execute the template
Required The template user's password
A template variable, default image_tag
A value for the template variable, default latest
Here we trigger the AWX template My Template, where the user is expected to have Execute permissions for the template.
uses: informaticsmatters/trigger-awx-action@v1
with:
template: My Template
template-host: https://example.com
template-user: ${{ secrets.AWX_USER }}
template-user-password: ${{ secrets.AWX_USER_PASSWORD }}
You can also define the value of a template variable. For example, here we set the variable ma_image_tag to latest when triggering My Template: -
uses: informaticsmatters/trigger-awx-action@v1
with:
template: My Template
template-host: https://example.com
template-user: ${{ secrets.AWX_USER }}
template-user-password: ${{ secrets.AWX_USER_PASSWORD }}
template-var: ma_image_tag
template-var-value: latest
As AWX might be considered an Environment you'd typically store your secrets in a GitHub Environment rather than use Repository or Organisation secrets.