Awx module · weave

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

AWX REST API

Variable	Description	Status
AWX_HOST	Required for authentication.	required
AWX_AUTH_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave awx --help
weave doctor   # reports AWX_HOST status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
inventory	·	✓	·	·	·	·	·
job	·	✓	·	·	·	·	·
job-template	·	✓	·	✓	·	·	·
resources	·	·	·	·	✓	✓	✓

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

list (3)

list inventories

read

List inventories.

weave awx list inventories <arg>

list jobs

read

List recent job runs.

weave awx list jobs <arg>

list templates

read

List job templates.

weave awx list templates <arg>

do (1)

do launch

write

Launch a job template.

weave awx do launch <template-id>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/awx/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

resources

snapshot diff apply

awx resources — field-level apply via REST.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: awx
kind: resources
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Resources audit

Snapshot and diff resources.

weave awx snapshot resources
$EDITOR .weave-state/awx/resources.yaml
weave awx diff resources
weave awx apply resources

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
awx_resources	weave awx snapshot/diff/apply resources Snapshot/diff for audit; confirm apply on the module page.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including AWX_HOST) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave awx diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/awx. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.