https://github.com/mamercad/concourse-awx-resource
Concourse Resource for AWX Job Templates and Workflow Job Templates
https://github.com/mamercad/concourse-awx-resource
awx concourse
Last synced: 4 days ago
JSON representation
Concourse Resource for AWX Job Templates and Workflow Job Templates
- Host: GitHub
- URL: https://github.com/mamercad/concourse-awx-resource
- Owner: mamercad
- License: mit
- Created: 2021-04-22T15:22:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-13T10:08:07.000Z (over 2 years ago)
- Last Synced: 2025-06-06T03:09:32.572Z (4 months ago)
- Topics: awx, concourse
- Language: Python
- Homepage:
- Size: 892 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Concourse AWX Resource
[](https://github.com/mamercad/concourse-awx-resource/actions/workflows/shellcheck.yml)
[](https://github.com/mamercad/concourse-awx-resource/actions/workflows/python.yml)
A [Concource CI](https://concourse-ci.org/) custom resource for [Ansible AWX](https://github.com/ansible/awx).
Docker images are named `quay.io/mamercad/concourse-awx-resource:` and can be viewed [here](https://quay.io/repository/mamercad/concourse-awx-resource), the [Dockerfile](Dockerfile) is in the root of this repository.
Currently, the resource supports launching [AWX Job Templates](https://docs.ansible.com/ansible-tower/latest/html/userguide/job_templates.html) and [Workflow Job Templates](https://docs.ansible.com/ansible-tower/latest/html/userguide/workflow_templates.html).
There's a [Makefile](Makefile) which may help:
```bash
❯ make help
help: Shows this help
build: Build the Docker images
push: Push the Docker images
run: Run the (local) Docker image
ping: Test AWX connectivity and access
validate: Validate the pipeline
set: Set the pipeline
unpause: Unpause the pipeline
launch: Launch the pipeline
shipit: build push set launch Build, push, set and launch
```
There's also a [infra/Makefile](infra/Makefile) which may help for local development, see the [infra/README.md](infra/README.md).
## Resource Configuration
`awx.endpoint`: The API endpoint of the AWX instance. Follows the same pattern as the AWX API or CLI, e.g., `https://your.tower.tld`. Note the lack of the trailing lash, and, don't provide `/api/v2`.
`awx.auth`: The authentication context, both `Bearer ` and `Basic ` should work.
## Resource Behavior
`check`: No-op.
`in`: No-op.
`out`: Launches either the job template or the workflow job template, polling it until completion.
### Parameters
`awx.type`: (Required) Currently supports either `job_templates` and `workflow_job_templates`. The name is plural, but, the behavior is singular (keeping parity with the API terminology).
`awx.id`: (Required) The ID of the job template or workflow job template to launch.
`awx.debug`: (Optional, default is `false`) Controls whether or not to enable additional debugging information.
## Example Pipeline
```yaml
resource_types:
- name: awx-workflow-resource
type: docker-image
source:
repository: quay.io/mamercad/concourse-awx-resource
version: 0.0.1
resources:
- name: awx
type: awx-workflow-resource
source:
awx:
endpoint: ((TOWER_HOST))
auth: Bearer ((TOWER_OAUTH_TOKEN))
jobs:
- name: awx-job
plan:
- put: awx
params:
awx:
type: job_templates
id: ((TOWER_JOB_TEMPLATES))
debug: false
- put: awx
params:
awx:
type: workflow_job_templates
id: ((TOWER_WORKFLOW_JOB_TEMPLATES))
debug: false
```
## Screenshot
All of the job results will be returned, here's a screenshot to give you a feel:
## License
[MIT](LICENSE) © Mark Mercado <>