docs(atvm): add atvm_prep shorthand and client/esx mapping defaults

This commit is contained in:
2026-05-11 10:45:57 -04:00
parent b988ba07fe
commit 765a1ffe84
3 changed files with 46 additions and 0 deletions

View File

@@ -101,6 +101,18 @@ This file defines how to operate and maintain the ATVM workspace in `/home/aw/co
- If the operator asks for ATVM run status without mentioning Mattermost, respond locally only and do not post externally.
- If the operator asks to send ATVM run status to Mattermost, use `MATTERMOST_ATVM_WEBHOOK` and `MATTERMOST_ATVM_CHANNEL` from `/home/aw/code/cds/.env.credentials.local` by default and send the final status only after the run has fully completed, whether the run passed or failed.
- For vCenter VM snapshot requests, default the snapshot name to `VM Snapshot [m/d/yyyy], [h:mm:ss AM/PM]` in the local `America/New_York` timezone unless the operator explicitly requests a different name.
- For VM power, shutdown, startup, snapshot, or maintenance requests, operate only on the exact VM names provided by the operator.
- If any requested VM name is missing or not found, stop immediately and report the missing names; do not infer, substitute, or search for replacement VMs unless the operator explicitly requests a discovery/mapping step.
- For `atvm_prep` requests, infer common option values from operator shorthand when intent is clear.
- `atvm_prep` datastore shorthand mapping for `-n`:
- `Gold` -> `AutomatedTest-VMBootImg-Gold`
- `Gold2` -> `AutomatedTest-VMBootImg-Gold-2`
- `ComputeMigration` (or `compute migration`) -> `AutomatedTest-VMBootImgComputeMigration-Gold`
- `atvm_prep` client/ESXi pair mapping:
- `CDS1-ESX165` <-> `192.168.1.165`
- `CDS1-ESX166` <-> `192.168.1.166`
- When an `atvm_prep` request specifies only one side of the client/ESXi pair (`-c` or `-e`), auto-fill the other side from the mapping.
- If both `-c` and `-e` are provided but conflict with the mapping, stop and ask the operator to confirm the intended pair before any execution.
- Do not call out expected, harmless `systemctl reset-failed ... unit not loaded` output in routine run updates; mention it only if it blocks startup or matters for debugging.
- Treat `docs/automation/examples.md` as reference-only, not default operator intent.
- Put reusable workflow rules in `guide.md` files.