36 lines
1.5 KiB
Markdown
36 lines
1.5 KiB
Markdown
# ATVM Workspace
|
|
|
|
This folder contains the ATVM setup workflow, ATVM Cypress automation workflow, and the lab inventory/reference material used to operate them.
|
|
|
|
## Start Here
|
|
- Setup/bootstrap workflow:
|
|
- `docs/setup/guide.md`
|
|
- ATVM Cypress automation workflow:
|
|
- `docs/automation/guide.md`
|
|
- Shared maintenance conventions:
|
|
- `docs/workflow/conventions.md`
|
|
- Environment inventory and credentials:
|
|
- `inventory/overview.md`
|
|
|
|
## Layout
|
|
- `scripts/`
|
|
- executable scripts used by setup/bootstrap
|
|
- `docs/setup/`
|
|
- setup procedure and setup run learnings
|
|
- `docs/automation/`
|
|
- automation procedure, reusable examples, and automation run learnings
|
|
- `docs/workflow/`
|
|
- conventions for how this workspace is structured and maintained
|
|
- `inventory/`
|
|
- environment inventory, credentials, reserved IPs, and reference maps
|
|
- `archive/imported-notes/`
|
|
- preserved original long-form notes that were reorganized into the current structure
|
|
|
|
## Practical Guidance
|
|
- Use `guide.md` files for authoritative workflow behavior.
|
|
- Use `examples.md` for reusable command patterns only.
|
|
- Use `run-learnings.md` only when a run produced a new lasting lesson.
|
|
- For detailed ATVM automation test results, especially per-host failures, use `/root/cdc-e2e-cyp-12.17.4/cypress/cmcReporter` on the automation controller.
|
|
- Use `inventory/` for persistent environment information such as hosts, credentials, and IP assignments.
|
|
- Use `archive/imported-notes/` when you need the original full historical notes in their original layout.
|