anthony.wen/cds-ai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
86b1a0e4a98e16fa11bb73e8861d92cf486e3c0c
cds-ai/atvm/AGENTS.md
anthony.wen 86b1a0e4a9 Scrub tracked secrets and switch ATVM docs to local credential references 
- remove hardcoded credentials, tokens, registration codes, and similar secret values from tracked ATVM and CDS MCP docs
- replace those values with references to /home/aw/code/cds/.env.credentials.local and the corresponding environment variable names
- update current operator guides to instruct sourcing .env.credentials.local before credential-dependent setup and automation workflows
- update the ATVM setup scripts to consume ATVM_TARGET_PASSWORD from the environment instead of hardcoding the Ubuntu root SSH password
- scrub the remaining tracked artifact log entry that still included the old CMC registration code
- keep the local-only credential inventory in .env.credentials.local while leaving that file untracked
2026-03-24 17:32:44 -04:00

3.9 KiB
Raw Blame History

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 source: /home/aw/code/cds/.env.credentials.local via ATVM_TARGET_USER and ATVM_TARGET_PASSWORD
  • 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, source /home/aw/code/cds/.env.credentials.local and use ATVM_TARGET_USER plus ATVM_TARGET_PASSWORD unless explicitly overridden.

Automation Track Defaults

  • Controller host: atvm-cypres-vm-1
  • Controller IP: 192.168.3.190
  • Controller credential source: /home/aw/code/cds/.env.credentials.local via ATVM_CONTROLLER_USER and ATVM_CONTROLLER_PASSWORD
  • Detailed test artifact root on controller: /root/cdc-e2e-cyp-12.17.4/cypress/cmcReporter
  • Default Mattermost status destination config: /home/aw/code/cds/.env.credentials.local
  • 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.
  • For host-level test detail and failed-test investigation, use /root/cdc-e2e-cyp-12.17.4/cypress/cmcReporter, especially logs/, xml/, and mochawesome/.
  • 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.
  • 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.
Reference in New Issue View Git Blame Copy Permalink