llm-automation-docs-and-remediation-engine/templates/documentation/proxmox.yaml

# Proxmox Documentation Template
# Defines documentation sections to generate from Proxmox data
# Each section is generated independently to avoid LLM context overload

metadata:
  name: "Proxmox Virtual Environment"
  collector: "proxmox"
  version: "1.0.0"
  description: "Documentation template for Proxmox VE infrastructure"

# Documentation sections - each generates a separate markdown file
sections:
  - id: "proxmox_overview"
    title: "Proxmox Infrastructure Overview"
    category: "infrastructure"
    priority: 1
    description: "High-level overview of Proxmox cluster and resources"
    data_requirements:
      - "cluster"
      - "statistics"
      - "nodes"
    prompt_template: |
      Generate comprehensive documentation for our Proxmox Virtual Environment cluster.

      **Cluster Information:**
      {cluster}

      **Infrastructure Statistics:**
      {statistics}

      **Nodes:**
      {nodes}

      Create a well-structured markdown document that includes:
      1. Cluster overview with key statistics
      2. Node inventory and status
      3. Resource allocation summary (CPU, RAM, Storage)
      4. High availability status
      5. Capacity planning insights

      Use tables, bullet points, and clear sections. Include actual values from the data.

  - id: "vm"
    title: "VM: {vm_name}"
    category: "vms"
    priority: 2
    description: "Individual VM documentation"
    loop_over: "vms"
    loop_item_name: "vm"
    data_requirements:
      - "nodes"
    prompt_template: |
      Generate detailed technical documentation for this virtual machine.

      **VM Details:**
      {vm}

      **Available Nodes:**
      {nodes}

      Create comprehensive documentation that includes:

      ## VM Configuration
      - VMID and Name
      - Current Status (running/stopped)
      - Host Node location

      ## Resource Allocation
      - vCPU cores allocated
      - RAM allocated (in GB)
      - Disk space and storage location
      - Network interfaces

      ## Current State
      - Uptime (if running)
      - Resource usage (CPU%, RAM%)
      - IP addresses (if available)

      ## Management
      - Configuration highlights
      - Backup status and schedule (if available)
      - Snapshot information (if available)
      - High availability configuration (if applicable)

      ## Recommendations
      - Resource optimization suggestions
      - Security considerations
      - Best practices for this VM

      **IMPORTANT**: Document ALL details available in the VM data. Do not skip any information.
      Use markdown tables, bullet points, and clear sections.

  - id: "container"
    title: "Container: {container_name}"
    category: "containers"
    priority: 3
    description: "Individual LXC container documentation"
    loop_over: "containers"
    loop_item_name: "container"
    data_requirements:
      - "nodes"
    prompt_template: |
      Generate detailed technical documentation for this LXC container.

      **Container Details:**
      {container}

      **Available Nodes:**
      {nodes}

      Create comprehensive documentation that includes:

      ## Container Configuration
      - VMID and Name
      - Container Type (LXC)
      - Current Status (running/stopped)
      - Host Node location

      ## Resource Allocation
      - vCPU cores allocated
      - RAM allocated (in GB)
      - Disk space and storage location
      - Network interfaces

      ## Current State
      - Uptime (if running)
      - Resource usage (CPU%, RAM%)
      - IP addresses (if available)
      - Template used (if available)

      ## Management
      - Configuration highlights
      - Backup status and schedule (if available)
      - Snapshot information (if available)
      - Privileges and security settings

      ## Recommendations
      - Resource optimization suggestions
      - Security hardening
      - Best practices for this container

      **IMPORTANT**: Document ALL details available in the container data. Do not skip any information.
      Use markdown tables, bullet points, and clear sections.

  - id: "proxmox_storage"
    title: "Storage Configuration"
    category: "storage"
    priority: 4
    description: "Storage pools and allocation"
    data_requirements:
      - "storage"
      - "statistics"
    prompt_template: |
      Generate comprehensive storage documentation for the Proxmox cluster.

      **Storage Pools:**
      {storage}

      **Overall Statistics:**
      {statistics}

      Create documentation that includes:
      1. Storage inventory table (Name, Type, Total, Used, Available, Usage %)
      2. Storage types explained (local, NFS, Ceph, etc.)
      3. Content types per storage (images, ISO, containers)
      4. Storage capacity analysis
      5. Performance considerations
      6. Backup storage recommendations
      7. Capacity planning and alerts

      Use markdown tables, charts (if possible), and clear sections.

  - id: "proxmox_networking"
    title: "Network Configuration"
    category: "network"
    priority: 5
    description: "Network bridges and configuration"
    data_requirements:
      - "networks"
      - "nodes"
    prompt_template: |
      Generate network configuration documentation for the Proxmox cluster.

      **Network Interfaces:**
      {networks}

      **Nodes:**
      {nodes}

      Create documentation that includes:
      1. Network bridges inventory (Bridge, Type, CIDR, Ports, Purpose)
      2. Network topology diagram (text-based or description)
      3. VLAN configuration if present
      4. Network purposes (management, VM, storage, etc.)
      5. Best practices for network separation
      6. Troubleshooting guides for common network issues

      Use markdown tables and clear explanations.

  - id: "proxmox_maintenance"
    title: "Maintenance Procedures"
    category: "operations"
    priority: 6
    description: "Standard maintenance and operational procedures"
    data_requirements:
      - "nodes"
      - "cluster"
      - "vms"
      - "containers"
    prompt_template: |
      Generate operational and maintenance documentation for the Proxmox cluster.

      **Cluster Info:**
      {cluster}

      **Nodes:**
      {nodes}

      Based on the cluster configuration, create documentation that includes:
      1. **Backup Procedures**
         - VM/Container backup strategies
         - Configuration backup
         - Retention policies

      2. **Update Procedures**
         - Proxmox VE updates
         - Kernel updates
         - Rolling updates for HA clusters

      3. **Monitoring**
         - Key metrics to monitor
         - Alert thresholds
         - Dashboard recommendations

      4. **Common Tasks**
         - Creating VMs/Containers
         - Migration procedures
         - Storage management
         - Snapshot management

      5. **Troubleshooting**
         - Common issues and solutions
         - Log locations
         - Recovery procedures

      6. **Emergency Contacts**
         - Escalation procedures
         - Vendor support information

      Make it practical and actionable for operations team.

# Generation settings
generation:
  max_tokens: 2000  # Reduced for small models
  temperature: 0.5  # Lower for more focused responses
  language: "en"  # Default language, can be overridden

# Output configuration
output:
  directory: "output/proxmox"
  filename_pattern: "{section_id}.md"
  save_to_database: true
  save_to_file: true

# Scheduling (for Celery tasks)
schedule:
  enabled: true
  cron: "0 2 * * *"  # Daily at 2 AM
  timezone: "UTC"