Files
cds-ai/atvm/AGENTS.md
anthony.wen 274b920b40 Reorganize ATVM workspace into scripts, docs, inventory, and archive
Restructure the ATVM folder to separate executable scripts from workflow documentation and long-form environment reference material.

Move setup and automation scripts into scripts/, move setup and automation guides into docs/, add top-level README and workflow conventions, and organize durable environment details into inventory/ while preserving the original long-form ATVM notes under archive/imported-notes/.

Update internal documentation paths to match the new layout and remove the archived Zone.Identifier metadata file.
2026-03-21 20:39:23 -04:00

3.0 KiB

ATVM AGENTS Guide

This file defines how to operate and maintain the ATVM workspace in /home/aw/code/cds/atvm.

Workspace Layout

  • README.md
    • human entry point for the folder
  • scripts/
    • executable workflow assets
  • docs/setup/
    • setup/bootstrap procedure and run learnings
  • docs/automation/
    • ATVM Cypress automation procedure, examples, and run learnings
  • docs/workflow/
    • shared conventions for how the docs are maintained
  • inventory/
    • environment reference, credentials, IP allocations, and inventory indexes
  • archive/imported-notes/
    • preserved original long-form source material

Authoritative Sources

  • Setup/bootstrap procedure:
    • docs/setup/guide.md
  • Setup/bootstrap learnings:
    • docs/setup/run-learnings.md
  • Automation execution procedure:
    • docs/automation/guide.md
  • Automation command examples:
    • docs/automation/examples.md
  • Automation run learnings:
    • docs/automation/run-learnings.md
  • Workspace conventions:
    • docs/workflow/conventions.md

Setup Track Defaults

  • ATVM static IP target: 192.168.3.191/22
  • Gateway: 192.168.0.1
  • DNS: 8.8.8.8, 8.8.4.4
  • Default setup credential: root / cdsi2012
  • Client log file: atvm_setup_script.log
  • Treat 192.168.3.191 as the default ATVM target host reference.
  • For SSH to 192.168.3.191, ignore host key mismatch by default with -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null.
  • For SSH to 192.168.3.191, use default credentials root / cdsi2012 unless explicitly overridden.

Automation Track Defaults

  • Controller host: atvm-cypres-vm-1
  • Controller IP: 192.168.3.190
  • Controller credentials: root / atvmcdsi2012
  • Default plugin: --use_specified_plugin iscsi
  • Always include --ignore_force_shutdown unless explicitly told not to.
  • Default config family: gold

Required Operating Rules

  • Never run setup without operator-provided --expected-ip and --expected-hostname.
  • Keep static IP configuration as the final setup step.
  • Before any automation run, always check whether automation is already running.
  • Always show exact planned ATVM commands before execution.
  • Never execute setup or automation commands that require approval until the operator explicitly approves them.
  • Treat docs/automation/examples.md as reference-only, not default operator intent.
  • Put reusable workflow rules in guide.md files.
  • Put dated lessons only in run-learnings.md files.
  • Keep durable environment reference in inventory/.
  • Preserve imported long-form notes in archive/imported-notes/; do not treat them as the primary runbook.

Maintenance Rules

  • When changing workflow behavior, update the corresponding guide.md.
  • When adding a reusable command pattern, update docs/automation/examples.md.
  • When a run produces a new lesson, update the appropriate run-learnings.md.
  • Keep filesystem paths in docs aligned with the actual repo layout.
  • Do not remove detailed inventory or credential information from this workspace unless explicitly instructed.