docs(cds): consolidate cirrus data cloud reference docs
This commit is contained in:
@@ -46,6 +46,12 @@ This document provides workspace-level instructions for AI agents working anywhe
|
||||
- If only one of `-c` or `-e` is provided, auto-fill the paired value from this mapping.
|
||||
- If both `-c` and `-e` are provided but conflict with mapping, stop and ask for confirmation before execution.
|
||||
|
||||
## Cirrus Data Cloud Reference
|
||||
|
||||
- Use `docs/cirrus-data-cloud/README.md` as the navigation entry point for the shared VMware/vCenter/MigrateOps reference set.
|
||||
- Use the guides under `docs/cirrus-data-cloud/` when you need the reusable Cirrus Data Cloud workflow material.
|
||||
- Treat `docs/cirrus-data-cloud/run-learnings.md` as history and evidence, not baseline procedure.
|
||||
|
||||
### ATVM Cypress Git Drafting
|
||||
|
||||
When the user explicitly asks to "create a git" or otherwise requests git/commit help for the ATVM Cypress machine/vm:
|
||||
|
||||
@@ -1,62 +0,0 @@
|
||||
# AGENTS.md
|
||||
|
||||
This folder contains the VMware/vCenter + MigrateOps runbook for CDS MCP workflows.
|
||||
|
||||
## Workspace Layout
|
||||
- `README.md`
|
||||
- top-level navigation
|
||||
- `docs/vmware-migrateops-guide.md`
|
||||
- authoritative VMware compute migration workflow
|
||||
- `docs/esxvm-guide.md`
|
||||
- direct vCenter VM hardware review/change workflow
|
||||
- `docs/vm-lookup-and-assignment.md`
|
||||
- VM lookup, datastore reporting, and FC/disk assignment workflow
|
||||
- `docs/cmc-install-reference.md`
|
||||
- CMC install, uninstall, and reinstall fallback reference
|
||||
- `docs/iscsi-cleanup-reference.md`
|
||||
- guest-level iSCSI target cleanup reference
|
||||
- `docs/run-learnings.md`
|
||||
- run-specific learnings only when a run adds new information
|
||||
- `templates/vmw.yaml`
|
||||
- base template for `MIGRATEOPS_VMWARE_COMPUTE` operations
|
||||
- `artifacts/logs/`
|
||||
- runtime log artifacts kept separate from operator guidance
|
||||
|
||||
## Source Of Truth
|
||||
- Use `docs/vmware-migrateops-guide.md` for how to execute VMware compute migration runs.
|
||||
- Use `docs/esxvm-guide.md` for direct vCenter VM hardware changes such as new disks, existing-disk attach, and PCI passthrough assignment.
|
||||
- Use `docs/vm-lookup-and-assignment.md` for VM lookup responses and FC/disk assignment requests.
|
||||
- Use `docs/cmc-install-reference.md` for CMC install/uninstall commands and fallback reinstall notes.
|
||||
- Use `docs/iscsi-cleanup-reference.md` for guest-level iSCSI target logout and node-record cleanup.
|
||||
- Use `templates/vmw.yaml` as the starting operation template.
|
||||
- Treat `docs/run-learnings.md` as evidence/history, not baseline procedure.
|
||||
|
||||
## Required Run Pattern
|
||||
1. Confirm source VM in vCenter and power state before IP/SSH actions.
|
||||
2. Prepare source host (CDC cleanup + CMC reinstall/registration) and verify source is connected in CDC.
|
||||
This applies to Windows sources too; do not skip project cleanup just because SSH + PowerShell works.
|
||||
3. Validate preflight requirements from `docs/vmware-migrateops-guide.md`.
|
||||
4. Create MigrateOps from `templates/vmw.yaml` with request-specific replacements.
|
||||
5. Monitor continuously and auto-approve cutover unless the user requests manual approval.
|
||||
6. After terminal state:
|
||||
- validate destination login,
|
||||
- archive operation,
|
||||
- run offline-host cleanup loop until source/helper cleanup conditions are satisfied,
|
||||
- provide final read-only status listing for source/destination/access/helper across CDC and vCenter.
|
||||
7. Ask the user explicitly before deleting the destination VM; never delete without same-run confirmation.
|
||||
|
||||
## Environment Defaults
|
||||
- vCenter: `192.168.0.201`
|
||||
- Cluster scope: `QACL-ATVMCypressONLY` unless user overrides
|
||||
- Default CDC project: `Skidamarink`
|
||||
- Default access node: `atvm-linux-h2h`
|
||||
- Default ATVM target reference: `192.168.3.191`
|
||||
- For Windows ATVM guest execution, prefer SSH + PowerShell with `ATVM_WINDOWS_TARGET_USER` and `ATVM_WINDOWS_TARGET_PASSWORD`.
|
||||
|
||||
## Update Rules
|
||||
- Update `docs/vmware-migrateops-guide.md` only when migration workflow/default behavior changes.
|
||||
- Update `docs/esxvm-guide.md` only when direct vCenter hardware workflow/default behavior changes.
|
||||
- Update `docs/vm-lookup-and-assignment.md` only when lookup/assignment workflow behavior changes.
|
||||
- Update `docs/cmc-install-reference.md` only when install or reinstall reference behavior changes.
|
||||
- Update `docs/iscsi-cleanup-reference.md` only when the default iSCSI target cleanup workflow changes.
|
||||
- Update `docs/run-learnings.md` only when a run reveals a new learning/failure pattern/required check.
|
||||
@@ -1,33 +1,31 @@
|
||||
# CDS MCP Workspace
|
||||
# Cirrus Data Cloud Reference
|
||||
|
||||
This folder contains the VMware/vCenter and MigrateOps runbook material used for CDS MCP workflows.
|
||||
This folder contains reusable VMware/vCenter and MigrateOps reference material.
|
||||
|
||||
## Start Here
|
||||
- VMware compute migration workflow:
|
||||
- `docs/vmware-migrateops-guide.md`
|
||||
- `vmware-migrateops-guide.md`
|
||||
- Direct vCenter VM hardware review/change workflow:
|
||||
- `docs/esxvm-guide.md`
|
||||
- `esxvm-guide.md`
|
||||
- VM lookup and FC/disk assignment workflow:
|
||||
- `docs/vm-lookup-and-assignment.md`
|
||||
- `vm-lookup-and-assignment.md`
|
||||
- CMC install and uninstall reference:
|
||||
- `docs/cmc-install-reference.md`
|
||||
- `cmc-install-reference.md`
|
||||
- includes the Windows SSH + PowerShell install/reinstall path
|
||||
- iSCSI target cleanup reference:
|
||||
- `docs/iscsi-cleanup-reference.md`
|
||||
- `iscsi-cleanup-reference.md`
|
||||
- Run-specific learnings:
|
||||
- `docs/run-learnings.md`
|
||||
- `run-learnings.md`
|
||||
- Base operation template:
|
||||
- `templates/vmw.yaml`
|
||||
|
||||
## Layout
|
||||
- `docs/`
|
||||
- operator guidance and learnings
|
||||
- `templates/`
|
||||
- reusable operation template inputs
|
||||
- reusable operation template inputs and starter skeletons
|
||||
- `artifacts/logs/`
|
||||
- runtime log artifacts
|
||||
|
||||
## Update Policy
|
||||
- Update workflow docs when rules, defaults, or checklists change.
|
||||
- Update `docs/run-learnings.md` only when a run adds a new lasting lesson.
|
||||
- Update `run-learnings.md` only when a run adds a new lasting lesson.
|
||||
- Keep `templates/vmw.yaml` as the starting template for VMware compute MigrateOps operations.
|
||||
@@ -1,6 +1,6 @@
|
||||
# CMC Install Reference
|
||||
# Cirrus Data Cloud CMC Install Reference
|
||||
|
||||
This file contains the CMC install, uninstall, and reinstall fallback reference used by the CDS MCP VMware workflow.
|
||||
This file contains the CMC install, uninstall, and reinstall fallback reference used by the shared VMware workflow.
|
||||
|
||||
## Default Project Rule
|
||||
- Default project: `Skidamarink`
|
||||
@@ -1,4 +1,4 @@
|
||||
# ESX VM Guide
|
||||
# Cirrus Data Cloud ESX VM Guide
|
||||
|
||||
This file covers read-only review and approval rules for direct vCenter VM hardware changes.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# iSCSI Cleanup Reference
|
||||
# Cirrus Data Cloud iSCSI Cleanup Reference
|
||||
|
||||
This file contains the standard iSCSI target cleanup sequence for Linux guests used in CDS MCP workflows.
|
||||
This file contains the standard iSCSI target cleanup sequence for Linux guests.
|
||||
|
||||
## Scope
|
||||
- Use this reference when the user asks to clean up saved iSCSI targets on a machine.
|
||||
@@ -1,4 +1,4 @@
|
||||
# ESX / vCenter Run Learnings
|
||||
# Cirrus Data Cloud Run Learnings
|
||||
|
||||
This file stores run-specific examples only when a run produced a new learning relevant to future tasks.
|
||||
|
||||
12
docs/cirrus-data-cloud/templates/vmw.yaml
Normal file
12
docs/cirrus-data-cloud/templates/vmw.yaml
Normal file
@@ -0,0 +1,12 @@
|
||||
# Starter template for MIGRATEOPS_VMWARE_COMPUTE
|
||||
#
|
||||
# This is a shared starting point for VMware compute runs. Fill in the
|
||||
# source-specific and integration-specific values before use.
|
||||
|
||||
system_name: ""
|
||||
integration_name: ""
|
||||
|
||||
migrateops_vmware_compute:
|
||||
compute:
|
||||
vm_name: ""
|
||||
source_nic: ""
|
||||
@@ -1,4 +1,4 @@
|
||||
# VM Lookup And Assignment
|
||||
# Cirrus Data Cloud VM Lookup And Assignment
|
||||
|
||||
This file covers vCenter VM lookup responses and the workflow for assigning existing disks and PCI passthrough FC adapters to a VM.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# VMware Compute MigrateOps Guide
|
||||
# Cirrus Data Cloud VMware Compute MigrateOps Guide
|
||||
|
||||
This file is for workflow guidance only. Do not add specific run examples here.
|
||||
|
||||
@@ -33,7 +33,7 @@ This file is for workflow guidance only. Do not add specific run examples here.
|
||||
- `cmc-install-reference.md`
|
||||
|
||||
## VMware Compute MigrateOps Defaults
|
||||
- Use `/home/aw/code/cds/cdsmcp/templates/vmw.yaml` as the starting template.
|
||||
- Use `templates/vmw.yaml` as the starting template.
|
||||
- Default sequence for requested source machine:
|
||||
- clean CDC state for that machine
|
||||
- reinstall CMC on that machine
|
||||
Reference in New Issue
Block a user