Skip to content

Commit ccb32a3

Browse files
committed
docs: add operational notes to AGENTS.md
1 parent cd87b08 commit ccb32a3

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,31 @@ Reusable workflow for OpenTofu/Terraform root module repositories (`tfroot-*`).
2121

2222
**Pre-commit configuration is centralized** in `makeitworkcloud/images/tfroot-runner/pre-commit-config.yaml`. Do not add `.pre-commit-config.yaml` to individual tfroot repos.
2323

24+
### Workflow Inputs
25+
26+
| Input | Default | Description |
27+
|-------|---------|-------------|
28+
| `runs-on` | `ubuntu-latest` | Runner label |
29+
| `container` | `ghcr.io/makeitworkcloud/tfroot-runner:latest` | Container image |
30+
| `setup-ssh` | `false` | Whether to setup SSH keys |
31+
| `environment` | `production` | Environment for apply job |
32+
33+
**Note:** `tfroot-libvirt` overrides `container` to use the internal OpenShift registry because it requires SSH access to libvirt hosts from a self-hosted runner.
34+
35+
## Failure Modes
36+
37+
### "manifest unknown" or image pull failures
38+
39+
The `tfroot-runner` image doesn't exist yet. Check:
40+
1. Did the `images` repo Build workflow succeed?
41+
2. Did the `images` repo Pull workflow import to OpenShift? (check logs for actual metadata, not "Unable to connect" errors)
42+
43+
### Pre-commit hook failures
44+
45+
If hooks fail with missing tools or config mismatches:
46+
1. Verify the canonical config in `images/tfroot-runner/pre-commit-config.yaml`
47+
2. Rebuild `tfroot-runner` image if hooks were added/updated
48+
2449
## Related Repositories
2550

2651
- `images` - Contains `tfroot-runner` image and canonical pre-commit config

0 commit comments

Comments
 (0)