generating-ovn-topology

Quick Start - OVN Topology Generation

IMMEDIATE ACTIONS (follow these steps in order):

1. Detect Cluster: Find the OVN-Kubernetes cluster kubeconfig

   Run: scripts/detect-cluster.sh 2>/dev/null

   The script discovers OVN-Kubernetes clusters:

   • Scans all kubeconfig files: current KUBECONFIG env, ~/.kube/kind-config, ~/ovn.conf, ~/.kube/config
   • Tests ALL contexts in each kubeconfig (not just current-context)
   • Returns parseable list to stdout: index|kubeconfig|cluster_name|node_count|namespace
   • Diagnostics go to stderr
   • Exit code: 0=success, 1=no clusters found

   How to handle the output:

   The script returns pipe-delimited lines to stdout, one per cluster found, e.g.:

   1|/home/user/.kube/kind-config|kind-ovn|3|ovn-kubernetes
   2|/home/user/.kube/config|prod-cluster|12|openshift-ovn-kubernetes
   

   Decision logic:

   • If one cluster found → automatically use it (extract kubeconfig path from column 2)
   • If multiple clusters found → show the list to user and ask them to choose by number
   • After selection, extract the kubeconfig path from column 2 of the chosen line
   • Store the selected kubeconfig path in variable KC for use in subsequent steps

   Example output format parsing:

   • Column 1: Index number (for user selection)
   • Column 2: Kubeconfig file path (this is what you need for $KC)
   • Column 3: Cluster display name
   • Column 4: Number of nodes
   • Column 5: OVN namespace name

   Important: Parse the output using standard text processing. The exact implementation is up to you - use whatever approach works best (awk, Python, inline parsing, etc.).

2. Check Permissions: Verify user's Kubernetes access level and inform about write permissions

   Run: scripts/check_permissions.py "$KC"

   The script returns:

   • Exit 0: Read-only access or user confirmed → proceed
   • Exit 1: Error or user cancelled → stop
   • Exit 2: Write permissions detected → AI must ask user for confirmation

   When exit code 2 is returned:

   1. Parse the stdout to get the list of write permissions
   2. Display the permissions clearly to the user using a formatted message
   3. Explain that:
      • This skill performs ONLY read-only operations
      • No cluster modifications will be made
      • The warning is for transparency about their access level
      • List read-only operations: kubectl get, kubectl exec (ovn-nbctl list), local file writes
      • List forbidden operations: kubectl create/delete/patch, ovn-nbctl modifications
   4. Ask the user explicitly: "You have cluster admin permissions. This command will only perform read-only operations. Do you want to proceed?"
   5. If user says yes → continue, if no → stop

   Example of proper user communication:

   ⚠️  WARNING: Write Permissions Detected
   
   Your kubeconfig has cluster admin permissions:
     • Delete pods, deployments, services
     • Create and modify resources
     • Full cluster access
   
   📋 IMPORTANT:
   This command will ONLY perform read-only operations:
     ✅ kubectl get (pods, nodes)
     ✅ kubectl exec (to run read-only ovn-nbctl list commands)
     ✅ Local file writes (topology diagram)
   
   Operations that will NEVER be performed:
     ❌ kubectl create/delete/patch/apply
     ❌ ovn-nbctl modifications
     ❌ Any cluster state changes
   
   Do you want to proceed with read-only topology generation?
   

   Security Note: This step ensures informed consent. The user must be explicitly aware that their cluster admin credentials are accessible to the AI agent (acting on their behalf), even though only read-only operations will be performed. This transparency is critical for security and trust.

3. Check Output File: Ask user if ovn-topology-diagram.md exists:

   • (1) Overwrite, (2) Custom path, (3) Timestamp, (4) Cancel

4. Create Private Temp Directory: Create a private temporary directory using mkdtemp and use it for all temporary files.